Class LoadDataSettings

Namespace

Kentico.Xperience.Admin.Base

Assembly

Kentico.Xperience.Admin.Base.dll

Encapsulates table settings used as parameters for loading data (paging, sorting, searching, filtering).

public sealed class LoadDataSettings

Inheritance

object

LoadDataSettings

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

LoadDataSettings(int, int, string, SortTypeEnum, string, IWhereCondition)

Initializes a new instance of LoadDataSettings.

public LoadDataSettings(int pageSize, int selectedPage, string sortBy, SortTypeEnum sortType, string searchTerm, IWhereCondition filterWhereCondition = null)

Parameters

pageSize int

Size of the page.

selectedPage int

Number of selected page.

sortBy string

Name of the property to sort by.

sortType SortTypeEnum

Type of the sorting.

searchTerm string

Value to filter by.

filterWhereCondition IWhereCondition

WHERE condition to filter by.

Properties

FilterWhereCondition

Represents a WHERE condition to be applied on data query to restrict listing data according to filtering criteria. The condition is constructed from a filter model of PageConfiguration.

public IWhereCondition FilterWhereCondition { get; }

Property Value

IWhereCondition

PageSize

Gets size of the page.

public int PageSize { get; }

Property Value

int

SearchTerm

The value by which elements are filtered.

public string SearchTerm { get; }

Property Value

string

SelectedPage

Gets the number of selected page.

public int SelectedPage { get; }

Property Value

int

SortBy

Name of the property that elements are sorted by.

public string SortBy { get; }

Property Value

string

SortType

The order of the sorting.

public SortTypeEnum SortType { get; }

Property Value

SortTypeEnum

See Also

LoadData(LoadDataSettings, CancellationToken)