Class DataContainerListingPage
Listing page for data containers.
public abstract class DataContainerListingPage : ListingPageBase<ListingConfiguration>, IPage- Inheritance
-
objectDataContainerListingPage
- Implements
- Derived
- Inherited Members
- Extension Methods
Constructors
DataContainerListingPage()
protected DataContainerListingPage()Properties
PageConfiguration
Page configuration.
public override ListingConfiguration PageConfiguration { get; set; }Property Value
Methods
GetIdentifier(IDataContainer)
Gets the identifier for listing item.
protected abstract object GetIdentifier(IDataContainer dataContainer)Parameters
dataContainerIDataContainerListing item.
Returns
- object
GetRowsFromData(IEnumerable<IDataContainer>, CancellationToken)
Transforms the result of LoadDataContainers(CancellationToken) with parametrization into a collection of rows for the table of the listing page.
protected Task<IEnumerable<Row>> GetRowsFromData(IEnumerable<IDataContainer> dataContainers, CancellationToken cancellationToken)Parameters
dataContainersIEnumerable<IDataContainer>Data of the rows.
cancellationTokenCancellationTokenCancellation token.
Returns
- Task<IEnumerable<Row>>
LoadData(LoadDataSettings, CancellationToken)
Returns LoadDataResult containing data and the number of total items.
protected override Task<LoadDataResult> LoadData(LoadDataSettings settings, CancellationToken cancellationToken)Parameters
settingsLoadDataSettingsLoad data settings.
cancellationTokenCancellationTokenCancellation token.
Returns
- Task<LoadDataResult>
LoadDataContainers(CancellationToken)
Returns enumeration of IDataContainers.
protected abstract Task<IEnumerable<IDataContainer>> LoadDataContainers(CancellationToken cancellationToken)Parameters
cancellationTokenCancellationTokenCancellation token.
Returns
- Task<IEnumerable<IDataContainer>>
LoadListingDataContainers(ListingDataSettings, CancellationToken)
Loads the listing data (data containers and their total count) described by the settings
from the containers returned by LoadDataContainers(CancellationToken), applying the search, sorting, and paging
in memory.
protected virtual Task<ListingData> LoadListingDataContainers(ListingDataSettings settings, CancellationToken cancellationToken)Parameters
settingsListingDataSettingsDescription of the data to load.
cancellationTokenCancellationTokenCancellation token.
Returns
- Task<ListingData>
Remarks
This is the data primitive of the listing page serving both the table and the export. Unlike LoadData(LoadDataSettings, CancellationToken), which returns the rows of a single table page, this method returns the raw data: the table rows are generated from the paginated data, and the export is built from the first page sized by the export row limit.