Class RecordsList

Class that serves as the base for maintaining the records in the SfDataGrid for different types of source bind to the SfDataGrid.

Inheritance
System.Object
RecordsListBase
RecordsList
PagedCollectionRecordsList
QueryableCollectionRecordsList
Implements
System.Collections.Generic.IList<RecordEntry>
System.Collections.Generic.ICollection<RecordEntry>
System.Collections.Generic.IEnumerable<RecordEntry>
System.Collections.IEnumerable
System.Collections.Specialized.INotifyCollectionChanged
System.IDisposable
Inherited Members
Namespace: Syncfusion.UI.Xaml.Data
Assembly: Syncfusion.Data.WinUI.dll
Syntax
public class RecordsList : RecordsListBase, IRecordsList, IRecordsEntryList, IList<RecordEntry>, ICollection<RecordEntry>, IEnumerable<RecordEntry>, IEnumerable, INotifyCollectionChanged, IDisposable

Constructors

RecordsList()

Initializes a new instance of the RecordsList class.

Declaration
public RecordsList()

RecordsList(CollectionViewAdv)

Initializes a new instance of the RecordsList class.

Declaration
public RecordsList(CollectionViewAdv view)
Parameters
Type Name Description
CollectionViewAdv view

The collection view of the SfDataGrid.

RecordsList(IEnumerable, CollectionViewAdv)

Initializes a new instance of the RecordsList class.

Declaration
public RecordsList(IEnumerable source, CollectionViewAdv view)
Parameters
Type Name Description
System.Collections.IEnumerable source

The IEnumerable source of the SfDataGrid.
CollectionViewAdv view

The collection view of the SfDataGrid.

Fields

EnableHashIndexing

Gets a boolean value indicating whether hash indexing is enabled.

Declaration
public static bool EnableHashIndexing
Field Value
Type
System.Boolean

Properties

TableSummaries

Gets the table summaries of SfDataGrid.

Declaration
public IList<SummaryRecordEntry> TableSummaries { get; }
Property Value
Type Description
System.Collections.Generic.IList<SummaryRecordEntry>

The table summaries of SfDataGrid.

View

Gets the collection view of SfDataGrid.

Declaration
public CollectionViewAdv View { get; }
Property Value
Type Description
CollectionViewAdv

The collection view of SfDataGrid.

Methods

Add(Object)

Adds the specified data to the records list.

Declaration
public override void Add(object data)
Parameters
Type Name Description
System.Object data

The data for which the record is created and added to the records list.
Overrides

CreateRecord(Object)

Creates the record entry for the given data object.

Declaration
public virtual RecordEntry CreateRecord(object data)
Parameters
Type Name Description
System.Object data

The data for which the RecordEntry is to be created.
Returns
Type Description
RecordEntry

Returns the RecordEntry created for the specified data.

Dispose(Boolean)

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration
protected override void Dispose(bool isDisposing)
Parameters
Type Name Description
System.Boolean isDisposing

A boolean value indicating whether both managed and unmanaged resources is to be released.
Overrides

GetItemAt(Int32)

Gets the item at the specified index in the records list.

Declaration
public object GetItemAt(int recordIndex)
Parameters
Type Name Description
System.Int32 recordIndex

The recordIndex to get the object.
Returns
Type Description
System.Object

Returns the object at specified record index.

OnInitialize()

Initializes the internal list and the indices list of the collection view with records of the collection view.

Declaration
protected override void OnInitialize()
Overrides

PopulateRecords(IEnumerable, CollectionViewAdv)

Populates the internalList by enumerating the specified source.

Declaration
protected virtual void PopulateRecords(IEnumerable source, CollectionViewAdv view)
Parameters
Type Name Description
System.Collections.IEnumerable source

The source.
CollectionViewAdv view

The View.
Remarks

The internalList will be populated with null entries in the case of VirtualRecordsList. In case of IQueryable source will be filtered by query. So, there is no need of filter each record while populating.

PopulateRecordsFromGroup(List<Group>)

Populates the internalList by enumerating Group.Records.

Declaration
protected virtual void PopulateRecordsFromGroup(List<Group> groups)
Parameters
Type Name Description
System.Collections.Generic.List<Group> groups

The list of Groups.
Remarks

The internalList will be populated with null entries in the case of VirtualRecordsList. In case of IQueryable source will be filtered by query. So, there is no need of filter each record while populating.

RemoveAll()

Dispose all items from the System.Collections.Generic.ICollection<>.

Declaration
public virtual void RemoveAll()

RemoveNotifyListener()

Removes the notify listener for the collection view of the records list.

Declaration
public void RemoveNotifyListener()

Implements

System.Collections.Generic.IList<>
System.Collections.Generic.ICollection<>
System.Collections.Generic.IEnumerable<>
System.Collections.IEnumerable
System.Collections.Specialized.INotifyCollectionChanged
System.IDisposable