Table of Contents

Class ListingDataSettings

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

Describes the listing data to load: the listing state (paging, sorting, searching, filtering), the columns to retrieve, and whether the data is paginated.

public sealed class ListingDataSettings
Inheritance
object
ListingDataSettings
Extension Methods

Constructors

ListingDataSettings(LoadDataSettings, IList<ColumnConfiguration>)

Initializes a new instance of the ListingDataSettings class.

public ListingDataSettings(LoadDataSettings loadSettings, IList<ColumnConfiguration> columns)

Parameters

loadSettings LoadDataSettings

Listing state the data corresponds to.

columns IList<ColumnConfiguration>

Columns to retrieve.

Exceptions

ArgumentNullException

Thrown when loadSettings or columns is null.

Properties

Columns

Columns to retrieve.

public IList<ColumnConfiguration> Columns { get; }

Property Value

IList<ColumnConfiguration>

LoadSettings

Listing state (paging, sorting, searching, filtering) the data corresponds to.

public LoadDataSettings LoadSettings { get; }

Property Value

LoadDataSettings

UsePagination

Indicates whether the data is paginated according to LoadSettings. Defaults to true. When false, all the matching rows are retrieved.

public bool UsePagination { get; init; }

Property Value

bool

Remarks

A caller that needs an upper bound on the number of retrieved rows rather than a table page requests the first page of the limiting size, i.e. keeps the pagination enabled and passes a LoadSettings with SelectedPage 0 and the limit as PageSize. TotalCount then still reports the number of all the matching rows, so that exceeding the limit can be detected.