Class GridStackedHeaderRowDescriptorCollection

Represents a collection of GridStackedHeaderRowDescriptor objects that declares StackedHeader rows each with one or multiple GridStackedHeaderDescriptor elements. An instance of this collection is returned by the StackedHeaderRows property of a GridTableDescriptor.

Inheritance

System.Object

GridStackedHeaderRowDescriptorCollection

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 GridStackedHeaderRowDescriptorCollection : IDisposable, IList, ICollection, IEnumerable, IInsideCollectionEditorProperty, ICloneable, ICustomTypeDescriptor

Remarks

Each group in the GridTable has a GridStackedHeaderSection. The StackedHeader section has as many rows as there are GridStackedHeaderRowDescriptors. Each GridStackedHeaderRowDescriptor has a collection of GridStackedHeaderDescriptor columns. The GridStackedHeaderDescriptor defines the VisibleColumns or ColumnSets for which a combined header should be displayed before the normal column headers.

If you leave the VisibleColumns collection empty than this header will be used as default header for all columns that were not explicitly associated with another header.

So, if you want to just add an extra Caption then you could add a StackedHeaderRow with only one StackedHeader that has an empty VisibleColumns collection.

Constructors

GridStackedHeaderRowDescriptorCollection()

Initializes a new instance of the GridStackedHeaderDescriptorCollection class.

Declaration

public GridStackedHeaderRowDescriptorCollection()

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

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 is a fixed size or not. Returns False.

Declaration

public bool IsFixedSize { get; }

Property Value

Type
System.Boolean

IsReadOnly

Gets a value indicating whether the collection is read only or not. Returns False.

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

Parameters

Type	Name	Description
System.Int32	index

Property Value

Type
GridStackedHeaderRowDescriptor

Item[String]

Gets or sets the element with the specified name.

Declaration

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

Parameters

Type	Name	Description
System.String	name

Property Value

Type
GridStackedHeaderRowDescriptor

Version

Gets the version number of this collection. The version is increased each time the collection or an element within the collection was modified.

Declaration

public int Version { get; }

Property Value

Type
System.Int32

VisibleRowCount

Gets the number of rows that have the GridStackedHeaderRowDescriptor property set to True. This is also the number of stackedHeader rows that are displayed in the grid for each group.

Declaration

public int VisibleRowCount { get; }

Property Value

Type
System.Int32

Methods

Add(GridStackedHeaderRowDescriptor)

Adds a StackedHeaderDescriptor to the end of the collection.

Declaration

public int Add(GridStackedHeaderRowDescriptor value)

Parameters

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

Clear()

Removes all elements from the collection.

Declaration

public void Clear()

Clone()

Creates a copy of the collection and all its elements.

Declaration

public GridStackedHeaderRowDescriptorCollection Clone()

Returns

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

Contains(GridStackedHeaderRowDescriptor)

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

Declaration

public bool Contains(GridStackedHeaderRowDescriptor value)

Parameters

Type	Name	Description
GridStackedHeaderRowDescriptor	value	The element 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.

Contains(String)

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

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	True if item is found in the collection; Otherwise False.

CopyTo(GridStackedHeaderRowDescriptor[], Int32)

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

Declaration

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

Parameters

Type	Name	Description
GridStackedHeaderRowDescriptor[]	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 of the object and collection items.

Declaration

public void Dispose()

Equals(Object)

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

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)

GetEnumerator()

Gets an enumerator for the entire collection.

Declaration

public GridStackedHeaderRowDescriptorCollectionEnumerator GetEnumerator()

Returns

Type	Description
GridStackedHeaderRowDescriptorCollectionEnumerator	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()

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

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

Declaration

public int IndexOf(GridStackedHeaderRowDescriptor value)

Parameters

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

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

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 within the entire collection, if found; otherwise, -1.

InitializeFrom(GridStackedHeaderRowDescriptorCollection)

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

Declaration

public void InitializeFrom(GridStackedHeaderRowDescriptorCollection other)

Parameters

Type	Name	Description
GridStackedHeaderRowDescriptorCollection	other	The source collection.

Insert(Int32, GridStackedHeaderRowDescriptor)

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

Declaration

public void Insert(int index, GridStackedHeaderRowDescriptor value)

Parameters

Type	Name	Description
System.Int32	index	The zero-based index at which the element should be inserted.
GridStackedHeaderRowDescriptor	value	The element to insert. The value must not be a NULL reference (Nothing in Visual Basic).

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.

OnPropertyChanged(DescriptorPropertyChangedEventArgs)

Triggered when the PropertyChanged event is done.

Declaration

protected virtual void OnPropertyChanged(DescriptorPropertyChangedEventArgs e)

Parameters

Type	Name	Description
DescriptorPropertyChangedEventArgs	e	A DescriptorPropertyChangedEventArgs contains the event data.

OnPropertyChanging(DescriptorPropertyChangedEventArgs)

Triggered when the PropertyChanging event is done.

Declaration

protected virtual void OnPropertyChanging(DescriptorPropertyChangedEventArgs e)

Parameters

Type	Name	Description
DescriptorPropertyChangedEventArgs	e	A DescriptorPropertyChangedEventArgs contains the event data.

Remove(GridStackedHeaderRowDescriptor)

Removes the specified descriptor element from the collection.

Declaration

public void Remove(GridStackedHeaderRowDescriptor value)

Parameters

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

Remove(String)

Removes the a descriptor element that matches 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 locate in the collection.

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.

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

PropertyChanged

Occurs when a property is changed.

Declaration

public event DescriptorPropertyChangedEventHandler PropertyChanged

Event Type

Type
DescriptorPropertyChangedEventHandler

PropertyChanging

Occurs before a property is changed.

Declaration

public event DescriptorPropertyChangedEventHandler PropertyChanging

Event Type

Type
DescriptorPropertyChangedEventHandler

Explicit Interface Implementations

IInsideCollectionEditorProperty.InitializeFrom(Object)

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