menu

WinForms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridColumnDescriptorCollection - WindowsForms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class GridColumnDescriptorCollection

    Represents a collection of GridColumnDescriptor columns with mapping information to columns of the underlying datasource. An instance of this collection is returned by the Columns property of a GridTableDescriptor.

    Inheritance
    System.Object
    GridColumnDescriptorCollection
    Implements
    System.IDisposable
    System.Collections.IList
    System.Collections.ICollection
    System.Collections.IEnumerable
    IInsideCollectionEditorProperty
    System.ICloneable
    System.ComponentModel.ICustomTypeDescriptor
    Inherited Members
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    Namespace: Syncfusion.Windows.Forms.Grid.Grouping
    Assembly: Syncfusion.Grid.Grouping.Windows.dll
    Syntax
    public class GridColumnDescriptorCollection : IDisposable, IList, ICollection, IEnumerable, IInsideCollectionEditorProperty, ICloneable, ICustomTypeDescriptor

    Constructors

    GridColumnDescriptorCollection()

    Initializes a new instance of the GridColumnDescriptorCollection class.

    Declaration
    public GridColumnDescriptorCollection()

    Fields

    Empty

    A Read-only and empty collection.

    Declaration
    public static readonly GridColumnDescriptorCollection Empty
    Field Value
    Type
    GridColumnDescriptorCollection

    Properties

    Count

    Gets the number of elements contained in the collection. The property also ensures that the collection is in sync with the underlying table if changes have been made to the table or the TableDescriptor.

    Declaration
    public int Count { get; }
    Property Value
    Type
    System.Int32
    Remarks

    The method calls EnsureInitialized(Boolean).

    InsideCollectionEditor

    Gets or sets a value indicating whether the collection is manipulated inside a collection editor or not.

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

    IsFixedSize

    Gets a value indicating whether the collection has fixed size or not.

    Declaration
    public bool IsFixedSize { get; }
    Property Value
    Type
    System.Boolean

    IsModified

    Gets or sets a value indicating whether the collection is modified from its default state or not.

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

    IsReadOnly

    Gets a value indicating whether the collection is Read-only or not.

    Declaration
    public bool IsReadOnly { get; }
    Property Value
    Type
    System.Boolean

    IsSynchronized

    Gets a value indicating whether the collection can be synchronized or not. Returns False.

    Declaration
    public bool IsSynchronized { get; }
    Property Value
    Type
    System.Boolean

    Item[Int32]

    Gets or sets the element at the zero-based index.

    Declaration
    public GridColumnDescriptor this[int index] { get; set; }
    Parameters
    Type Name Description
    System.Int32 index
    Property Value
    Type
    GridColumnDescriptor

    Item[String]

    Gets or sets the element with the specified name.

    Declaration
    public GridColumnDescriptor this[string name] { get; set; }
    Parameters
    Type Name Description
    System.String name
    Property Value
    Type
    GridColumnDescriptor

    ShouldPopulate

    Gets or sets a value indicating whether the collection should check for changes in engine schema or underlying data source schema when EnsureInitialized gets called.

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

    Version

    Gets the version number of this collection. The version is increased each time the collection or an element within the collection is modified. When getting the version, EnsureInitialized(Boolean) is called to ensure the collection is auto-populated if needed.

    Declaration
    public int Version { get; }
    Property Value
    Type
    System.Int32

    Methods

    Add(GridColumnDescriptor)

    Adds an object to the end of the collection.

    Declaration
    public int Add(GridColumnDescriptor value)
    Parameters
    Type Name Description
    GridColumnDescriptor value

    The element to be added to the end of the collection. The value must not be a NULL reference (Nothing in Visual Basic).

    Returns
    Type Description
    System.Int32

    The zero-based collection index at which the value has been added.

    Add(String)

    Adds an object to the end of the collection.

    Declaration
    public int Add(string name)
    Parameters
    Type Name Description
    System.String name

    The name of the element to be added to the end of the collection. The value must not be a NULL reference (Nothing in Visual Basic).

    Returns
    Type Description
    System.Int32

    The zero-based collection index at which the value has been added.

    Add(String, String)

    Adds an object to the end of the collection.

    Declaration
    public int Add(string name, string mappingName)
    Parameters
    Type Name Description
    System.String name

    The name of the element to be added to the end of the collection. The value must not be a NULL reference (Nothing in Visual Basic).

    System.String mappingName

    The field name.

    Returns
    Type Description
    System.Int32

    The zero-based collection index at which the value has been added.

    AddRange(GridColumnDescriptor[])

    Adds multiple elements at the end of the collection.

    Declaration
    public void AddRange(GridColumnDescriptor[] columnDescriptors)
    Parameters
    Type Name Description
    GridColumnDescriptor[] columnDescriptors

    The Array with elements that should be added to the end of the collection. The array and its elements cannot be NULL references (Nothing in Visual Basic).

    CheckType(Object)

    Ensure type correctness when a new element is added to the collection.

    Declaration
    protected virtual void CheckType(object obj)
    Parameters
    Type Name Description
    System.Object obj

    The newly added object.

    Clear()

    Removes all elements from the collection.

    Declaration
    public void Clear()

    Clone()

    Creates a copy of the collection and all its elements.

    Declaration
    public GridColumnDescriptorCollection Clone()
    Returns
    Type Description
    GridColumnDescriptorCollection

    A copy of the collection and all its elements.

    Contains(GridColumnDescriptor)

    Determines a value indicating whether the element belongs to this collection or not.

    Declaration
    public bool Contains(GridColumnDescriptor value)
    Parameters
    Type Name Description
    GridColumnDescriptor value

    The Object to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).

    Returns
    Type Description
    System.Boolean

    True if item is found in the collection; otherwise, False.

    Remarks

    The method ensures that the collection is in sync with the underlying table if changes have been made to the table or the TableDescriptor.

    The method calls EnsureInitialized(Boolean).

    Contains(String)

    Determines a value indicating whether an element with the given name belongs to this collection or not.

    Declaration
    public bool Contains(string name)
    Parameters
    Type Name Description
    System.String name

    The name of Object to locate in the collection.

    Returns
    Type Description
    System.Boolean

    True if item is found in the collection; otherwise, False.

    Remarks

    The method ensures that the collection is in sync with the underlying table if changes have been made to the table or the TableDescriptor.

    The method calls EnsureInitialized(Boolean).

    CopyTo(GridColumnDescriptor[], Int32)

    Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.

    Declaration
    public void CopyTo(GridColumnDescriptor[] array, int index)
    Parameters
    Type Name Description
    GridColumnDescriptor[] array

    The one-dimensional array that is the destination of the elements copied from the ArrayList. The array must have zero-based indexing.

    System.Int32 index

    The zero-based index in an array at which copying begins.

    CreateCollection(GridTableDescriptor, GridColumnDescriptor[])

    Called from InternalClone to create a new collection and attach it to the specified table descriptor and insert the specified columns. The columns have already been cloned.

    Declaration
    protected virtual GridColumnDescriptorCollection CreateCollection(GridTableDescriptor td, GridColumnDescriptor[] columnDescriptors)
    Parameters
    Type Name Description
    GridTableDescriptor td

    The table descriptor.

    GridColumnDescriptor[] columnDescriptors

    The cloned column descriptors.

    Returns
    Type Description
    GridColumnDescriptorCollection

    A new GridColumnDescriptorCollection.

    Dispose()

    Disposes the unmanaged resources.

    Declaration
    public void Dispose()

    EnableOneTimePopulate()

    When called the ShouldPopulate property will be set true temporarily until the next EnsureInitialized call and then be reset again to optimize subsequent lookups. The Engine calls this method when schema changes occurred (PropertyChanged was raised).

    Declaration
    public void EnableOneTimePopulate()

    EnsureInitialized(Boolean)

    Ensures the collection is initialized and auto-populates the collection on demand.

    Declaration
    protected virtual void EnsureInitialized(bool populate)
    Parameters
    Type Name Description
    System.Boolean populate

    True if collection should auto-populate itself based on properties of the underlying datasource.

    Equals(Object)

    Determines a value indicating whether the specified System.Object is equal to the current System.Object.

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    System.Object obj

    The System.Object to compare with the current System.Object.

    Returns
    Type Description
    System.Boolean

    true if the specified System.Object is equal to the current System.Object; otherwise, false.

    Overrides
    System.Object.Equals(System.Object)

    FindByField(FieldDescriptor)

    Searches the column with a matching instances's value of the FieldDescriptor class.

    Declaration
    public GridColumnDescriptor FindByField(FieldDescriptor fd)
    Parameters
    Type Name Description
    FieldDescriptor fd

    The field descriptor.

    Returns
    Type Description
    GridColumnDescriptor

    The column descriptor.

    FindByMappingName(String)

    Searches the column with a matching MappingName.

    Declaration
    public GridColumnDescriptor FindByMappingName(string mappingName)
    Parameters
    Type Name Description
    System.String mappingName

    Mapping name of the column.

    Returns
    Type Description
    GridColumnDescriptor

    The column descriptor.

    GetEnumerator()

    Returns an enumerator for the entire collection.

    Declaration
    public GridColumnDescriptorCollectionEnumerator GetEnumerator()
    Returns
    Type Description
    GridColumnDescriptorCollectionEnumerator

    An Enumerator for the entire collection.

    Remarks

    Enumerators only allow reading of the data in the collection. Enumerators cannot be used to modify the underlying collection.

    GetHashCode()

    Serves as a hash function for a particular type.

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    System.Int32

    A hash code for the current object.

    Overrides
    System.Object.GetHashCode()

    IndexOf(GridColumnDescriptor)

    Gets the zero-based index of the occurrence of the element in the collection.

    Declaration
    public int IndexOf(GridColumnDescriptor value)
    Parameters
    Type Name Description
    GridColumnDescriptor value

    The element to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).

    Returns
    Type Description
    System.Int32

    The zero-based index of the occurrence of the element within the entire collection, if found; otherwise, -1.

    IndexOf(String)

    Searches for the element with the specified name.

    Declaration
    public int IndexOf(string name)
    Parameters
    Type Name Description
    System.String name

    The name of the element to locate in the collection.

    Returns
    Type Description
    System.Int32

    The zero-based index of the occurrence of the element with matching name within the entire collection, if found; otherwise, -1.

    InitializeFrom(GridColumnDescriptorCollection)

    Copies settings from another collection and raises Changing and Changed events if differences to the other collection are detected.

    Declaration
    public void InitializeFrom(GridColumnDescriptorCollection other)
    Parameters
    Type Name Description
    GridColumnDescriptorCollection other

    The source collection.

    Insert(Int32, GridColumnDescriptor)

    Inserts a descriptor element into the collection at the specified index.

    Declaration
    public void Insert(int index, GridColumnDescriptor value)
    Parameters
    Type Name Description
    System.Int32 index

    The zero-based index at which the element should be inserted.

    GridColumnDescriptor value

    The element to insert. The value must not be a NULL reference (Nothing in Visual Basic).

    Remarks

    The method ensures that the collection is in sync with the underlying table if changes have been made to the table or the TableDescriptor.

    LoadDefault()

    Resets the collection to its default state, auto populates it, and marks it as modified. Call this method if you want to load the default items for the collection and then modify it (e.g. remove members from the auto-populated list).

    Declaration
    public void LoadDefault()
    Examples
    gridGroupingControl1.TableDescriptor.Columns.LoadDefault();
    gridGroupingControl1.TableDescriptor.Columns.Remove("MyChildTable.ForeignCategoryID");

    Modify()

    Marks the collection as modified and avoids auto-population.

    Declaration
    public void Modify()

    Move(Int32, Int32)

    Moves an element within the collection.

    Declaration
    public void Move(int src, int dest)
    Parameters
    Type Name Description
    System.Int32 src

    The original index of the element within the collection.

    System.Int32 dest

    The target index of the element within the collection.

    Remarks

    The method ensures that the collection is in sync with the underlying table if changes have been made to the table or the TableDescriptor.

    OnChanged(ListPropertyChangedEventArgs)

    Triggered when the Changed event is done.

    Declaration
    protected virtual void OnChanged(ListPropertyChangedEventArgs e)
    Parameters
    Type Name Description
    ListPropertyChangedEventArgs e

    A ListPropertyChangedEventArgs contains the event data.

    OnChanging(ListPropertyChangedEventArgs)

    Triggered when the Changing event is done.

    Declaration
    protected virtual void OnChanging(ListPropertyChangedEventArgs e)
    Parameters
    Type Name Description
    ListPropertyChangedEventArgs e

    A ListPropertyChangedEventArgs contains the event data.

    Remove(GridColumnDescriptor)

    Removes the specified descriptor element from the collection.

    Declaration
    public void Remove(GridColumnDescriptor value)
    Parameters
    Type Name Description
    GridColumnDescriptor value

    The element to remove from the collection. If the value is NULL or the element is not contained in the collection, the method will do nothing.

    Remarks

    The method ensures that the collection is in sync with the underlying table if changes have been made to the table or the TableDescriptor.

    Remove(String)

    Removes the specified descriptor element with the specified name from the collection.

    Declaration
    public void Remove(string name)
    Parameters
    Type Name Description
    System.String name

    The name of the element to remove from the collection. If no element with that name is found in the collection, the method will do nothing.

    Remarks

    The method ensures that the collection is in sync with the underlying table if changes have been made to the table or the TableDescriptor.

    RemoveAt(Int32)

    Removes the element at the specified index of the collection.

    Declaration
    public void RemoveAt(int index)
    Parameters
    Type Name Description
    System.Int32 index

    The zero-based index of the element to remove.

    Reset()

    Resets the collection to its default state. If the collection is bound to a TableDescriptor, the collection will auto populate itself the next time an item inside the collection is accessed.

    Declaration
    public void Reset()

    SuggestName(GridColumnDescriptor)

    Called to get a new default name when a new field descriptor is created (e.g. when pressing "Add" in a collection editor).

    Declaration
    protected virtual void SuggestName(GridColumnDescriptor value)
    Parameters
    Type Name Description
    GridColumnDescriptor value

    The field descriptor to be named.

    ToString()

    Overrides and gets the string representation of the current object.

    Declaration
    public override string ToString()
    Returns
    Type Description
    System.String

    A string that represents the current object.

    Overrides
    System.Object.ToString()

    Events

    Changed

    Occurs after a property in a nested element or the collection is changed.

    Declaration
    public event ListPropertyChangedEventHandler Changed
    Event Type
    Type
    ListPropertyChangedEventHandler

    Changing

    Occurs before a property in a nested element or the collection is changed.

    Declaration
    public event ListPropertyChangedEventHandler Changing
    Event Type
    Type
    ListPropertyChangedEventHandler

    Explicit Interface Implementations

    IInsideCollectionEditorProperty.InitializeFrom(Object)

    Initializes the Form for InsideCollectionEditor.

    Declaration
    void IInsideCollectionEditorProperty.InitializeFrom(object other)
    Parameters
    Type Name Description
    System.Object other

    ICollection.CopyTo(Array, Int32)

    Declaration
    void ICollection.CopyTo(Array array, int index)
    Parameters
    Type Name Description
    System.Array array
    System.Int32 index

    ICollection.SyncRoot

    Declaration
    object ICollection.SyncRoot { get; }
    Returns
    Type
    System.Object

    IEnumerable.GetEnumerator()

    Declaration
    IEnumerator IEnumerable.GetEnumerator()
    Returns
    Type
    System.Collections.IEnumerator

    IList.Add(Object)

    Declaration
    int IList.Add(object value)
    Parameters
    Type Name Description
    System.Object value
    Returns
    Type
    System.Int32

    IList.Contains(Object)

    Declaration
    bool IList.Contains(object value)
    Parameters
    Type Name Description
    System.Object value
    Returns
    Type
    System.Boolean

    IList.get_Item(Int32)

    Declaration
    object IList.get_Item(int index)
    Parameters
    Type Name Description
    System.Int32 index
    Returns
    Type
    System.Object

    IList.IndexOf(Object)

    Declaration
    int IList.IndexOf(object value)
    Parameters
    Type Name Description
    System.Object value
    Returns
    Type
    System.Int32

    IList.Insert(Int32, Object)

    Declaration
    void IList.Insert(int index, object value)
    Parameters
    Type Name Description
    System.Int32 index
    System.Object value

    IList.Item[Int32]

    Declaration
    object IList.this[] { get; set; }
    Parameters
    Type Name Description
    System.Int32 index
    Returns
    Type
    System.Object

    IList.Remove(Object)

    Declaration
    void IList.Remove(object value)
    Parameters
    Type Name Description
    System.Object value

    IList.set_Item(Int32, Object)

    Declaration
    void IList.set_Item(int index, object value)
    Parameters
    Type Name Description
    System.Int32 index
    System.Object value

    ICloneable.Clone()

    Declaration
    object ICloneable.Clone()
    Returns
    Type
    System.Object

    Implements

    System.IDisposable
    System.Collections.IList
    System.Collections.ICollection
    System.Collections.IEnumerable
    IInsideCollectionEditorProperty
    System.ICloneable
    System.ComponentModel.ICustomTypeDescriptor
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved