Class TableConfiguration

Namespace

Kentico.Xperience.Admin.Base

Assembly

Kentico.Xperience.Admin.Base.dll

Represents table configuration.

public sealed class TableConfiguration : IRowActionListingConfiguration

Inheritance

object

TableConfiguration

Implements

IRowActionListingConfiguration

Extension Methods

RowActionListingConfigurationExtensions.AddCommandRowAction(IRowActionListingConfiguration, string)

RowActionListingConfigurationExtensions.AddEditRowAction<TEditPage>(IRowActionListingConfiguration, Action<ActionConfiguration, IDataContainer>, PageParameterValues)

RowActionListingConfigurationExtensions.AddEditRowAction<TEditPage>(IRowActionListingConfiguration, Action<ActionConfiguration, IDataContainer>, params string[])

WorkspaceRowActionListingConfigurationExtensions.AddEditRowAction<TEditPage>(IRowActionListingConfiguration, int, Action<ActionConfiguration, IDataContainer>, PageParameterValues)

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

TableConfiguration(string, string)

Initializes a new instance of the TableConfiguration class.

public TableConfiguration(string objectType, string loadDataCommandName)

Parameters

objectType string

Object type of items displayed in the table.

loadDataCommandName string

Name of page command responsible for loading table rows.

Properties

Caption

Table caption.

public string Caption { get; set; }

Property Value

string

ColumnConfigurations

Columns of the table.

public IList<ColumnConfiguration> ColumnConfigurations { get; set; }

Property Value

IList<ColumnConfiguration>

HeaderActions

Collection of header actions.

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

Property Value

IList<ActionConfiguration>

LoadDataCommandName

Name of page command responsible for loading table rows.

public string LoadDataCommandName { get; }

Property Value

string

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

Remarks

Default maximum number of visible actions is 3.

ObjectType

Object type of items displayed in the table.

public string ObjectType { get; }

Property Value

string

PageSizes

Collection of available page sizes.

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

Property Value

IEnumerable<int>

QueryModifiers

Collection of modifiers affecting the final query.

public IList<QueryModifier> QueryModifiers { get; set; }

Property Value

IList<QueryModifier>

RowAction

Action for each row displayed in the table.

public ActionConfiguration RowAction { get; set; }

Property Value

ActionConfiguration

RowActionIconPlaceholders

Allows to override the number of action icon placeholders to customize the actions column width.

public int? RowActionIconPlaceholders { get; set; }

Property Value

int?

Remarks

Default value is null. If null, the width of actions column in table is calculated based on the number of registered actions. This property lets you specify custom number for this calculation.

TableActions

Collection of table actions for each element displayed in the table.

public IList<ActionConfiguration> TableActions { get; set; }

Property Value

IList<ActionConfiguration>

UsePagination

Allow pagination.

public bool UsePagination { get; set; }

Property Value

bool