Class UnsortedRecordsCollection
Implements a collection of unsorted Record elements that are children of a Table and represent the original records in the same order as the underlying data source. The collection provides support for determining a record's underlying position in the data source. method.
An instance of this collection is returned by the UnsortedRecords property of a Table object.
Inheritance
Implements
Namespace: Syncfusion.Grouping
Assembly: Syncfusion.Grouping.Base.dll
Syntax
public class UnsortedRecordsCollection : Object, IList, ICollection, IEnumerable, IDisposableProperties
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 False.
Declaration
public bool IsSynchronized { get; }Property Value
| Type |
|---|
| System.Boolean |
Item[Int32]
Gets or sets 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 table if changes have been made to the table or the TableDescriptor.
The method calls EnsureInitialized(Object, Boolean).
Methods
Add(Record)
Adds the given record into the collection.
Declaration
public int Add(Record record)Parameters
| Type | Name | Description |
|---|---|---|
| Record | record | The Record. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Index at which the record is added. |
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 table if changes have been made to the table 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 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()
Returns an enumerator for the entire collection.
Declaration
public IEnumerator 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.
GetNext(Record)
Returns the next record in the collection.
Declaration
public Record GetNext(Record r)Parameters
| Type | Name | Description |
|---|---|---|
| Record | r | The Record. |
Returns
| Type | Description |
|---|---|
| Record | Next record. |
GetPrevious(Record)
Returns the previous record in the collection.
Declaration
public Record GetPrevious(Record r)Parameters
| Type | Name | Description |
|---|---|---|
| Record | r | The Record. |
Returns
| Type | Description |
|---|---|
| Record | Previous record. |
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 table if changes have been made to the table or the TableDescriptor.
The method calls EnsureInitialized(Object, Boolean).
Insert(Int32, Record)
Inserts an element into the collection at the specified index.
Declaration
public void Insert(int pos, Record r)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | pos | The zero-based index at which the element should be inserted. |
| Record | r | The element to insert. The value must not be a NULL reference (Nothing in Visual Basic). |
Remove(Record)
Removes the record from unsorted records tree.
Declaration
public void Remove(Record r)Parameters
| Type | Name | Description |
|---|---|---|
| Record | r | Record to remove. |
RemoveAt(Int32)
Not supported because collection is Read-only.
Declaration
public void RemoveAt(int index)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | Record index. |