Class RuntimeElementsInTableCollection

Implements a Read-only collection base class for DisplayElementsInTableCollection and ElementsInTableCollection.

Inheritance
System.Object
RuntimeElementsInTableCollection
DisplayElementsInTableCollection
ElementsInTableCollection
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 RuntimeElementsInTableCollection : 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).

IsDisposed

Determines whether the collection has been disposed.

Declaration
public bool IsDisposed { get; }
Property Value
Type
System.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 False.

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 readonly.

Declaration
public Element this[int index] { get; set; }
Parameters
Type Name Description
System.Int32 index
Property Value
Type
Element
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).

YAmountCount

Gets the YAmount count for 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 double YAmountCount { get; }
Property Value
Type
System.Double
Remarks

The method calls EnsureInitialized(Object, Boolean).

Methods

ClearCache()

Clears the cache of recently accessed elements.

Declaration
public void ClearCache()

Contains(Element)

Determines if the group belongs to the details section and is visible.

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

Group element.
Returns
Type Description
System.Boolean

True if the group belongs to the details section and is visible; False otherwise.
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(Element[], Int32)

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

Declaration
public void CopyTo(Element[] array, int index)
Parameters
Type Name Description
Element[] 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 of the object and clears the cache.

Declaration
public void Dispose()

GetCustomCountPositionOf(Element)

Returns the CustomCount position of the element in the collection.

Declaration
public double GetCustomCountPositionOf(Element value)
Parameters
Type Name Description
Element value

The Element.
Returns
Type Description
System.Double

Custom count position.

GetEnumerator()

Returns an enumerator for the entire collection.

Declaration
public RuntimeElementsInTableCollectionEnumerator GetEnumerator()
Returns
Type Description
RuntimeElementsInTableCollectionEnumerator

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.

GetItemAtCustomCount(Double)

Gets the element at the zero-based CustomCount position.

Declaration
public Element GetItemAtCustomCount(double index)
Parameters
Type Name Description
System.Double index

Custom count position.
Returns
Type Description
Element

Element at the given position.

GetItemAtVisibleCustomCount(Double)

Gets the element at the zero-based CustomCount position.

Declaration
public Element GetItemAtVisibleCustomCount(double index)
Parameters
Type Name Description
System.Double index

Custom count position.
Returns
Type Description
Element

Element at the given position.

GetItemAtYAmount(Double)

Gets (and caches) the element at the zero-based YAmount. With a grouping grid, YAmount represents the vertical pixel scroll position of the grid. Setting a value is not supported and will throw an exception since the collection is Read-only.

Declaration
public Element GetItemAtYAmount(double index)
Parameters
Type Name Description
System.Double index

The Index.
Returns
Type Description
Element

Returns the Element at the specified index.
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).

GetVisibleCustomCountPositionOf(Element)

Returns the CustomCount position of the element in the collection.

Declaration
public double GetVisibleCustomCountPositionOf(Element value)
Parameters
Type Name Description
Element value

The Element.
Returns
Type Description
System.Double

Custom count position of the element.

GetYAmountPositionOf(Element)

Returns the YAmount position of the element in the collection. With a grouping grid, YAmount represents the vertical pixel scroll position of the grid.

Declaration
public double GetYAmountPositionOf(Element value)
Parameters
Type Name Description
Element value

The element to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).
Returns
Type Description
System.Double

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).

IndexOf(Element)

Returns the zero-based index of the occurrence of the element in the collection.

Declaration
public int IndexOf(Element value)
Parameters
Type Name Description
Element 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).

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.
Exceptions
Type Condition
System.InvalidOperationException

If the System.Collections.IList is read-only.

IList.Clear()

Removes all items from the System.Collections.IList.

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

If the System.Collections.IList is read-only.

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.
Exceptions
Type Condition
System.InvalidOperationException

If the System.Collections.IList is read-only.

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.
Exceptions
Type Condition
System.InvalidOperationException

If the System.Collections.IList is read-only.

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.
Exceptions
Type Condition
System.InvalidOperationException

If the System.Collections.IList is read-only.

IList.RemoveAt(Int32)

Not supported because collection is read-only.

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

The list index
Exceptions
Type Condition
System.InvalidOperationException

If the System.Collections.IList 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