Class ListingConfiguration

Namespace

Kentico.Xperience.Admin.Base

Assembly

Kentico.Xperience.Admin.Base.dll

Represents listing template configuration.

public class ListingConfiguration : IRowActionListingConfiguration

Inheritance

object

ListingConfiguration

Implements

IRowActionListingConfiguration

Derived

InfoObjectListingConfiguration

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)

Properties

Callouts

Listing callouts configuration.

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

Property Value

List<CalloutConfiguration>

Caption

Listing template caption.

public string Caption { get; set; }

Property Value

string

ColumnConfigurations

Columns of the listing.

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

Property Value

IList<ColumnConfiguration>

FilterFormModel

Custom model that represents a filter of the listing page.

public object FilterFormModel { get; set; }

Property Value

object

Remarks

Default value is null. Value of null indicates that filtering is not enabled in the listing page.

HeaderActions

Collection of header actions.

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

Property Value

IList<ActionConfiguration>

MassActions

Collection of mass actions displayed in the horizontal action menu.

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

Property Value

IList<ActionConfiguration>

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.

PageSizes

Collection of available page sizes.

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

Property Value

IEnumerable<int>

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 listing is calculated based on the number of registered actions. This property lets you specify custom number for this calculation.

SubcaptionComponent

Configuration of the listing subcaption.

public ISubcaptionComponent SubcaptionComponent { get; set; }

Property Value

ISubcaptionComponent

TableActions

Collection of table actions for each element displayed in listing.

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

Property Value

IList<ActionConfiguration>