Class RecordsInTableCollectionBase

Represents the class that supports the read-only collection base class for RecordsInTableCollection and FilteredRecordsInTableCollection.

Inheritance
System.Object
RecordsInTableCollectionBase
FilteredRecordsInTableCollection
RecordsInTableCollection
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 RecordsInTableCollectionBase : IList, ICollection, IEnumerable, IDisposable

Properties

Count

Gets the number of elements contained in collection.

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

The method calls EnsureInitialized(Object, Boolean).

IsFixedSize

Gets a value indicating whether the collection is of fixed size or not.

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

IsReadOnly

Gets a value indicating whether the collection is read-only or not.

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

IsSynchronized

Gets a value indicating whether the object can be used to synchronize access to the collection or not.

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

Item[Int32]

Gets the value of record at the specified index..

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

The index value.
Property Value
Type
Record
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).

Exceptions
Type Condition
System.InvalidOperationException

Since the collection is read-only, if set-operation is done the exception occurs.
System.ArgumentOutOfRangeException

If the index is invalid.

Methods

Contains(Record)

Determines whether the element belongs to this collection or not.

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

The Object to be located 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(Record[], Int32)

Copies the elements of the collection from a specific array index.

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

The single-dimensional zero-index based array that stores the items.
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 of the object and releases internal objects.

Declaration
public void Dispose()

GetEnumerator()

Gets an enumerator for the entire collection.

Declaration
public RecordsInTableCollectionEnumerator GetEnumerator()
Returns
Type Description
RecordsInTableCollectionEnumerator

An instance of the RecordsInTableCollectionEnumerator class.
Remarks

Enumerators only allow reading the data in the collection. Enumerators cannot be used to modify the underlying collection.

IndexOf(Record)

Determines and gets the index of the specific item in the collection.

Declaration
public int IndexOf(Record value)
Parameters
Type Name Description
Record value

The item to be located in the collection. The value can be a NULL reference (Nothing in Visual Basic).
Returns
Type Description
System.Int32

The index of value if found in the list; 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).

Explicit Interface Implementations

ICollection.CopyTo(Array, Int32)

Copies the elements of the collection from a specific array index.

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

The single-dimensional array that stores the items.
System.Int32 index

The zero-based array index.

ICollection.SyncRoot

Gets an 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 instance of the System.Collections.IEnumerator class that can be used to iterate through the collection.

IList.Add(Object)

Adds the item to the collection.

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

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

The position into which the new element was inserted, or -1 to indicate that the item is not inserted.
Exceptions
Type Condition
System.InvalidOperationException

The collection is read-only.

IList.Clear()

Clears the entire collection.

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

The collection is read-only.

IList.Contains(Object)

Determines a value indicating whether the specified item is in the collection or not.

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

The item to be checked.
Returns
Type Description
System.Boolean

True if the item is in the collection;Otherwise False.
Exceptions
Type Condition
System.InvalidOperationException

The collection is read-only.

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 and gets the index of the specific item in the collection.

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

The item 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 collection at the specified index.

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

The zero-based index of the item to be added.
System.Object value

The item to be added.
Exceptions
Type Condition
System.InvalidOperationException

The collection is read-only.

IList.Item[Int32]

Gets 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.
Returns
Type Description
System.Object

The element at the specified index.
Exceptions
Type Condition
System.InvalidOperationException

Since the collection is read-only, if the set operation is performed the exception occurs.

IList.Remove(Object)

Removes the item from the collection.

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

The item to be removed.
Exceptions
Type Condition
System.InvalidOperationException

The collection is read-only.

IList.RemoveAt(Int32)

Removes the collection item at the specific index.

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

The zero-based index of the item to be removed.
Exceptions
Type Condition
System.InvalidOperationException

The 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