Class PrimaryKeySortedRecordsCollection

A collection of primaryKeySorted 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 datasource using the IndexOf(String) method.

An instance of this collection is returned by the PrimaryKeySortedRecords property of a Table object.

Inheritance
System.Object
PrimaryKeySortedRecordsCollection
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 PrimaryKeySortedRecordsCollection : 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).

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 whether the collection of rows is synchronized or not.

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

Item[Int32]

Gets 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

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

Item[String]

Searches for the first occurrence of a record that matches the sort-key and returns the record found or NULL if not found.

Declaration
public Record this[string sortKey] { get; }
Parameters
Type Name Description
System.String sortKey

The sort key to search for. The sortKey will be compared to the sorted field in the table as specified with SortedColumns.
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

Record to add.
Returns
Type Description
System.Int32

Returns Index.

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

Contains(String)

Determines if a record exists in the collection that matches the sort-key.

Declaration
public bool Contains(string sortKey)
Parameters
Type Name Description
System.String sortKey

The sort key to search for. The sortKey will be compared to the sorted field in the table as specified with SortedColumns.
Returns
Type Description
System.Boolean

true if [contains] [the specified sort key]; 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 the object and releases internal objects.

Declaration
public void Dispose()

FindRecord(Object)

Searches for the first occurrence of a record that matches the specified sort-key and returns the zero-based index of the first occurrence found or -1 if not found.

Declaration
public int FindRecord(object sortKey)
Parameters
Type Name Description
System.Object sortKey

The sort key to search for. The object will be compared to the sorted fields in the table as specified with SortedColumns.
Returns
Type Description
System.Int32

Record 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, Boolean).

FindRecord(Object[])

Searches for the first occurrence of a record that matches the specified sort-key and returns the zero-based index of the first occurrence found or -1 if not found.

Declaration
public int FindRecord(params object[] sortKeys)
Parameters
Type Name Description
System.Object[] sortKeys

The sort keys to search for. The object will be compared to the sorted fields in the table as specified with SortedColumns. The sortKeys must have the same order of fields as the SortedColumns collection.
Returns
Type Description
System.Int32

Record 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, Boolean).

Examples
product21.ParentTable.TableDescriptor.PrimaryKeyColumns.Add("ProductName");
product21.ParentTable.TableDescriptor.PrimaryKeyColumns.Add("SupplierID");
int sp = product21.PrimaryKeySortedRecords.FindRecord("Spegesild", "21");
product21.Records["Spegesild"].SetCurrent();
product21.ParentTable.TableDescriptor.PrimaryKeyColumns.Add("ProductName")
product21.ParentTable.TableDescriptor.PrimaryKeyColumns.Add("SupplierID")
Dim sp As Integer = product21.PrimaryKeySortedRecords.FindRecord("Spegesild", "21")
product21.Records("Spegesild").SetCurrent()

FixPrimaryKeyPosition(Record)

Fixes the primary key sort position of the record after the value was changed.

Declaration
public void FixPrimaryKeyPosition(Record r)
Parameters
Type Name Description
Record r

The Record.

GetEnumerator()

Returns an enumerator for the entire collection.

Declaration
public PrimaryKeySortedRecordsCollectionEnumerator GetEnumerator()
Returns
Type Description
PrimaryKeySortedRecordsCollectionEnumerator

An Enumerator for the entire collection.
Remarks

Enumerators only allow reading of 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).

IndexOf(String)

Searches for the first occurrence of a record that matches the sort-key and returns the zero-based index of the first occurrence found or -1 if not found.

Declaration
public int IndexOf(string sortKey)
Parameters
Type Name Description
System.String sortKey

The sort key to search for. The sortKey will be compared to the sorted field in the table as specified with SortedColumns.
Returns
Type Description
System.Int32

Returns first occurrence of a 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).

Remove(Record)

Removes the record from primary keys tree.

Declaration
public void Remove(Record r)
Parameters
Type Name Description
Record r

Record to remove.

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

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

ICollection.SyncRoot

Returns whether collection of rows can be synchronized.

Declaration
object ICollection.SyncRoot { get; }
Returns
Type
System.Object

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.Add(Object)

Adds the value to the collection.

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

The value in the list.
Returns
Type
System.Int32
Exceptions
Type Condition
System.InvalidOperationException

Collection is Read-only.

IList.Clear()

Clears the Collection.

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

Collection is Read-only.

IList.Contains(Object)

Checks whether the value is in the collection or not.

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

The value of an record in the list.
Returns
Type
System.Boolean

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)

Returns the index of value from the collection.

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

The value of an element in the list.
Returns
Type
System.Int32

IList.Insert(Int32, Object)

Inserts the value at the specified index.

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

The index of the list.
System.Object value

The value of an element in the list.
Exceptions
Type Condition
System.InvalidOperationException

Collection is Read-only.

IList.Item[Int32]

Gets or sets the current index in an collection.

Declaration
object IList.this[] { get; set; }
Parameters
Type Name Description
System.Int32 index

The index of current element in an collection.
Returns
Type Description
System.Object

Returns the selected cells information at the specified index.
Exceptions
Type Condition
System.InvalidOperationException

Since Collection is read only, index value cannot be set.

IList.Remove(Object)

Removes the value passed from the collection.

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

The value of an element in the list.
Exceptions
Type Condition
System.InvalidOperationException

Collection is Read-only.

IList.RemoveAt(Int32)

Removes the value at specified index of the collection.

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

The index of 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.Collections.IList
System.Collections.ICollection
System.Collections.IEnumerable
System.IDisposable

Extension Methods