Class FlattenedRecordsInGroupCollectionBase

A Read-only collection base class for FlattenedFilteredRecordsInGroupCollection and FlattenedRecordsInGroupCollection.

Inheritance
System.Object
FlattenedRecordsInGroupCollectionBase
FlattenedFilteredRecordsInGroupCollection
FlattenedRecordsInGroupCollection
Implements
System.Collections.IList
System.Collections.ICollection
System.Collections.IEnumerable
System.IDisposable
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 FlattenedRecordsInGroupCollectionBase : 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 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).

Explicit Interface Implementations

ICollection.CopyTo(Array, Int32)

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

Declaration
void ICollection.CopyTo(Array array, int index)
Parameters
Type Name Description
System.Array 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).

ICollection.SyncRoot

Returns whether collection of rows can be synchronized.

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

IEnumerable.GetEnumerator()

Returns an enumerator for the entire collection.

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

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.

IList.Add(Object)

Adds the specified value to collection.

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

The value of an record.
Returns
Type
System.Int32
Exceptions
Type Condition
System.InvalidOperationException

Collection is Read-only.

IList.Clear()

Clears the list.

Declaration
void IList.Clear()
Exceptions
Type Condition
System.InvalidOperationException

Collection is Read-only.

IList.Contains(Object)

Checks whether the specified value is in collection or not.

Declaration
bool IList.Contains(object value)
Parameters
Type Name Description
System.Object value
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)

Returns the index of specified value.

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

The System.Object to locate in the System.Collections.IList.
Returns
Type Description
System.Int32

The index of value if found in the list.

IList.Insert(Int32, Object)

Inserts the value at the specified index.

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

The index of an record.
System.Object value

the value of an specified record.
Exceptions
Type Condition
System.InvalidOperationException

Collection is Read-only.

IList.Item[Int32]

Gets or sets the index of an record.

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

The index of an record.
Returns
Type
System.Object
Exceptions
Type Condition
System.InvalidOperationException

Collection is Read-only.

IList.Remove(Object)

Removes the specified value from the collection.

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

The value of the specified record.
Exceptions
Type Condition
System.InvalidOperationException

Collection is Read-only.

IList.RemoveAt(Int32)

Removes the element at the specified index of the collection.

Declaration
void IList.RemoveAt(int index)
Parameters
Type Name Description
System.Int32 index

The zero-based index of the element to remove.
Exceptions
Type Condition
System.InvalidOperationException

Collection is Read-only.

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
System.IDisposable

Extension Methods