WPF

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class CollectionBaseEx<T>

    Show / Hide Table of Contents

    Class CollectionBaseEx<T>

    This is the base class for all collections.

    Inheritance
    System.Object
    CollectionBase<T>
    CollectionBaseEx<T>
    FormatSectionCollection
    ChartCategoryCollection
    ChartFormatCollection
    ChartSeriesCollection
    ChartTrendLineCollection
    AddInFunctionsCollection
    AutoFiltersCollection
    BordersCollection
    BordersCollectionArrayWrapper
    BuiltInDocumentProperties
    ChartsCollection
    CheckBoxCollection
    ComboBoxCollection
    CommentsCollection
    ConditionalFormats
    CustomDocumentProperties
    CustomXmlPartCollection
    DataValidationCollection
    DataValidationTable
    ErrorIndicatorsCollection
    ExtendedFormatsCollection
    ExternBookCollection
    ExternNamesCollection
    FontsCollection
    BordersGroup
    WorksheetGroup
    HPageBreaksCollection
    HyperLinksCollection
    MetaPropertiesImpl
    OptionButtonCollection
    PicturesCollection
    RangesCollection
    ShapeCollectionBase
    StylesCollection
    TextBoxCollection
    VPageBreaksCollection
    WorkbookNamesCollection
    WorkbooksCollection
    WorksheetChartsCollection
    WorksheetConditionalFormats
    WorksheetNamesCollection
    WorksheetsCollection
    ExternalConnectionCollection
    PivotDataFields
    PivotTableCollection
    PivotTableFields
    Implements
    System.Collections.Generic.IList<T>
    System.Collections.Generic.ICollection<T>
    System.Collections.Generic.IEnumerable<T>
    System.Collections.IEnumerable
    IParentApplication
    ICloneParent
    Inherited Members
    CollectionBase<T>.Clear()
    CollectionBase<T>.Insert(Int32, T)
    CollectionBase<T>.GetEnumerator()
    CollectionBase<T>.RemoveAt(Int32)
    CollectionBase<T>.IndexOf(T)
    CollectionBase<T>.Add(T)
    CollectionBase<T>.Contains(T)
    CollectionBase<T>.CopyTo(T[], Int32)
    CollectionBase<T>.Remove(T)
    CollectionBase<T>.IEnumerable.GetEnumerator()
    CollectionBase<T>.Capacity
    CollectionBase<T>.Count
    CollectionBase<T>.InnerList
    CollectionBase<T>.List
    CollectionBase<T>.Item[Int32]
    CollectionBase<T>.IsReadOnly
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Syncfusion.XlsIO.Implementation.Collections
    Assembly: Syncfusion.XlsIO.Base.dll
    Syntax
    public class CollectionBaseEx<T> : CollectionBase<T>, IList<T>, ICollection<T>, IEnumerable<T>, IEnumerable, IParentApplication, ICloneParent
    Type Parameters
    Name Description
    T

    Constructors

    CollectionBaseEx(IApplication, Object)

    Creates collection and sets its Application and Parent values.

    Declaration
    public CollectionBaseEx(IApplication application, object parent)
    Parameters
    Type Name Description
    IApplication application

    Application object that represents the Excel application.

    System.Object parent

    Parent object of this collection.

    Properties

    AppImplementation

    Application object. Read-only.

    Declaration
    protected ApplicationImpl AppImplementation { get; }
    Property Value
    Type Description
    ApplicationImpl

    Application

    Read-only. An Application object that represents the Excel application.

    Declaration
    public IApplication Application { get; }
    Property Value
    Type Description
    IApplication

    Parent

    Read-only. The parent object for the specified object.

    Declaration
    public object Parent { get; }
    Property Value
    Type Description
    System.Object

    QuietMode

    Gets / sets whether class can raise events.

    Declaration
    public bool QuietMode { get; set; }
    Property Value
    Type Description
    System.Boolean

    Methods

    ChangeName(IDictionary, ValueChangedEventArgs)

    Changes name.

    Declaration
    public static void ChangeName(IDictionary hashNames, ValueChangedEventArgs e)
    Parameters
    Type Name Description
    System.Collections.IDictionary hashNames

    Hash table with names

    Syncfusion.XlsIO.Implementation.ValueChangedEventArgs e

    ClearMaxValues()

    Clear max values from dictionary.

    Declaration
    protected void ClearMaxValues()

    Clone(Object)

    Creates copy of the collection.

    Declaration
    public virtual object Clone(object parent)
    Parameters
    Type Name Description
    System.Object parent

    Parent object for the new collection.

    Returns
    Type Description
    System.Object

    A copy of the collection.

    EnsureCapacity(Int32)

    Enlarges internal storage if necessary.

    Declaration
    public void EnsureCapacity(int size)
    Parameters
    Type Name Description
    System.Int32 size

    Required size.

    FindParent(Type)

    Method used to find parent within a specific type.

    Declaration
    public object FindParent(Type parentType)
    Parameters
    Type Name Description
    System.Type parentType

    Parent type to search.

    Returns
    Type Description
    System.Object

    Found parent if was parent was found or NULL otherwise.

    Exceptions
    Type Condition
    System.ArgumentException

    When there is cycle in object tree.

    FindParent(Type, Boolean)

    Method used to find parent within a specific type.

    Declaration
    public object FindParent(Type parentType, bool bCheckSubclasses)
    Parameters
    Type Name Description
    System.Type parentType

    Parent type to search.

    System.Boolean bCheckSubclasses

    Indicates whether to look into subclasses.

    Returns
    Type Description
    System.Object

    Found parent if was parent was found or NULL otherwise.

    Exceptions
    Type Condition
    System.ArgumentException

    When there is cycle in object tree.

    GenerateDefaultName(ICollection<T>, String)

    Generates default name.

    Declaration
    public static string GenerateDefaultName(ICollection<T> namesCollection, string strStart)
    Parameters
    Type Name Description
    System.Collections.Generic.ICollection<T> namesCollection

    Names collection.

    System.String strStart

    Start string.

    Returns
    Type Description
    System.String

    Returns string with new name.

    GenerateDefaultName(ICollection, String)

    Generates default name.

    Declaration
    public static string GenerateDefaultName(ICollection namesCollection, string strStart)
    Parameters
    Type Name Description
    System.Collections.ICollection namesCollection

    Names collection.

    System.String strStart

    Start string.

    Returns
    Type Description
    System.String

    Returns string with new name.

    GenerateDefaultName(String, ICollection[])

    Generate default name.

    Declaration
    public static string GenerateDefaultName(string strStart, params ICollection[] arrCollections)
    Parameters
    Type Name Description
    System.String strStart

    Start string.

    System.Collections.ICollection[] arrCollections

    Collection with names.

    Returns
    Type Description
    System.String

    Returns new name.

    OnClear()

    OnClear is invoked before Clear behavior.

    Declaration
    protected override void OnClear()
    Overrides
    Syncfusion.XlsIO.Implementation.Collections.CollectionBase<T>.OnClear()

    OnClearComplete()

    OnClear is invoked after Clear behavior.

    Declaration
    protected override void OnClearComplete()
    Overrides
    Syncfusion.XlsIO.Implementation.Collections.CollectionBase<T>.OnClearComplete()

    OnInsert(Int32, T)

    Performs additional processes before inserting a new element into the collection.

    Declaration
    protected override void OnInsert(int index, T value)
    Parameters
    Type Name Description
    System.Int32 index

    The zero-based index at which to insert value.

    T value

    The new value of the element at index.

    Overrides
    Syncfusion.XlsIO.Implementation.Collections.CollectionBase<T>.OnInsert(System.Int32, T)

    OnInsertComplete(Int32, T)

    Performs additional processes after inserting a new element into the collection.

    Declaration
    protected override void OnInsertComplete(int index, T value)
    Parameters
    Type Name Description
    System.Int32 index

    The zero-based index at which to insert value.

    T value

    The new value of the element at index.

    Overrides
    Syncfusion.XlsIO.Implementation.Collections.CollectionBase<T>.OnInsertComplete(System.Int32, T)

    OnRemove(Int32, T)

    Performs additional processes before removing an element from the collection.

    Declaration
    protected override void OnRemove(int index, T value)
    Parameters
    Type Name Description
    System.Int32 index

    The zero-based index at which the value can be found.

    T value

    The value of the element to remove from index.

    Overrides
    Syncfusion.XlsIO.Implementation.Collections.CollectionBase<T>.OnRemove(System.Int32, T)

    OnRemoveComplete(Int32, T)

    Performs additional processes after removing an element from the collection.

    Declaration
    protected override void OnRemoveComplete(int index, T value)
    Parameters
    Type Name Description
    System.Int32 index

    The zero-based index at which the value can be found.

    T value

    The value of the element to remove from index.

    Overrides
    Syncfusion.XlsIO.Implementation.Collections.CollectionBase<T>.OnRemoveComplete(System.Int32, T)

    OnSet(Int32, T, T)

    Performs additional processes before setting a value in the collection.

    Declaration
    protected override void OnSet(int index, T oldValue, T newValue)
    Parameters
    Type Name Description
    System.Int32 index

    The zero-based index at which oldValue can be found.

    T oldValue

    The value to replace with newValue.

    T newValue

    The new value of the element at index.

    Overrides
    Syncfusion.XlsIO.Implementation.Collections.CollectionBase<T>.OnSet(System.Int32, T, T)

    OnSetComplete(Int32, T, T)

    Performs additional processes after setting a value in the collection.

    Declaration
    protected override void OnSetComplete(int index, T oldValue, T newValue)
    Parameters
    Type Name Description
    System.Int32 index

    The zero-based index at which oldValue can be found.

    T oldValue

    The value to replace with newValue.

    T newValue

    The new value of the element at the index.

    Overrides
    Syncfusion.XlsIO.Implementation.Collections.CollectionBase<T>.OnSetComplete(System.Int32, T, T)

    SetParent(Object)

    Sets parent object for class.

    Declaration
    public void SetParent(object parent)
    Parameters
    Type Name Description
    System.Object parent

    Parent object for sets.

    Events

    Changed

    Change in the collection.

    Declaration
    public event EventHandler Changed
    Event Type
    Type Description
    System.EventHandler

    Cleared

    Raised by class after collection clean process.

    Declaration
    public event CollectionBaseEx<T>.CollectionClear Cleared
    Event Type
    Type Description
    CollectionBaseEx.CollectionClear<>

    Clearing

    Raised by class before real cleaning of collection.

    Declaration
    public event CollectionBaseEx<T>.CollectionClear Clearing
    Event Type
    Type Description
    CollectionBaseEx.CollectionClear<>

    Inserted

    Raised by class after item is added to the collection.

    Declaration
    public event CollectionBaseEx<T>.CollectionChange Inserted
    Event Type
    Type Description
    CollectionBaseEx.CollectionChange<>

    Inserting

    Raised by class before item will be added into the collection.

    Declaration
    public event CollectionBaseEx<T>.CollectionChange Inserting
    Event Type
    Type Description
    CollectionBaseEx.CollectionChange<>

    Removed

    Raised by class after item is removed from the collection storage

    Declaration
    public event CollectionBaseEx<T>.CollectionChange Removed
    Event Type
    Type Description
    CollectionBaseEx.CollectionChange<>

    Removing

    Raised by class before real item is removed from the collection.

    Declaration
    public event CollectionBaseEx<T>.CollectionChange Removing
    Event Type
    Type Description
    CollectionBaseEx.CollectionChange<>

    Set

    Raised by class after item is replaced in the collection.

    Declaration
    public event CollectionBaseEx<T>.CollectionSet Set
    Event Type
    Type Description
    CollectionBaseEx.CollectionSet<>

    Setting

    Raised by class before item is replaced in the collection.

    Declaration
    public event CollectionBaseEx<T>.CollectionSet Setting
    Event Type
    Type Description
    CollectionBaseEx.CollectionSet<>

    Implements

    System.Collections.Generic.IList<T>
    System.Collections.Generic.ICollection<T>
    System.Collections.Generic.IEnumerable<T>
    System.Collections.IEnumerable
    IParentApplication
    ICloneParent

    Extension Methods

    PivotExtension.GroupByMany<TElement>(IEnumerable<TElement>, Int32, Func<TElement, Object>[])
    PivotExtension.GroupByMany<TElement>(IEnumerable<TElement>, IEnumerable<Func<TElement, Object>>)
    FunctionalExtensions.ForEach<T>(IEnumerable, Action<T>)
    FunctionalExtensions.ForEach<T>(IEnumerable<T>, Action<T>)
    FunctionalExtensions.ToList<T>(IEnumerable)
    ChartExtensionUtils.DistinctBy<TSource, TKey>(IEnumerable<TSource>, Func<TSource, TKey>)
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved