Table of Contents

Class ListingExportCommandArguments

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

Command arguments sent by the client when the listing export action is triggered.

public sealed class ListingExportCommandArguments
Inheritance
object
ListingExportCommandArguments
Extension Methods

Remarks

Carries the same sorting, searching, and filtering context that is currently applied to the listing table, so the export command can produce a data set consistent with what the user currently sees.

Constructors

ListingExportCommandArguments() 

public ListingExportCommandArguments()

Properties

ColumnNames

Names of the exportable columns selected by the user to be included in the exported file. An export request without any selected column is rejected.

public IReadOnlyList<string> ColumnNames { get; set; }

Property Value

IReadOnlyList<string>

FilterFormValues

Current values of the listing filter form.

public Dictionary<string, JsonElement> FilterFormValues { get; set; }

Property Value

Dictionary<string, JsonElement>

SearchTerm

Current search term.

public string SearchTerm { get; set; }

Property Value

string

SortBy

Name of the column data are currently sorted by.

public string SortBy { get; set; }

Property Value

string

SortType

Direction data are currently sorted by.

public SortTypeEnum? SortType { get; set; }

Property Value

SortTypeEnum?

TimeZone

IANA identifier of the client's time zone (e.g. "Europe/Prague"). Date and time values are exported converted to this time zone, so that they correspond to the values displayed in the listing table. When null or not resolvable, the values are exported in the server's time zone.

public string TimeZone { get; set; }

Property Value

string