Table of Contents

Class DataContainerListingPage

Namespace
Kentico.Xperience.Admin.Base
Assembly
Kentico.Xperience.Admin.Base.dll

Listing page for data containers.

public abstract class DataContainerListingPage : ListingPageBase<ListingConfiguration>, IPage
Inheritance
object
DataContainerListingPage
Implements
Derived
Inherited Members
Extension Methods

Properties

PageConfiguration

Page configuration.

public override ListingConfiguration PageConfiguration { get; set; }

Property Value

ListingConfiguration

Methods

GetIdentifier(IDataContainer)

Gets the identifier for listing item.

protected abstract object GetIdentifier(IDataContainer dataContainer)

Parameters

dataContainer IDataContainer

Listing item.

Returns

object

GetRowsFromData(IEnumerable<IDataContainer>, CancellationToken)

Transform 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

dataContainers IEnumerable<IDataContainer>
cancellationToken CancellationToken

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

settings LoadDataSettings

Load data settings.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<LoadDataResult>

LoadDataContainers(CancellationToken)

Returns enumeration of IDataContainers.

protected abstract Task<IEnumerable<IDataContainer>> LoadDataContainers(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<IEnumerable<IDataContainer>>