Class DxGridOptions

Inheritance

System.Object

DxGridOptions

Namespace: Emby.Web.GenericEdit.Elements.DxGrid

Assembly: Emby.Web.GenericEdit.dll

Syntax

public class DxGridOptions

Constructors

DxGridOptions()

Declaration

public DxGridOptions()

DxGridOptions(Object, String, Boolean, Boolean, Boolean, Boolean)

Declaration

public DxGridOptions(object editObject, string keyExpr, bool multiSelect, bool disableColumnChooser, bool showFilterRow, bool showHeaderFilter)

Parameters

Type	Name	Description
System.Object	editObject
System.String	keyExpr
System.Boolean	multiSelect
System.Boolean	disableColumnChooser
System.Boolean	showFilterRow
System.Boolean	showHeaderFilter

Properties

accessKey

Specifies the shortcut key that sets focus on the widget.

Declaration

public string accessKey { get; set; }

Property Value

Type	Description
System.String

activeStateEnabled

Specifies whether or not the widget changes its state when interacting with a user.

Declaration

public bool? activeStateEnabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

allowColumnReordering

Specifies whether a user can reorder columns.Specifies whether a user can reorder columns.

Declaration

public bool? allowColumnReordering { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

allowColumnResizing

Specifies whether a user can resize columns.Specifies whether a user can resize columns.

Declaration

public bool? allowColumnResizing { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

allowMultiRowUpdating

Declaration

public bool? allowMultiRowUpdating { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

autoNavigateToFocusedRow

Automatically scrolls to the focused row when the focusedRowKey is changed.

Declaration

public bool? autoNavigateToFocusedRow { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

cacheEnabled

Specifies whether data should be cached.Specifies whether data should be cached.

Declaration

public bool? cacheEnabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

cellHintEnabled

Enables a hint that appears when a user hovers the mouse pointer over a cell with truncated content.

Declaration

public bool? cellHintEnabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Remarks

The cell's content may be truncated if the width of the cell's column becomes very small. In this case, when a user hovers the mouse pointer over such a cell, a hint containing the cell's value appears. To disable cell hints, assign false to the cellHintEnabled option.

columnAutoWidth

Specifies whether columns should adjust their widths to the content.

Declaration

public bool? columnAutoWidth { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Remarks

When this option is set to true, all columns adjust their width to the content. If the widget's overall content is narrower than the widget's width, the columns are stretched to fit the widget. To avoid this, set the columns.width option to "auto". If the content is wider, the columnAutoWidth option set to true causes horizontal scrolling. You can set the allowHiding option to false for columns you want to be displayed continuously. When the columnAutoWidth option is set to false, all columns have identical width, which in turn depends on the width of the widget.

columnChooser

Configures the column chooser.

Declaration

public DxGridColumnChooser columnChooser { get; set; }

Property Value

Type	Description
DxGridColumnChooser

columnFixing

Declaration

public DxGridColumnFixing columnFixing { get; set; }

Property Value

Type	Description
DxGridColumnFixing

columnHidingEnabled

Specifies whether the widget should hide columns to adapt to the screen or container size. Ignored if allowColumnResizing is true and columnResizingMode is "widget".

Declaration

public bool? columnHidingEnabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Remarks

This option set to true makes the widget hide certain columns automatically if all the columns do not fit the widget's width. Columns with low hidingPriority are hidden first. These are the rightmost (leftmost if rtlEnabled is true) columns by default. Information from hidden columns is available in an adaptive detail row.

columnMinWidth

Specifies the minimum width of columns.

Declaration

public double? columnMinWidth { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>

columnResizingMode

Specifies how the widget resizes columns. Applies only if allowColumnResizing is true.

Declaration

public DxGridOptions.ColumnResizingMode? columnResizingMode { get; set; }

Property Value

Type	Description
System.Nullable<DxGridOptions.ColumnResizingMode>

columns

An array of grid columns.

Declaration

public DxGridColumnList columns { get; set; }

Property Value

Type	Description
DxGridColumnList

Remarks

By default, a column is created for each field of a data source object, but in most cases, it is redundant. To specify a set of columns to be created in a grid, assign an array specifying these columns to the columns option. Each grid column is represented in this array by an object containing column settings or by a data source field that this column is bound to. Detailed information on specifying grid columns is given in the Columns Overview article. Column options define the behavior and appearance of a grid column. One of the other capabilities allows you to control the sorting of column values using the allowSorting and sortOrder options, apply a filter to grid records using the allowFiltering and filterOperations options, and group grid records using the allowGrouping and groupIndex options. In addition, you can change the visibility and width of a column using corresponding options. To get or set an option or several options for a column at runtime, use the columnOption method with the required arguments.

columnWidth

Specifies the width for all data columns. Has a lower priority than the column.width option.

Declaration

public double? columnWidth { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>

dataSource

Binds the widget to data

Declaration

public object[] dataSource { get; set; }

Property Value

Type	Description
System.Object[]

dataSourceSortField

Declaration

public string dataSourceSortField { get; set; }

Property Value

Type	Description
System.String

dateSerializationFormat

Specifies the format in which date-time values should be sent to the server. Use it only if you do not specify the dataSource at design time.

Declaration

public string dateSerializationFormat { get; set; }

Property Value

Type	Description
System.String

Remarks

Without a data source, the widget cannot detect the date-time values' format. In this case, specify the dateSerializationFormat option that supports the following formats: "yyyy-MM-dd" - a local date "yyyy-MM-ddTHH:mm:ss" - local date and time "yyyy-MM-ddTHH:mm:ssZ" - the UTC date and time "yyyy-MM-ddTHH:mm:ssx" - date and time with a timezone This option applies only if the forceIsoDateParsing field is set to true in the global configuration object.

disabled

Specifies whether the widget responds to user interaction.

Declaration

public bool? disabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

editing

Configures editing.

Declaration

public DxGridEditing editing { get; set; }

Property Value

Type	Description
DxGridEditing

Remarks

The widget can allow a user to add, update and delete data. To control which of these operations are allowed, use the allowAdding, allowUpdating and allowDeleting options. Editing can be carried out in different modes, which are detailed in the mode option's description.

errorRowEnabled

Indicates whether to show the error row.

Declaration

public bool? errorRowEnabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Remarks

The error row displays data-related errors that may occur on the server during the widget's runtime. Setting this option to false hides the error row, but the errors can still be viewed in the browser's console.

export

Configures client-side exporting.

Declaration

public DxGridExport export { get; set; }

Property Value

Type	Description
DxGridExport

filterPanel

Configures the filter panel.

Declaration

public DxGridFilterPanel filterPanel { get; set; }

Property Value

Type	Description
DxGridFilterPanel

filterRow

Configures the filter row.

Declaration

public DxGridFilterRow filterRow { get; set; }

Property Value

Type	Description
DxGridFilterRow

filterRowCoverLabel

Declaration

public string filterRowCoverLabel { get; set; }

Property Value

Type	Description
System.String

filterSyncEnabled

Specifies whether to synchronize the filter row, header filter, and filter builder. The synchronized filter expression is stored in the filterValue option.Specifies whether to synchronize the filter row, header filter, and filter builder. The synchronized filter expression is stored in the filterValue option.

Declaration

public string filterSyncEnabled { get; set; }

Property Value

Type	Description
System.String

filterValue

Specifies a filter expression.

Declaration

public object[] filterValue { get; set; }

Property Value

Type	Description
System.Object[]

focusedColumnIndex

The index of the column that contains the focused data cell.

Declaration

public int? focusedColumnIndex { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

focusedRowEnabled

Specifies whether the focused row feature is enabled.

Declaration

public bool? focusedRowEnabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Remarks

When this option is set to true, the following applies: Rows are initially sorted by keys if any field of remoteOperations is true. The row with focusedRowIndex or focusedRowKey is highlighted. When the data row area is focused, this row is focused and the area is scrolled down to it. The onFocusedRowChanging and onFocusedRowChanged functions become active.

focusedRowIndex

Specifies the initially or currently focused grid row's index. Use it when focusedRowEnabled is true.

Declaration

public double? focusedRowIndex { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>

Remarks

The focused row has a key and index on a page. When the pager is used for navigation, the focused row's index persists from page to page but corresponds to a different row with a different key on each page. The default index, -1, means that no row is focused. The focusedRowKey takes precedence over the focusedRowIndex when both are specified.

focusedRowKey

Specifies initially or currently focused grid row's key. Use it when focusedRowEnabled is true.

Declaration

public object focusedRowKey { get; set; }

Property Value

Type	Description
System.Object

Remarks

The focused row has a key and index on a page. When the pager is used for navigation, the focused row's index persists from page to page but corresponds to a different row with a different key on each page. In the DxDataGrid, group rows can also be focused. See the Group Index and Key topic for more information on how group keys are formed.

focusStateEnabled

Specifies whether the widget can be focused using keyboard navigation.

Declaration

public bool? focusStateEnabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

grouping

Configures grouping.

Declaration

public DxGridGrouping grouping { get; set; }

Property Value

Type	Description
DxGridGrouping

groupPanel

Configures the group panel.

Declaration

public object groupPanel { get; set; }

Property Value

Type	Description
System.Object

headerFilter

Configures the header filter feature.

Declaration

public DxGridHeaderFilter headerFilter { get; set; }

Property Value

Type	Description
DxGridHeaderFilter

heightMode

Declaration

public DxGridOptions.GridHeightMode heightMode { get; set; }

Property Value

Type	Description
DxGridOptions.GridHeightMode

highlightChanges

Specifies whether to highlight rows and cells with edited data. repaintChangesOnly should be true.

Declaration

public bool? highlightChanges { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

hint

Specifies text for a hint that appears when a user pauses on the widget.

Declaration

public string hint { get; set; }

Property Value

Type	Description
System.String

hoverStateEnabled

Specifies whether to highlight rows when a user moves the mouse pointer over them.

Declaration

public bool? hoverStateEnabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

keyboardNavigation

Configures keyboard navigation.

Declaration

public object keyboardNavigation { get; set; }

Property Value

Type	Description
System.Object

keyExpr

Specifies the key property (or properties) that provide(s) key values to access data items. Each key value must be unique. This option applies only if data is a simple array.

Declaration

public string keyExpr { get; set; }

Property Value

Type	Description
System.String

loadPanel

Configures the load panel.

Declaration

public object loadPanel { get; set; }

Property Value

Type	Description
System.Object

masterDetail

Allows you to build a master-detail interface in the grid.

Declaration

public DxGridMasterDetail masterDetail { get; set; }

Property Value

Type	Description
DxGridMasterDetail

Remarks

In DxDataGrid, a master-detail interface supplies a usual data row with an expandable section that contains the details on this data row. In that case, the data row is called "master row", while the section is called "detail section". To enable the master-detail interface, assign true to the masterDetail.enabled option. After that, specify the template for detail sections using the masterDetail.template option. Templates allow you to place virtually anything into the detail sections. For example, you can display another DxDataGrid or any other UI widget there. For more information on specifying the template for the detail sections, see the template option description.

noDataText

Specifies text shown when the widget does not display any data.

Declaration

public string noDataText { get; set; }

Property Value

Type	Description
System.String

onChangeCommand

Configures change command.

Declaration

public DxGridOnChangeCommand onChangeCommand { get; set; }

Property Value

Type	Description
DxGridOnChangeCommand

pager

Configures the pager.

Declaration

public object pager { get; set; }

Property Value

Type	Description
System.Object

paging

Configures paging.

Declaration

public DxGridPaging paging { get; set; }

Property Value

Type	Description
DxGridPaging

Remarks

Paging allows the widget to load data in portions instead of loading it simultaneously. To enable paging, set the paging.enabled option to true. Users can switch between pages and change paging settings using the pager or they can scroll the pages. Paging settings apply with any scrolling mode.

remoteOperations

Notifies the DxDataGrid of the server's data processing operations.

Declaration

public object remoteOperations { get; set; }

Property Value

Type	Description
System.Object

renderAsync

Specifies whether to render the filter row, command columns, and columns with showEditorAlways set to true after other elements.

Declaration

public bool? renderAsync { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

repaintChangesOnly

Specifies whether to repaint only those cells whose data changed.

Declaration

public bool? repaintChangesOnly { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

rowAlternationEnabled

Specifies whether rows should be shaded differently.

Declaration

public bool? rowAlternationEnabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

rowDragging

Configures row reordering using drag and drop gestures.

Declaration

public DxGridRowDragging rowDragging { get; set; }

Property Value

Type	Description
DxGridRowDragging

rowTemplate

Declaration

public object rowTemplate { get; set; }

Property Value

Type	Description
System.Object

scrolling

Configures scrolling.

Declaration

public DxGridScrolling scrolling { get; set; }

Property Value

Type	Description
DxGridScrolling

searchPanel

Configures the search panel.

Declaration

public object searchPanel { get; set; }

Property Value

Type	Description
System.Object

selectedRowKeys

Allows you to select rows or determine which rows are selected. Applies only if selection.deferred is false.

Declaration

public object[] selectedRowKeys { get; set; }

Property Value

Type	Description
System.Object[]

selection

Configures runtime selection.

Declaration

public DxGridSelection selection { get; set; }

Property Value

Type	Description
DxGridSelection

Remarks

A user can select rows in a single or multiple mode. In multiple mode, a user can select all rows at once. To disable this feature, assign false to the allowSelectAll. By default, once a user selects a row, the data source is instantly notified about it. This may lower the widget performance if the data source is remote and the user is allowed to select all rows at once. In this case, we recommend making the selection deferred.

selectionFilter

Specifies filters for the rows that must be selected initially. Applies only if selection.deferred is true.

Declaration

public object[] selectionFilter { get; set; }

Property Value

Type	Description
System.Object[]

Remarks

This option also allows you to obtain filter expressions for the currently selected rows. Note that if all records are selected, the selectionFilter value is null. If there are no selected records, the value contains an empty array.

showBorders

Specifies whether the outer borders of the widget are visible.

Declaration

public bool? showBorders { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

showColumnHeaders

Specifies whether column headers are visible.

Declaration

public bool? showColumnHeaders { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

showColumnLines

Specifies whether vertical lines that separate one column from another are visible.

Declaration

public bool? showColumnLines { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

showRowLines

Specifies whether horizontal lines that separate one row from another are visible.

Declaration

public bool? showRowLines { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

sortByGroupSummaryInfo

Allows you to sort groups according to the values of group summary items.

Declaration

public object[] sortByGroupSummaryInfo { get; set; }

Property Value

Type	Description
System.Object[]

sorting

Configures runtime sorting.

Declaration

public DxGridSorting sorting { get; set; }

Property Value

Type	Description
DxGridSorting

stateStoring

Configures state storing.

Declaration

public object stateStoring { get; set; }

Property Value

Type	Description
System.Object

summary

Specifies the options of the grid summary

Declaration

public DxGridSummary summary { get; set; }

Property Value

Type	Description
DxGridSummary

tabIndex

Specifies the number of the element when the Tab key is used for navigating.

Declaration

public double? tabIndex { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>

twoWayBindingEnabled

Specifies whether to enable two-way data binding.

Declaration

public bool? twoWayBindingEnabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Remarks

Two-way data binding ensures that the UI tracks changes made in the data source by a 3rd-party component, and vice versa. This way, the widget and its data source stay synchronized. If you implement two-way data binding in the widget on your own using the cellTemplate and/or editCellTemplate options, make sure to set the twoWayBindingEnabled option to false.

visible

Specifies whether the widget is visible.

Declaration

public bool? visible { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

wordWrapEnabled

Specifies whether text that does not fit into a column should be wrapped.

Declaration

public bool? wordWrapEnabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Extension Methods

Extensions.JsonClone<T>(T, IJsonSerializer)