Class GridStackedHeaderRowCollection

A collection of GridStackedHeaderRow elements that are children of a GridStackedHeaderSection. An instance of this collection is returned by the StackedHeaderRows property of a GridStackedHeaderSection object.

Inheritance
System.Object
GridStackedHeaderRowCollection
Implements
System.Collections.IList
System.Collections.ICollection
System.Collections.IEnumerable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Syncfusion.Windows.Forms.Grid.Grouping
Assembly: Syncfusion.Grid.Grouping.Windows.dll
Syntax
public class GridStackedHeaderRowCollection : IList, ICollection, IEnumerable

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

If changes in the TableDescriptor are detected, the method will reinitialize the collection before returning the count.

IsFixedSize

Gets the value as False since this collection has no fixed size.

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

IsReadOnly

Gets the value as False.

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

IsSynchronized

Gets the value as False since this collection has not synchronized.

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

Item[Int32]

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

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

Methods

Add(GridStackedHeaderRow)

Adds a value to the end of the collection.

Declaration
public int Add(GridStackedHeaderRow value)
Parameters
Type Name Description
GridStackedHeaderRow 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()

Contains(GridStackedHeaderRow)

Determines if the element belongs to this collection.

Declaration
public bool Contains(GridStackedHeaderRow value)
Parameters
Type Name Description
GridStackedHeaderRow 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.

CopyTo(GridStackedHeaderRow[], Int32)

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

Declaration
public void CopyTo(GridStackedHeaderRow[] array, int index)
Parameters
Type Name Description
GridStackedHeaderRow[] 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.

GetEnumerator()

Returns an enumerator for the entire collection.

Declaration
public GridStackedHeaderRowCollectionEnumerator GetEnumerator()
Returns
Type Description
GridStackedHeaderRowCollectionEnumerator

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.

IndexOf(GridStackedHeaderRow)

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

Declaration
public int IndexOf(GridStackedHeaderRow value)
Parameters
Type Name Description
GridStackedHeaderRow 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.

Insert(Int32, GridStackedHeaderRow)

Inserts an element into the collection at the specified index.

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

The zero-based index at which the element should be inserted.
GridStackedHeaderRow 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.

The method calls Element.

Remove(GridStackedHeaderRow)

Removes the specified element from the collection.

Declaration
public void Remove(GridStackedHeaderRow value)
Parameters
Type Name Description
GridStackedHeaderRow 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.

The method calls Element

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.

Explicit Interface Implementations

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

Implements

System.Collections.IList
System.Collections.ICollection
System.Collections.IEnumerable

Extension Methods