Class DxGridColumn

Inheritance
System.Object
DxGridColumn
Namespace: Emby.Web.GenericEdit.Elements.DxGrid
Assembly: Emby.Web.GenericEdit.dll
Syntax
public class DxGridColumn

Properties

alignment

Aligns the content of the column.

Declaration
public DxGridColumn.Alignment? alignment { get; set; }
Property Value
Type Description
System.Nullable<DxGridColumn.Alignment>

allowEditing

Specifies whether a user can edit values in the column at runtime. By default, inherits the value of the editing.allowUpdating option.

Declaration
public bool? allowEditing { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

allowExporting

Specifies whether data from this column should be exported. Applies only if the column is visible.

Declaration
public bool? allowExporting { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

allowFiltering

Specifies whether data can be filtered by this column. Applies only if filterRow.visible is true.

Declaration
public bool? allowFiltering { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

allowFixing

Specifies whether a user can fix the column at runtime. Applies only if columnFixing.enabled is true.

Declaration
public bool? allowFixing { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

allowGrouping

Specifies whether the user can group data by values of this column. Applies only when grouping is enabled.

Declaration
public bool? allowGrouping { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>
Remarks

When grouping is enabled in the widget, the user can group data by values of any column. To prohibit a particular column from being used for grouping, set the allowGrouping option of this column to false.

allowHeaderFiltering

Specifies whether the header filter can be used to filter data by this column. Applies only if headerFilter.visible is true. By default, inherits the value of the allowFiltering option.

Declaration
public bool? allowHeaderFiltering { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

allowHiding

Specifies whether a user can hide the column using the column chooser at runtime. Applies only if columnChooser.enabled is true.

Declaration
public bool? allowHiding { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

allowReordering

Specifies whether this column can be used in column reordering at runtime. Applies only if allowColumnReordering is true.

Declaration
public bool? allowReordering { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

allowResizing

Specifies whether a user can resize the column at runtime. Applies only if allowColumnResizing is true.

Declaration
public bool? allowResizing { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

allowSearch

Specifies whether this column can be searched. Applies only if searchPanel.visible is true. Inherits the value of the allowFiltering option by default.

Declaration
public bool? allowSearch { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

allowSorting

Specifies whether a user can sort rows by this column at runtime. Applies only if sorting.mode differs from "none".

Declaration
public bool? allowSorting { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

autoExpandGroup

Specifies whether groups appear expanded or not when records are grouped by a specific column. Setting this option makes sense only when grouping is allowed for this column.

Declaration
public bool? autoExpandGroup { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

buttons

Allows you to customize buttons in the editing column or create a custom command column. Applies only if the column's type is "buttons".

Declaration
public DxGridButton[] buttons { get; set; }
Property Value
Type Description
DxGridButton[]

caption

Specifies a caption for the column.

Declaration
public string caption { get; set; }
Property Value
Type Description
System.String
Remarks

Use this option to display a descriptive or friendly name for the column. If this option is not set, the caption will be generated from the name of the dataField.

cellTemplate

Specifies a custom template for data cells.

Declaration
public string cellTemplate { get; set; }
Property Value
Type Description
System.String

columns

An array of grid columns.

Declaration
public DxGridColumn[] columns { get; set; }
Property Value
Type Description
DxGridColumn[]
Remarks

Unlike normal columns, band columns do not hold data. Instead, they collect two or more columns under one column header. To set up this layout, declare the band column using a hierarchical structure. For this, assign the nested columns to the columns field of the band column. For example, the following code declares the "Address" band column and nests three columns within it.

cssClass

Specifies a CSS class to be applied to the column.

Declaration
public string cssClass { get; set; }
Property Value
Type Description
System.String

dataField

Binds the column to a field of the dataSource.

Declaration
public string dataField { get; set; }
Property Value
Type Description
System.String

dataType

Casts column values to a specific data type.

Declaration
public DxGridColumn.ColumnDataType? dataType { get; set; }
Property Value
Type Description
System.Nullable<DxGridColumn.ColumnDataType>
Remarks

If a data field provides values of one data type, but the widget should cast them to another, specify the proper type in this option.

editCellTemplate

Specifies a custom template for data cells in editing state.

Declaration
public string editCellTemplate { get; set; }
Property Value
Type Description
System.String

editorOptions

Configures the default widget used for editing and filtering in the filter row.

Declaration
public object editorOptions { get; set; }
Property Value
Type Description
System.Object

encodeHtml

Specifies whether HTML tags are displayed as plain text or applied to the values of the column.

Declaration
public bool? encodeHtml { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>
Remarks

When true, HTML tags are displayed as plain text; when false, they are applied to the values of the column.

falseText

In a boolean column, replaces all false items with a specified text. Applies only if showEditorAlways option is false.

Declaration
public string falseText { get; set; }
Property Value
Type Description
System.String

filterOperations

Specifies a set of available filter operations. Applies only if filterRow.visible and allowFiltering are true

Declaration
public string[] filterOperations { get; set; }
Property Value
Type Description
System.String[]
Remarks

The following table lists available filters by data types. The same filters are assigned to columns of a specific data type by default. dataType filterOperations "string" [ "contains", "notcontains", "startswith", "endswith", "=", "<>" ] "numeric" [ "=", "<>", "<", ">", "<=", ">=", "between" ] "date" [ "=", "<>", "<", ">", "<=", ">=", "between" ] The filterOperations option can also accept an empty array. In this case, the selected filter operation is "=" for all data types, and a user cannot change it.

filterType

Specifies whether a user changes the current filter by including (selecting) or excluding (clearing the selection of) values. Applies only if headerFilter.visible and allowHeaderFiltering are true.

Declaration
public DxGridColumn.HeaderFilterType? filterType { get; set; }
Property Value
Type Description
System.Nullable<DxGridColumn.HeaderFilterType>
Remarks

This option changes when the user clicks the Select All checkbox in the header filter:

Select All filterType / filterValues
filterType: "include"
filterValues: null
filterType: "exclude"
filterValues: null

filterValue

Specifies the column's filter value displayed in the filter row.

Declaration
public object filterValue { get; set; }
Property Value
Type Description
System.Object

filterValues

Specifies values selected in the column's header filter.

Declaration
public object[] filterValues { get; set; }
Property Value
Type Description
System.Object[]

fixed

Fixes the column.

Declaration
public bool? fixed { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

fixedPosition

Specifies the widget's edge to which the column is fixed. Applies only if columns[].fixed is true.

Declaration
public DxGridColumn.FixedPositionType? fixedPosition { get; set; }
Property Value
Type Description
System.Nullable<DxGridColumn.FixedPositionType>

format

Formats a value before it is displayed in a column cell.

Declaration
public DxGridColumnFormat format { get; set; }
Property Value
Type Description
DxGridColumnFormat

groupCellTemplate

Specifies a custom template for group cells (group rows).

Declaration
public string groupCellTemplate { get; set; }
Property Value
Type Description
System.String

groupIndex

Specifies the index of a column when grid records are grouped by the values of this column.

Declaration
public double? groupIndex { get; set; }
Property Value
Type Description
System.Nullable<System.Double>
Remarks

At runtime, the user can group grid records using the context menu or the group panel. But there may be cases when grid records must be grouped initially. To do this, assign an integer value to the groupIndex option of those columns that should be used for grouping grid records. For example, consider the following data source.

headerCellTemplate

Specifies a custom template for column headers.

Declaration
public string headerCellTemplate { get; set; }
Property Value
Type Description
System.String

headerFilter

Specifies data settings for the header filter.

Declaration
public object headerFilter { get; set; }
Property Value
Type Description
System.Object

hidingPriority

Specifies the order in which columns are hidden when the widget adapts to the screen or container size. Ignored if allowColumnResizing is true and columnResizingMode is "widget".

Declaration
public double? hidingPriority { get; set; }
Property Value
Type Description
System.Nullable<System.Double>
Remarks

The hidingPriority is a unique positive integer that ascends from right to left beginning with 0 by default. Columns with low hidingPriority are hidden first.

isBand

Specifies whether the column bands other columns or not.

Declaration
public bool? isBand { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>
Remarks

Unlike normal columns, band columns do not hold data. Instead, they collect two or more columns under one column header. In most cases, to set up this layout, you can declare the band column using a hierarchical structure. For example, the following code bands three columns under the "Address" header.

isSecondaryGridDataSource

Specifies whether the column should be used as a data source for a secondary grid.

Declaration
public bool? isSecondaryGridDataSource { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

lookup

Specifies options of a lookup column.

Declaration
public DxGridLookup lookup { get; set; }
Property Value
Type Description
DxGridLookup
Remarks

A lookup column restricts the set of values that can be chosen when a user edits or filters the column. In a lookup column, each cell is a drop-down menu. You can use a lookup column when you need to substitute displayed values with required values. For example, consider that you have two arrays of objects: drivers and buses.

minWidth

Specifies the minimum width of the column.

Declaration
public int? minWidth { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

name

Specifies the identifier of the column.

Declaration
public string name { get; set; }
Property Value
Type Description
System.String
Remarks

Set this option if you need to refer to the column in your code afterwards, for example, when changing a column option.

ownerBand

Specifies the band column that owns the current column. Accepts the index of the band column in the columns array.

Declaration
public double? ownerBand { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

renderAsync

Specifies whether to render the column after other columns and elements. Use if column cells have a complex template. Requires the width option specified.

Declaration
public bool? renderAsync { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

selectedFilterOperation

Specifies the column's filter operation displayed in the filter row.

Declaration
public string selectedFilterOperation { get; set; }
Property Value
Type Description
System.String
Remarks
Accepted Values: '<' '<=' '<>' '=' '>' '>=' 'between' 'contains' 'endswith'

showEditorAlways

Specifies whether the column displays its values using editors.

Declaration
public bool? showEditorAlways { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>
Remarks

A column cell has normal and editing states. In a normal state, the cell value is text. In the editing state, the cell contains an editor that indicates the cell value and allows a user to edit it. In certain cases, a viewer reads the cell value easier if it is indicated by an editor even in the normal state. For example, boolean values are more comprehensible when they are indicated by check boxes. To display editors in cells permanently, set the showEditorAlways option to true.

showInColumnChooser

Specifies whether the column chooser can contain the column header.

Declaration
public bool? showInColumnChooser { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

showWhenGrouped

Specifies whether or not to display the column when grid records are grouped by it.

Declaration
public bool? showWhenGrouped { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>
Remarks

Displaying a grouping column may be useful if you calculate its grouping values. Consider that you need to group records by a column that contains dates. Grouping by full dates seems inconvenient. It would be smarter to group by months or years instead. For this purpose, you calculate grouping values within the calculateGroupValue function and leave the grouping column visible by setting the showWhenGrouped option to true so that the user can view the full dates.

sortIndex

Specifies the index according to which columns participate in sorting.

Declaration
public double? sortIndex { get; set; }
Property Value
Type Description
System.Nullable<System.Double>
Remarks

This option accepts an integer specifying the index of the column in a collection of columns with applied sorting. For example, consider the following data source that can provide data for three columns.

sortOrder

Specifies the sort order of column values.

Declaration
public string sortOrder { get; set; }
Property Value
Type Description
System.String
Remarks

Accepted Values: undefined | 'asc' | 'desc'

trueText

In a boolean column, replaces all true items with a specified text. Applies only if showEditorAlways option is false.

Declaration
public string trueText { get; set; }
Property Value
Type Description
System.String

type

Specifies the command column that this object customizes.

Declaration
public string type { get; set; }
Property Value
Type Description
System.String

validationRules

Specifies validation rules to be checked when cell values are updated.

Declaration
public DxGridValidationRuleBase[] validationRules { get; set; }
Property Value
Type Description
DxGridValidationRuleBase[]

The validation rules.

visible

Specifies whether the column is visible, that is, occupies space in the table.

Declaration
public bool? visible { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

visibleIndex

Specifies the position of the column regarding other columns in the resulting widget.

Declaration
public int? visibleIndex { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

width

Specifies the column's width in pixels or as a percentage. Ignored if it is less than minWidth.

Declaration
public int? width { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

Methods

AddValidationRule(DxGridValidationRuleBase)

Declaration
public void AddValidationRule(DxGridValidationRuleBase validationRule)
Parameters
Type Name Description
DxGridValidationRuleBase validationRule

Extension Methods