Class CaptionRowCollection
Represents the class that supports a collection of CaptionRow elements that are children of a CaptionSection in a Group. An instance of this collection is returned by the CaptionRows property of a CaptionSection object.
Inheritance
Implements
Namespace: Syncfusion.Grouping
Assembly: Syncfusion.Grouping.Base.dll
Syntax
public class CaptionRowCollection : Object, IList, ICollection, IEnumerable
Properties
Count
Gets the value of the number of elements contained in the collection.
Declaration
public int Count { get; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | Count in the collection. |
IsFixedSize
Gets the value that determines whether the collection is of fixed size or not.
Declaration
public bool IsFixedSize { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | Returns False. |
IsReadOnly
Gets the value that determines whether the collection is Read-only or not.
Declaration
public bool IsReadOnly { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | Returns False. |
IsSynchronized
Gets the value that determines whether 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 CaptionRow this[int index] { get; set; }
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | Key to identify the requested element. |
Property Value
| Type |
|---|
| CaptionRow |
Methods
Add(CaptionRow)
Adds a value to the end of the collection.
Declaration
public int Add(CaptionRow value)
Parameters
| Type | Name | Description |
|---|---|---|
| CaptionRow | 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(CaptionRow)
Determines whether the element belongs to this collection or not.
Declaration
public bool Contains(CaptionRow value)
Parameters
| Type | Name | Description |
|---|---|---|
| CaptionRow | value | The Object to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic). |
Returns
| Type | Description |
|---|---|
| System.Boolean | IfTrue item is found in the collection;Otherwise False. |
CopyTo(CaptionRow[], Int32)
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
Declaration
public void CopyTo(CaptionRow[] array, int index)
Parameters
| Type | Name | Description |
|---|---|---|
| CaptionRow[] | 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 an array at which copying begins. |
GetEnumerator()
Gets an enumerator for the entire collection.
Declaration
public CaptionRowCollectionEnumerator GetEnumerator()
Returns
| Type | Description |
|---|---|
| CaptionRowCollectionEnumerator | An Enumerator for the entire collection. |
Remarks
Enumerators only allow reading the data in the collection. Enumerators cannot be used to modify the underlying collection.
IndexOf(CaptionRow)
Gets the zero-based index of the occurrence of the element in the collection.
Declaration
public int IndexOf(CaptionRow value)
Parameters
| Type | Name | Description |
|---|---|---|
| CaptionRow | 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, CaptionRow)
Inserts an element into the collection at the specified index.
Declaration
public void Insert(int index, CaptionRow value)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | The zero-based index at which the element should be inserted. |
| CaptionRow | value | The element to insert. The value must not be a NULL reference (Nothing in Visual Basic). |
Remove(CaptionRow)
Removes the specified element from the collection.
Declaration
public void Remove(CaptionRow value)
Parameters
| Type | Name | Description |
|---|---|---|
| CaptionRow | 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. |