Table of Contents

Class ListingTemplateClientProperties

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

Represents listing data.

public class ListingTemplateClientProperties : TemplateClientProperties, ITableClientProperties
Inheritance
object
ListingTemplateClientProperties
Implements
Derived
Inherited Members
Extension Methods

Constructors

ListingTemplateClientProperties() 

public ListingTemplateClientProperties()

Properties

Callouts

Listing callouts configuration.

public ICollection<CalloutConfiguration> Callouts { get; set; }

Property Value

ICollection<CalloutConfiguration>

Caption

Listing caption.

public string Caption { get; set; }

Property Value

string

Columns

Columns of the listing.

public IList<Column> Columns { get; set; }

Property Value

IList<Column>

ExportAction

Configuration of the listing export action. null when the export action is not configured.

public ListingExportActionClientProperties ExportAction { get; set; }

Property Value

ListingExportActionClientProperties

Remarks

This API supports the framework infrastructure and is not intended to be used directly from your code.

FilterFormComponents

Collection of form components used in the filter form.

public ICollection<IFormComponentClientProperties> FilterFormComponents { get; set; }

Property Value

ICollection<IFormComponentClientProperties>

FilterFormComponentsMetadata

Mapping of filter form components to their metadata.

public IDictionary<string, FilterFormComponentMetadata> FilterFormComponentsMetadata { get; set; }

Property Value

IDictionary<string, FilterFormComponentMetadata>

FilterInitialValues

Filter values to apply on a first load when no saved state exists.

public IDictionary<string, object> FilterInitialValues { get; set; }

Property Value

IDictionary<string, object>

HeaderActions

List of header actions.

public IList<Action> HeaderActions { get; set; }

Property Value

IList<Action>

MassActions

Collection of mass actions displayed in the horizontal action menu.

public IList<Action> MassActions { get; set; }

Property Value

IList<Action>

MaxVisibleRowActions

Determines maximum number of visible row actions. If row has more actions they are grouped under a select menu.

public int MaxVisibleRowActions { get; set; }

Property Value

int

PageSize

Selected page size.

public int PageSize { get; set; }

Property Value

int

PageSizes

List of available page sizes.

public IEnumerable<int> PageSizes { get; set; }

Property Value

IEnumerable<int>

PageSizesLabel

Localized label of listing page size selection.

public string PageSizesLabel { get; set; }

Property Value

string

SortBy

Gets or sets the column data are sorted by.

public string SortBy { get; set; }

Property Value

string

SortType

Gets or sets the direction data are sorted by.

public SortTypeEnum? SortType { get; set; }

Property Value

SortTypeEnum?

SubcaptionComponent

Configuration of the listing subcaption.

public SubcaptionComponentClientProperties SubcaptionComponent { get; set; }

Property Value

SubcaptionComponentClientProperties

UniqueIdentifier

Unique name of the page. The name is utilized for identifying the listing state in the memory.

public string UniqueIdentifier { get; set; }

Property Value

string