Class GroupTypedListRecordsCollection

For internal use. Defines and implements the class that supports to discover and binds the data source.

Inheritance

System.Object

GroupTypedListRecordsCollection

GridGroupTypedListRecordsCollection

Implements

System.ComponentModel.ITypedList

System.ComponentModel.IBindingList

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 GroupTypedListRecordsCollection : ITypedList, IBindingList, IList, ICollection, IEnumerable, IDisposable

Constructors

GroupTypedListRecordsCollection(Group)

For internal use. Initializes the new instance of GroupTypedListRecordsCollection class.

Declaration

public GroupTypedListRecordsCollection(Group group)

Parameters

Type	Name	Description
Group	group	Defines a set of records that belong to a category.

Properties

AllowEdit

For internal use. Determines whether editing is allowed or not.

Declaration

public bool AllowEdit { get; }

Property Value

Type
System.Boolean

AllowNew

For internal use. Determines whether new grouping is allowed or not.

Declaration

public bool AllowNew { get; }

Property Value

Type
System.Boolean

AllowRemove

For internal use. Determines grouped columns can be removed or not.

Declaration

public bool AllowRemove { get; }

Property Value

Type
System.Boolean

Count

For internal use. Gets the count from the collection.

Declaration

public int Count { get; }

Property Value

Type
System.Int32

Group

For internal use. Gets the group

Declaration

public Group Group { get; }

Property Value

Type
Group

IsFixedSize

For internal use. Returns False since this collection has no fixed size.

Declaration

public bool IsFixedSize { get; }

Property Value

Type
System.Boolean

IsReadOnly

For internal use. Gets whether collection is read only or not.

Declaration

public bool IsReadOnly { get; }

Property Value

Type
System.Boolean

IsSorted

For internal use. Determines whether columns are sorted or not.

Declaration

public bool IsSorted { get; }

Property Value

Type
System.Boolean

IsSynchronized

For internal use. Determines whether the collection is synchronized or not.

Declaration

public bool IsSynchronized { get; }

Property Value

Type
System.Boolean

Item[Int32]

For internal use. Gets or sets the index of the record.

Declaration

public Record this[int index] { get; set; }

Parameters

Type	Name	Description
System.Int32	index	The index of the record.

Property Value

Type	Description
Record	Returns the index of the record.

SortDirection

For internal use. Gets the sort direction.

Declaration

public ListSortDirection SortDirection { get; }

Property Value

Type
System.ComponentModel.ListSortDirection

SortProperty

For internal use. Returns Sorted columns name if columns are sorted else return null.

Declaration

public PropertyDescriptor SortProperty { get; }

Property Value

Type
System.ComponentModel.PropertyDescriptor

SupportsChangeNotification

For internal use. Determines whether change notification is supported or not.

Declaration

public bool SupportsChangeNotification { get; }

Property Value

Type
System.Boolean

SupportsSearching

For internal use. Determines whether searching is supported or not.

Declaration

public bool SupportsSearching { get; }

Property Value

Type
System.Boolean

SupportsSorting

For internal use. Determines whether sorting is supported or not.

Declaration

public bool SupportsSorting { get; }

Property Value

Type
System.Boolean

SyncRoot

For internal use. Returns whether collection of rows can be synchronized.

Declaration

public object SyncRoot { get; }

Property Value

Type
System.Object

Methods

Add(Object)

For internal use. Adds the specified value to collection.

Declaration

public int Add(object value)

Parameters

Type	Name	Description
System.Object	value	The value of an record.

Returns

Type	Description
System.Int32	Always return -1

AddIndex(PropertyDescriptor)

For internal use. Adds the specified index.

Declaration

public void AddIndex(PropertyDescriptor property)

Parameters

Type	Name	Description
System.ComponentModel.PropertyDescriptor	property	Provides an abstraction of a property on a class.

AddNew()

For internal use. Determines whether add new record is supported or not.

Declaration

public object AddNew()

Returns

Type	Description
System.Object	Returns always null.

ApplySort(PropertyDescriptor, ListSortDirection)

For internal use. Applies sorting to a list.

Declaration

public void ApplySort(PropertyDescriptor property, ListSortDirection direction)

Parameters

Type	Name	Description
System.ComponentModel.PropertyDescriptor	property	Provides abstraction of a property on a class.
System.ComponentModel.ListSortDirection	direction	Direction of sorting in a list.

Clear()

For internal use. Clears the grouped lists.

Declaration

public void Clear()

Contains(Object)

For internal use. Checks whether the specified value is in collection or not.

Declaration

public bool 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.

CopyTo(Record[], Int32)

For internal use. 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 table if changes have been made to the Table or the TableDescriptor.

The method calls EnsureInitialized(Object, Boolean).

Dispose()

For internal use. Disposes the object.

Declaration

public void Dispose()

Find(PropertyDescriptor, Object)

To find the index of the specified row. For internal use.

Declaration

public int Find(PropertyDescriptor property, object key)

Parameters

Type	Name	Description
System.ComponentModel.PropertyDescriptor	property
System.Object	key

Returns

Type	Description
System.Int32	The index of the row that has the given System.ComponentModel.PropertyDescriptor.

GetEnumerator()

For internal use. Returns an enumerator for the entire collection.

Declaration

public FlattenedRecordsInGroupCollectionEnumerator GetEnumerator()

Returns

Type	Description
FlattenedRecordsInGroupCollectionEnumerator	Returns FlattenedRecordsInGroupCollectionEnumerator.

GetItemProperties(PropertyDescriptor[])

For internal use. Returns the System.ComponentModel.PropertyDescriptorCollection that represents the properties on each item used to bind data.

Declaration

public virtual PropertyDescriptorCollection GetItemProperties(PropertyDescriptor[] listAccessors)

Parameters

Type	Name	Description
System.ComponentModel.PropertyDescriptor[]	listAccessors	An array of System.ComponentModel.PropertyDescriptor objects to find in the collection as bindable. This can be null.

Returns

Type	Description
System.ComponentModel.PropertyDescriptorCollection	The System.ComponentModel.PropertyDescriptorCollection that represents the properties on each item used to bind data.

GetListName(PropertyDescriptor[])

For internal use. Returns a string in format (TableDescriptor.Name) {GetChildCount()}-Items: CategoryKeys.

Declaration

public string GetListName(PropertyDescriptor[] listAccessors)

Parameters

Type	Name	Description
System.ComponentModel.PropertyDescriptor[]	listAccessors	An array of System.ComponentModel.PropertyDescriptor objects, for which the list name is returned. This can be null.

Returns

Type	Description
System.String	The name of the list.

IndexOf(Object)

For internal use. Returns the index of specified value.

Declaration

public int 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; otherwise, -1.

Insert(Int32, Object)

For internal use. Inserts the value at the specified index.

Declaration

public void 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.

Remove(Object)

For internal use. Remove the specified item from the collection.

Declaration

public void Remove(object value)

Parameters

Type	Name	Description
System.Object	value

RemoveAt(Int32)

For internal use. Removes the records at the specified index from the collection.

Declaration

public void RemoveAt(int index)

Parameters

Type	Name	Description
System.Int32	index	The index of the records.

RemoveIndex(PropertyDescriptor)

Removes the index from PrimaryKeyColumns property.

Declaration

public void RemoveIndex(PropertyDescriptor property)

Parameters

Type	Name	Description
System.ComponentModel.PropertyDescriptor	property	Provides instance of PropertyDescriptor.

RemoveSort()

For internal use. Clears the sorted columns.

Declaration

public void RemoveSort()

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	A zero-index based array, that stores the values.
System.Int32	index	The specified index of the array.

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.get_Item(Int32)

Declaration

object IList.get_Item(int index)

Parameters

Type	Name	Description
System.Int32	index

Returns

Type
System.Object

IList.Item[Int32]

Gets or sets the index from the list.

Declaration

object IList.this[] { get; set; }

Parameters

Type	Name	Description
System.Int32	index	The index of an list.

Returns

Type	Description
System.Object	Returns the specified index from the list.

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.ComponentModel.ITypedList

System.ComponentModel.IBindingList

System.Collections.IList

System.Collections.ICollection

System.Collections.IEnumerable

System.IDisposable