Class SectionInGroupCollection
Implements a collection of Section elements that are children of a Group. An instance of this collection is returned by the Sections property of a Group object.
Inheritance
Implements
Inherited Members
Namespace: Syncfusion.Grouping
Assembly: Syncfusion.Grouping.Base.dll
Syntax
public class SectionInGroupCollection : IList, ICollection, IEnumerable, IDisposable
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 the EnsureInitialized(Object, Boolean) of the Group.
InnerCount
Gets the number of elements contained in the collection without calling the EnsureInitialized(Object, Boolean) of the Group.
Declaration
public int InnerCount { get; }
Property Value
Type |
---|
System.Int32 |
IsFixedSize
Returns False since this collection has no fixed size.
Declaration
public bool IsFixedSize { get; }
Property Value
Type |
---|
System.Boolean |
IsReadOnly
Returns False.
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 Section this[int index] { get; set; }
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index |
Property Value
Type |
---|
Section |
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(Object, Boolean).
Methods
Add(Section)
Adds an object to the end of the collection.
Declaration
public int Add(Section section)
Parameters
Type | Name | Description |
---|---|---|
Section | section | 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(Section)
Determines if the element belongs to this collection.
Declaration
public bool Contains(Section value)
Parameters
Type | Name | Description |
---|---|---|
Section | 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(Object, Boolean).
CopyTo(Section[], Int32)
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
Declaration
public void CopyTo(Section[] array, int index)
Parameters
Type | Name | Description |
---|---|---|
Section[] | 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. |
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(Object, Boolean).
Dispose()
Disposes the object and releases internal objects.
Declaration
public void Dispose()
GetEnumerator()
Returns an enumerator for the entire collection.
Declaration
public SectionInGroupCollectionEnumerator GetEnumerator()
Returns
Type | Description |
---|---|
SectionInGroupCollectionEnumerator | 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.
GetInnerItem(Int32)
Gets or sets the element at the zero-based index without OnEnsureInitialized(Object) being called.
Declaration
public Section GetInnerItem(int index)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | Element index. |
Returns
Type | Description |
---|---|
Section | Element at the given index. |
IndexOf(Section)
Returns the zero-based index of the occurrence of the element in the collection.
Declaration
public int IndexOf(Section value)
Parameters
Type | Name | Description |
---|---|---|
Section | 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. |
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(Object, Boolean).
Insert(Int32, Section)
Inserts an element into the collection at the specified index.
Declaration
public void Insert(int index, Section section)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | The zero-based index at which the element should be inserted. |
Section | section | The element to insert. The value can 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 EnsureInitialized(Object, Boolean).
Remove(Section)
Removes the specified element from the collection.
Declaration
public void Remove(Section value)
Parameters
Type | Name | Description |
---|---|---|
Section | 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 EnsureInitialized(Object, Boolean).
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 System.Collections.ICollection to an System.Array, starting at a particular System.Array index.
Declaration
void ICollection.CopyTo(Array array, int index)
Parameters
Type | Name | Description |
---|---|---|
System.Array | array | The one-dimensional System.Array that is the destination of the elements copied from System.Collections.ICollection. The System.Array must have zero-based indexing. |
System.Int32 | index | The zero-based index in array at which copying begins. |
ICollection.SyncRoot
Gets an object that can be used to synchronize access to the System.Collections.ICollection.
Declaration
object ICollection.SyncRoot { get; }
Returns
Type |
---|
System.Object |
IEnumerable.GetEnumerator()
Returns an enumerator that iterates through a collection.
Declaration
IEnumerator IEnumerable.GetEnumerator()
Returns
Type | Description |
---|---|
System.Collections.IEnumerator | An System.Collections.IEnumerator object that can be used to iterate through the collection. |
IList.Add(Object)
Adds an item to the System.Collections.IList.
Declaration
int IList.Add(object value)
Parameters
Type | Name | Description |
---|---|---|
System.Object | value | The object to add to the System.Collections.IList. |
Returns
Type | Description |
---|---|
System.Int32 | The position into which the new element was inserted, or -1 to indicate that the item was not inserted into the collection. |
IList.Contains(Object)
Determines whether the System.Collections.IList contains a specific value.
Declaration
bool IList.Contains(object value)
Parameters
Type | Name | Description |
---|---|---|
System.Object | value | The object to locate in the System.Collections.IList. |
Returns
Type | Description |
---|---|
System.Boolean | true if the System.Object is found in the System.Collections.IList; 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)
Determines the index of a specific item in the System.Collections.IList.
Declaration
int IList.IndexOf(object value)
Parameters
Type | Name | Description |
---|---|---|
System.Object | value | The object to locate in the System.Collections.IList. |
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 System.Collections.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 insert into the System.Collections.IList. |
IList.Item[Int32]
Gets or sets the element at the specified index.
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 System.Collections.IList.
Declaration
void IList.Remove(object value)
Parameters
Type | Name | Description |
---|---|---|
System.Object | value | The object to remove from the System.Collections.IList. |
IList.set_Item(Int32, Object)
Declaration
void IList.set_Item(int index, object value)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | |
System.Object | value |