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

Namespace: Syncfusion.Grouping

Assembly: Syncfusion.Grouping.Base.dll

Syntax

public class RuntimeElementsInTableCollection : Object, 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).

Implements

System.Collections.IList

System.Collections.ICollection

System.Collections.IEnumerable

System.IDisposable