Class ColumnConfigurationExtensions

Namespace

Kentico.Xperience.Admin.Base

Assembly

Kentico.Xperience.Admin.Base.dll

Contains extension methods for ColumnConfiguration collection.

public static class ColumnConfigurationExtensions

Inheritance

object

ColumnConfigurationExtensions

Methods

AddColumn(IList<ColumnConfiguration>, string, string, bool, int, int, bool, bool, bool, SortTypeEnum?, Func<object, IDataContainer, string>)

Adds the column to the collection.

public static IList<ColumnConfiguration> AddColumn(this IList<ColumnConfiguration> configuration, string name, string caption = null, bool visible = true, int minWidth = 8, int maxWidth = 100, bool searchable = false, bool localizable = false, bool sortable = true, SortTypeEnum? defaultSortDirection = null, Func<object, IDataContainer, string> formatter = null)

Parameters

configuration IList<ColumnConfiguration>

Configuration collection.

name string

Column name.

caption string

Caption.

visible bool

Indicates whether column is visible.

minWidth int

Indicates minimal width of the column.

maxWidth int

Indicates maximal width of the column.

searchable bool

Indicates whether column is searchable.

localizable bool

Indicates whether column value should be processed with localization macro resolver.

sortable bool

Indicates whether column is sortable.

defaultSortDirection SortTypeEnum?

Default sort direction.

formatter Func<object, IDataContainer, string>

Column value formatter.

Returns

IList<ColumnConfiguration>

Remarks

If the corresponding column's type is System.DateTime or System.Nullable<System.DateTime> the system ensures that Date and Time is transferred to the client along with a time zone information. However, if formatter parameter is specified at the same time, the system assumes an intention that the column value should be formatted as a string.

AddComponentColumn(IList<ColumnConfiguration>, string, string, string, bool, int, int, bool, bool, bool, bool, SortTypeEnum?, Func<object, IDataContainer, string>, Func<object, IDataContainer, object>)

Adds the column with named component to the collection.

public static IList<ColumnConfiguration> AddComponentColumn(this IList<ColumnConfiguration> configuration, string columnName, string componentKey, string caption = null, bool visible = true, int minWidth = 8, int maxWidth = 100, bool searchable = false, bool localizable = false, bool sortable = true, bool loadedExternally = false, SortTypeEnum? defaultSortDirection = null, Func<object, IDataContainer, string> formatter = null, Func<object, IDataContainer, object> modelRetriever = null)

Parameters

configuration IList<ColumnConfiguration>

Configuration collection.

columnName string

Column name.

componentKey string

Name of a front-end component.

caption string

Caption.

visible bool

Indicates whether column is visible.

minWidth int

Indicates minimal width of the column.

maxWidth int

Indicates maximal width of the column.

searchable bool

Indicates whether column is searchable.

localizable bool

Indicates whether column value should be processed with localization macro resolver.

sortable bool

Indicates whether column is sortable.

loadedExternally bool

Indicates whether column is loaded by custom logic.

defaultSortDirection SortTypeEnum?

Default sort direction.

formatter Func<object, IDataContainer, string>

Column value formatter.

modelRetriever Func<object, IDataContainer, object>

Function allowing to create client component model.

Returns

IList<ColumnConfiguration>

LocalizeColumns(IList<ColumnConfiguration>, string, ILocalizationService)

Localizes columns without caption based on resourceKeyPrefix and Name.

[Obsolete("The method will be removed in the next major version. Use ILocalizationService.GetString and full resource key in columns definition.")]
[ObsoleteSince(26, 2)]
public static void LocalizeColumns(this IList<ColumnConfiguration> configuration, string resourceKeyPrefix, ILocalizationService localizationService)

Parameters

configuration IList<ColumnConfiguration>

Configuration collection.

resourceKeyPrefix string

Resource key prefix.

localizationService ILocalizationService

Localization service.