Class ColumnHeaderRowCollection

Defines the class that provides the collection of CaptionRow elements that are children of a ColumnHeaderSection in a Group. An instance of this collection is returned by the ColumnHeaderRows property of a ColumnHeaderSection object.

Inheritance
System.Object
ColumnHeaderRowCollection
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.Grouping
Assembly: Syncfusion.Grouping.Base.dll
Syntax
public class ColumnHeaderRowCollection : IList, ICollection, IEnumerable

Properties

Count

Gets the number of elements contained in the collection.

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

IsFixedSize

Determines whether the collection is of Fixed size or not.

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

Returns False.

IsReadOnly

Determines whether the collection is read-only or not.

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

Returns False.

IsSynchronized

Determines whether the collection is Synchronized or not.

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

Returns False.

Item[Int32]

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

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

Methods

Add(ColumnHeaderRow)

Adds a value to the end of the collection.

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

Determines whether the element belongs to this collection or not.

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

The Object to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).
Returns
Type Description
System.Boolean

If Truethe item is found in the collection;Otherwise False.

CopyTo(ColumnHeaderRow[], Int32)

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

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

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

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

GetEnumerator()

Gets an enumerator for the entire collection.

Declaration
public ColumnHeaderRowCollectionEnumerator GetEnumerator()
Returns
Type Description
ColumnHeaderRowCollectionEnumerator

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

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

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

Inserts an element into the collection at the specified index.

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

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

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

Remove(ColumnHeaderRow)

Removes the specified element from the collection.

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

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)

Copies the elements of the collection to an array.

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

The one-dimensional array, where the items are copied.
System.Int32 index

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

ICollection.SyncRoot

Gets the value of the object that can be used to synchronize access to the collection.

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

IEnumerable.GetEnumerator()

Gets an enumerator that iterates through a collection.

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

An IEnumerator object that can be used to iterate through the collection.

IList.Add(Object)

Adds an item to the collection.

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

The object to be added to the collection.
Returns
Type Description
System.Int32

The position into which the new element was inserted, or -1.

IList.Contains(Object)

Determines whether the collection contains the specified value or not.

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

The object to be located in the collection.
Returns
Type Description
System.Boolean

IfTruethe object is found in the collection;Otherwise False.

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)

Gets the index of a specific item in the collection.

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

The object to be located in the collection.
Returns
Type Description
System.Int32

The index of value if found in the list; otherwise, -1.

IList.Insert(Int32, Object)

Inserts an item to the IList at the specified index.

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

The zero-based index at which value should be inserted.
System.Object value

The object to be inserted into the IList collection.

IList.Item[Int32]

Gets or sets the element at the specified index in the collection.

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

The zero-based index of the element to get or set.
Returns
Type Description
System.Object

The element at the specified index.

IList.Remove(Object)

Removes the first occurrence of a specific object from the IList.

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

The object to be removed from the collection.

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