Class GridVisibleColumnDescriptorCollection

A collection of GridVisibleColumnDescriptor columns each referencing a GridColumnDescriptor or GridColumnSetDescriptor. The order of GridVisibleColumnDescriptors in the VisibleColumns collection defines the left to right order of columns shown in the grid.

An instance of this collection is returned by the VisibleColumns property of a GridTableDescriptor.

Inheritance

System.Object

GridVisibleColumnDescriptorCollection

Implements

System.IDisposable

System.Collections.IList

System.Collections.ICollection

System.Collections.IEnumerable

System.ICloneable

System.ComponentModel.ICustomTypeDescriptor

Namespace: Syncfusion.Windows.Forms.Grid.Grouping

Assembly: Syncfusion.Grid.Grouping.Windows.dll

Syntax

public class GridVisibleColumnDescriptorCollection : Object, IDisposable, IList, ICollection, IEnumerable, ICloneable, ICustomTypeDescriptor

Constructors

GridVisibleColumnDescriptorCollection()

Initializes a new empty collection.

Declaration

public GridVisibleColumnDescriptorCollection()

Fields

Empty

A Read-only and empty collection.

Declaration

public static readonly GridVisibleColumnDescriptorCollection Empty

Field Value

Type
GridVisibleColumnDescriptorCollection

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 whether the collection is manipulated inside a collection editor.

Declaration

public bool InsideCollectionEditor { get; set; }

Property Value

Type
System.Boolean

IsFixedSize

Returns normally False since this collection has no fixed size. Only when it is Read-only IsFixedSize returns True.

Declaration

public bool IsFixedSize { get; }

Property Value

Type
System.Boolean

IsModified

Gets or sets whether the collection is modified from its default state.

Declaration

public bool IsModified { get; set; }

Property Value

Type
System.Boolean

IsReadOnly

Returns False if the collection is Read-only.

Declaration

public bool IsReadOnly { get; }

Property Value

Type
System.Boolean

IsSynchronized

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 GridVisibleColumnDescriptor this[int index] { get; set; }

Parameters

Type	Name	Description
System.Int32	index

Property Value

Type
GridVisibleColumnDescriptor

Item[String]

Gets or sets the element with the specified name.

Declaration

public GridVisibleColumnDescriptor this[string name] { get; set; }

Parameters

Type	Name	Description
System.String	name

Property Value

Type
GridVisibleColumnDescriptor

ShouldPopulate

Gets or sets whether 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

TableDescriptor

Gets the table descriptor this collection belongs to.

Declaration

public GridTableDescriptor TableDescriptor { get; }

Property Value

Type
GridTableDescriptor

TotalWidth

Gets the total horizontal width of the table inside the grid.

Declaration

public int TotalWidth { get; }

Property Value

Type
System.Int32

Version

Gets the version number of this collection. The version is increased each time the collection or an element within the collection was 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(GridVisibleColumnDescriptor)

Adds an object to the end of the collection.

Declaration

public int Add(GridVisibleColumnDescriptor value)

Parameters

Type	Name	Description
GridVisibleColumnDescriptor	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_Changed(ListPropertyChangedEventHandler)

Declaration

public void add_Changed(ListPropertyChangedEventHandler value)

Parameters

Type	Name	Description
ListPropertyChangedEventHandler	value

add_Changing(ListPropertyChangedEventHandler)

Declaration

public void add_Changing(ListPropertyChangedEventHandler value)

Parameters

Type	Name	Description
ListPropertyChangedEventHandler	value

AddRange(GridVisibleColumnDescriptor[])

Adds multiple elements at the end of the collection.

Declaration

public void AddRange(GridVisibleColumnDescriptor[] columnDescriptors)

Parameters

Type	Name	Description
GridVisibleColumnDescriptor[]	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).

Clear()

Removes all elements from the collection.

Declaration

public void Clear()

Clone()

Creates a copy of the collection and all its elements.

Declaration

public GridVisibleColumnDescriptorCollection Clone()

Returns

Type	Description
GridVisibleColumnDescriptorCollection	A copy of the collection and all its elements.

Contains(GridVisibleColumnDescriptor)

Determines if the element belongs to this collection.

Declaration

public bool Contains(GridVisibleColumnDescriptor value)

Parameters

Type	Name	Description
GridVisibleColumnDescriptor	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)

Searches for the element with the specified name.

Declaration

public bool Contains(string name)

Parameters

Type	Name	Description
System.String	name	The name of the element to locate in the collection.

Returns

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

CopyTo(GridVisibleColumnDescriptor[], Int32)

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

Declaration

public void CopyTo(GridVisibleColumnDescriptor[] array, int index)

Parameters

Type	Name	Description
GridVisibleColumnDescriptor[]	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.

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 occured (PropertyChanged was raised).

Declaration

public void EnableOneTimePopulate()

EnsureInitialized(Boolean)

Declaration

protected virtual void EnsureInitialized(bool populate)

Parameters

Type	Name	Description
System.Boolean	populate

Equals(Object)

Determines 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.

GetEnumerator()

Returns an enumerator for the entire collection.

Declaration

public GridVisibleColumnDescriptorCollectionEnumerator GetEnumerator()

Returns

Type	Description
GridVisibleColumnDescriptorCollectionEnumerator	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.

GetWidthColumns(out Int32[])

Returns an array of columns that affect the width of the table in the grid.

Declaration

public GridColumnDescriptor[] GetWidthColumns(out int[] factor)

Parameters

Type	Name	Description
System.Int32[]	factor	An array in the same order as the returned array with width factors indicating the number of grid columns spanned by a column descriptor.

Returns

Type	Description
GridColumnDescriptor[]	An array of columns that affect the width of this column set. Each column will also have a width factor returned through the factor array.

IndexOf(GridVisibleColumnDescriptor)

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

Declaration

public int IndexOf(GridVisibleColumnDescriptor value)

Parameters

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

Returns

Type	Description
System.Int32	True if item is found in the collection; otherwise, False.

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(GridVisibleColumnDescriptorCollection)

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

Declaration

public void InitializeFrom(GridVisibleColumnDescriptorCollection other)

Parameters

Type	Name	Description
GridVisibleColumnDescriptorCollection	other	The source collection.

Insert(Int32, GridVisibleColumnDescriptor)

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

Declaration

public void Insert(int index, GridVisibleColumnDescriptor value)

Parameters

Type	Name	Description
System.Int32	index	The zero-based index at which the element should be inserted.
GridVisibleColumnDescriptor	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.

Insert(Int32, String)

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

Declaration

public void Insert(int index, string name)

Parameters

Type	Name	Description
System.Int32	index	The zero-based index at which the element should be inserted.
System.String	name	The name of 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 them (e.g. remove members from the auto-populated list).

Declaration

public void LoadDefault()

Examples

gridGroupingControl1.TableDescriptor.VisibleColumns.LoadDefault();
gridGroupingControl1.TableDescriptor.VisibleColumns.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)

Raises the Changed event.

Declaration

protected virtual void OnChanged(ListPropertyChangedEventArgs e)

Parameters

Type	Name	Description
ListPropertyChangedEventArgs	e	A ListPropertyChangedEventArgs that contains the event data.

OnChanging(ListPropertyChangedEventArgs)

Raises the Changed event.

Declaration

protected virtual void OnChanging(ListPropertyChangedEventArgs e)

Parameters

Type	Name	Description
ListPropertyChangedEventArgs	e	A ListPropertyChangedEventArgs that contains the event data.

OnTotalWidthRequest(CancelEventArgs)

Raises the TotalWidthRequest event.

Declaration

protected virtual void OnTotalWidthRequest(CancelEventArgs e)

Parameters

Type	Name	Description
System.ComponentModel.CancelEventArgs	e	An System.EventArgs that contains the event data.

Remove(GridVisibleColumnDescriptor)

Removes the specified descriptor element from the collection.

Declaration

public void Remove(GridVisibleColumnDescriptor value)

Parameters

Type	Name	Description
GridVisibleColumnDescriptor	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.

remove_Changed(ListPropertyChangedEventHandler)

Declaration

public void remove_Changed(ListPropertyChangedEventHandler value)

Parameters

Type	Name	Description
ListPropertyChangedEventHandler	value

remove_Changing(ListPropertyChangedEventHandler)

Declaration

public void remove_Changing(ListPropertyChangedEventHandler value)

Parameters

Type	Name	Description
ListPropertyChangedEventHandler	value

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()

ToString()

Returns a string that represents the current object.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A string that represents the current object.

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

TotalWidthRequest

Occurs when the grid is recalculating the total horizontal width of the table inside the grid.

Declaration

public event CancelEventHandler TotalWidthRequest

Event Type

Type
System.ComponentModel.CancelEventHandler

Implements

System.IDisposable

System.Collections.IList

System.Collections.ICollection

System.Collections.IEnumerable

System.ICloneable

System.ComponentModel.ICustomTypeDescriptor