Class FlattenedRecordsInGroupCollectionBase
A Read-only collection base class for FlattenedFilteredRecordsInGroupCollection and FlattenedRecordsInGroupCollection.
Inheritance
Implements
Namespace: Syncfusion.Grouping
Assembly: Syncfusion.Grouping.Base.dll
Syntax
public class FlattenedRecordsInGroupCollectionBase : Object, IList, ICollection, IEnumerable, IDisposableProperties
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 EnsureInitialized(Object, Boolean).
IsFixedSize
Returns False since this collection has no fixed size.
Declaration
public bool IsFixedSize { get; }Property Value
| Type |
|---|
| System.Boolean |
IsReadOnly
Returns True because this collection is always Read-only.
Declaration
public bool IsReadOnly { get; }Property Value
| Type |
|---|
| System.Boolean |
IsSynchronized
Returns whether the collection of rows is synchronized or not.
Declaration
public bool IsSynchronized { get; }Property Value
| Type |
|---|
| System.Boolean |
Item[Int32]
Gets (and caches) the element at the zero-based index. Setting is not supported and will throw an exception since the collection is Read-only.
Declaration
public Record this[int index] { get; set; }Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index |
Property Value
| Type |
|---|
| Record |
Remarks
The method ensures that the collection is in sync with the underlying group if changes have been made to the group or the TableDescriptor.
The method calls EnsureInitialized(Object, Boolean).
Methods
Contains(Record)
Determines if the element belongs to this collection.
Declaration
public bool Contains(Record value)Parameters
| Type | Name | Description |
|---|---|---|
| Record | 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 group if changes have been made to the group or the TableDescriptor.
The method calls EnsureInitialized(Object, Boolean).
CopyTo(Record[], Int32)
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
Declaration
public void CopyTo(Record[] array, int index)Parameters
| Type | Name | Description |
|---|---|---|
| Record[] | 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 group if changes have been made to the Group or the TableDescriptor.
The method calls EnsureInitialized(Object, Boolean).
Dispose()
Disposes of the object and releases internal objects.
Declaration
public void Dispose()GetEnumerator()
Returns an enumerator for the entire collection.
Declaration
public FlattenedRecordsInGroupCollectionEnumerator GetEnumerator()Returns
| Type | Description |
|---|---|
| FlattenedRecordsInGroupCollectionEnumerator | 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(Record)
Returns the zero-based index of the occurrence of the element in the collection.
Declaration
public int IndexOf(Record value)Parameters
| Type | Name | Description |
|---|---|---|
| Record | 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 group if changes have been made to the group or the TableDescriptor.
The method calls EnsureInitialized(Object, Boolean).