Emby.Client.GenericEdit

Gets the content of an enum member's , or its name in case there is none.

The enum value.

Indicates whether the current object is equal to another object of the same type.

An object to compare with this object. true if the current object is equal to the other parameter; otherwise, false.

Determines whether the specified object is equal to the current object.

The object to compare with the current object. true if the specified object is equal to the current object; otherwise, false.

Serves as the default hash function.

A hash code for the current object.

Returns a value that indicates whether the values of two objects are equal.

The first value to compare. The second value to compare. true if the and parameters have the same value; otherwise, false.

Returns a value that indicates whether two objects have different values.

The first value to compare. The second value to compare. true if and are not equal; otherwise, false.

Indicates whether the current object is equal to another object of the same type.

An object to compare with this object. true if the current object is equal to the other parameter; otherwise, false.

Determines whether the specified object is equal to the current object.

The object to compare with the current object. true if the specified object is equal to the current object; otherwise, false.

Serves as the default hash function.

A hash code for the current object.

Returns a value that indicates whether the values of two objects are equal.

The first value to compare. The second value to compare. true if the and parameters have the same value; otherwise, false.

Returns a value that indicates whether two objects have different values.

The first value to compare. The second value to compare. true if and are not equal; otherwise, false.

Initializes a new instance of the class.

Gets the simple condition.

The simple condition.

Gets the target property name or path.

The target property name or path.

Gets the simple condition.

The simple condition.

Gets the value condition.

The value condition.

Gets the value.

The value.

Gets the editor title.

The editor title.

Gets the editor description.

The editor description.

Gets the title button.

The title button.

Returns an enumerator that iterates through the collection.

An enumerator that can be used to iterate through the collection.

Returns an enumerator that iterates through the collection.

An enumerator that can be used to iterate through the collection.

Initializes a new instance of the class.

The edit object. The default object. The editor root.

Initializes a new instance of the class.

The name. The parent identifier.

Gets or sets a value indicating whether [allow empty].

true if [allow empty]; otherwise, false.

Initializes a new instance of the class.

The button items. The name. The parent identifier.

Gets or sets the editor items.

The editor items.

Initializes a new instance of the class.

The name. The parent identifier.

Initializes a new instance of the class.

The name. The parent identifier.

Initializes a new instance of the class.

The name. The parent identifier.

Gets or sets the minimum value.

The minimum value.

Gets or sets the maximum value.

The maximum value.

Initializes a new instance of the class.

The name. The parent identifier. if set to true [double pane grid]. The data source identifier. The data source2 identifier. The selection source identifier. The filter source identifier. The datafilter source identifier.

Initializes a new instance of the class.

The name. The parent identifier.

Initializes a new instance of the class.

The name. The parent identifier.

Initializes a new instance of the class.

The title. The editor items. The name. The parent identifier. The title button.

Initializes a new instance of the class.

The name. The parent identifier.

Initializes a new instance of the class.

The name. The parent identifier.

Initializes a new instance of the class.

The name. The parent identifier.

Initializes a new instance of the class.

The name. The parent identifier.

Initializes a new instance of the class.

The name. The parent identifier.

Initializes a new instance of the class.

The radio options. The name. The parent identifier. The items source identifier.

Initializes a new instance of the class.

The title. The editor items. The property conditions. The postback actions. The title button.

Initializes a new instance of the class.

The name. The parent identifier. Type of the element. The select options. The static items source identifier. The items source identifier.

Initializes a new instance of the class.

The select options. The name. The parent identifier. The static items source identifier. The items source identifier.

Initializes a new instance of the class.

The select options. The name. The parent identifier. The static items source identifier. The items source identifier. if set to true [show as radio].

Initializes a new instance of the class.

The name. The parent identifier.

Initializes a new instance of the class.

The name. The parent identifier.

Initializes a new instance of the class.

The name. The parent identifier.

Gets or sets a value indicating whether the button can be moved to a common block of buttons on the page.

true if this button can be shown as page button; otherwise, false.

Gets or sets a value indicating whether the button can be hidden in views with limited screen space.

true if this button can be hidden; otherwise, false. This is intentended for hiding elements in views (like TV mnode), where screen space is limited. Apply this to non-essential elements only as there might be no way to make them visible at the client side.

Gets or sets a value indicating whether the caption can be hidden in views with limited screen space.

true if this caption can be hidden; otherwise, false. This is intentended for hiding elements in views (like TV mnode), where screen space is limited. Apply this to non-essential elements only as there might be no way to make them visible at the client side.

Initializes a new instance of the class.

The options.

Initializes a new instance of the class.

The options. The options2.

Initializes a new instance of the class.

The options. The options2.

Specifies a CSS class to be applied to the button.

The CSS class.

Specifies the text for the hint that appears when the button is hovered over or long-pressed.

The hint.

Specifies the button's icon.

This option accepts one of the following: The icon's URL The icon's name if the icon is from the DevExtreme icon library The icon's CSS class if the icon is from an external icon library (see External Icon Libraries) The icon in the Base64 format The icon in the SVG format. Ensure that the source is reliable. The icon.

A function that is executed when the button is clicked or tapped. Not executed if a template is used.

The on click.

The name used to identify a built-in button.

To configure a built-in button, assign its name to this option. The name.

Specifies a custom button template.

The template.

Specifies the button's text. Applies only if the button's icon is not specified.

The text.

Specifies the button's visibility.

The visible.

Values in the header filter are unselected initially, and a user can select values to apply a filter.

All values in the header filter are selected initially. A user can deselect values to change the filter.

Aligns the content of the column.

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

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

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

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

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

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.

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.

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

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

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

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

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

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.

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

Specifies a caption for the column.

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.

Specifies a custom template for data cells.

An array of grid columns.

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.

Specifies a CSS class to be applied to the column.

Binds the column to a field of the dataSource.

Casts column values to a specific data type.

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.

Specifies a custom template for data cells in editing state.

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

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

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

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

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

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.

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.

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

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

Specifies values selected in the column's header filter.

Fixes the column.

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

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

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

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

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.

Specifies a custom template for column headers.

Specifies data settings for the header filter.

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".

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.

Specifies whether the column bands other columns or not.

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.

Specifies options of a lookup column.

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.

Specifies the minimum width of the column.

Specifies the identifier of the column.

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

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

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

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

Accepted Values: '<' | '<=' | '<>' | '=' | '>' | '>=' | 'between' | 'contains' | 'endswith' | 'notcontains' | 'startswith'

Specifies whether the column displays its values using editors.

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.

Specifies whether the column chooser can contain the column header.

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

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.

Specifies the index according to which columns participate in sorting.

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.

Specifies the sort order of column values.

Accepted Values: undefined | 'asc' | 'desc' By default, rows are sorted according to the data source. Set the sortOrder option to sort rows in a required order. If you need to sort by multiple columns, specify the sortIndex option as well, or otherwise, each sorted column will get a sort index according to the position in the columns array.

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

Specifies the command column that this object customizes.

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

The validation rules.

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

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

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

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

Configures the column chooser.

Specifies whether searching is enabled in the column chooser.

Specifies text displayed by the column chooser when it is empty.

Default Value: 'Drag a column here to hide it'.

Specifies whether a user can open the column chooser.Specifies whether a user can open the column chooser.

When this option is set to true, a user can open the column chooser with a click on the "Column Chooser" icon. Otherwise, this icon is hidden, but you still can open the column chooser from code by calling the showColumnChooser() method.

Specifies the height of the column chooser.

Specifies how a user manages columns using the column chooser.

Specifies a delay in milliseconds between when a user finishes typing in the column chooser's search panel, and when the search is executed.

Specifies the title of the column chooser.

Specifies the width of the column chooser.

Configures the column chooser.

Enables column fixing.

Contains options that specify texts for column fixing commands in the context menu of a column header.

Specifies text for the context menu item that fixes a column.

Specifies text for the context menu subitem that fixes a column to the left edge of the widget.

Specifies text for the context menu subitem that fixes a column to the right edge of the widget.

Specifies text for the context menu item that unfixes a column.

One of the predefined formats

The type.

Specifies a precision for values of a numeric format.

The precision.

Specifies a 3-letter ISO 4217 code for currency. Applies only if the type is "currency".

The currency.

A user edits one row at a time. The widget saves changes when the row leaves the editing state.

A user edits data cell by cell. The widget does not save changes until a user clicks the global "Save" button.

Differs from the batch mode in that the widget saves changes when the cell leaves the editing state.

On entering the editing state, a row becomes a form with editable fields. The widget saves changes after a user clicks the "Save" button.

Differs from the form mode in that the form with editable fields is placed in a popup window.

Specifies whether a user can add new rows.

The allow adding.

Specifies whether a user can delete rows. It is called for each data row when defined as a function.

The allow deleting.

Specifies whether a user can update rows. It is called for each data row when defined as a function.

The allow updating.

Configures the form. Used only if editing.mode is "form" or "popup".

The form.

Specifies how a user edits data.

The mode.

Configures the popup. Used only if editing.mode is "popup".

The popup.

Specifies operations that are performed after saving changes.

The refresh mode.

Specifies whether to select text in a cell when a user starts editing.

The select text on edit start. Default is false.

Specifies whether a single or double click should switch a cell to the editing state. Applies if editing.mode is "cell" or "batch".

The start edit action. Accepted Values: 'click' | 'dblClick'. Default Value: 'click'.

Contains options that specify texts for editing-related UI elements.

The texts.

Specifies whether the editing column uses icons instead of links.

The use icons.

Contains options that specify texts for editing-related UI elements.

Adds the Export button to the DxDataGrid's toolbar.

The enabled.

Allows users to export selected rows only.

The allow export selected data.

Configures the filter panel feature.

The filter panel displays the applied filter expression.

Specifies whether the filter expression is applied.

Indicates whether header filter icons are visible.

Contains options that specify text for various elements of the popup menu.

Specifies texts for the filter panel's elements.

The text of the "Clear" link.

The text of the "Create Filter" link.

The hint of the checkbox that applies the filter.

Configures the filter row.

Specifies text for a hint that appears when a user pauses on a button that applies the filter.

Specifies a placeholder for the editor that specifies the end of a range when a user selects the "between" filter operation.

Default Value: 'End'.

Specifies a placeholder for the editor that specifies the start of a range when a user selects the "between" filter operation.

Default Value: 'Start'.

Specifies descriptions for filter operations on the filter list.

Specifies text for the reset operation on the filter list.

Default Value: 'Reset'.

Specifies text for the item that clears the applied filter. Used only when a cell of the filter row contains a select box.

Default Value: '(All)'.

Specifies whether icons that open the filter lists are visible.

Specifies whether the filter row is visible.

Configures the filter row.

Specifies whether the user can collapse grouped records in a grid or not.

Specifies whether groups appear expanded or not.

Enables the user to group data using the context menu.

Set this option to true to enable grouping using the context menu. In this case, to group/ungroup data, the user right-clicks a column header and chooses the required item from the appeared context menu.

Specifies the event on which a group will be expanded/collapsed.

By default, to expand/collapse a group, the user clicks its expand/collapse button. On small-screen devices, this approach may impair the user experience. As an alternative, consider expanding/collapsing a group by a click on the group row. For this purpose, assign "rowClick" to the grouping.expandMode property.

Defines the texts of grouping-related visual elements.

Use the options of this object to localize or customize grouping-related elements. For example, the groupByThisColumn, ungroup and ungroupAll options customize items of the context menu. These items appear in the menu only if the grouping.contextMenuEnabled option is set to true.

Defines the texts of grouping-related visual elements.

Specifies the text of the context menu item that groups data by a specific column.

Specifies the message displayed in a group row when the corresponding group is continued from the previous page.

Specifies the message displayed in a group row when the corresponding group continues on the next page.

Specifies the text of the context menu item that clears grouping settings of a specific column.

Specifies the text of the context menu item that clears grouping settings of all columns.

Configures the header filter feature.

A header filter allows a user to filter values in an individual column by including/excluding them in/from the applied filter. A click on a header filter icon invokes a popup menu with all unique values in the column. By selecting or clearing the selection of values in this menu, the user includes/excludes them in/from the filter.

Specifies whether searching is enabled in the header filter.

Specifies the height of the popup menu that contains values for filtering.

Specifies a delay in milliseconds between when a user finishes typing in the header filter's search panel, and when the search is executed.

Indicates whether header filter icons are visible.

Contains options that specify text for various elements of the popup menu.

Specifies the width of the popup menu that contains values for filtering.

Contains options that specify text for various elements of the popup menu.

Specifies text for the button that closes the popup menu without applying a filter.

Specifies a name for the item that represents empty values in the popup menu.

Specifies text for the button that applies the specified filter.

Specifies options of a lookup column.

Specifies whether to display the Clear button in lookup column cells while they are being edited.

Set this option to true only if your data source accepts null values.

Specifies the data source for the lookup column.

Specifies the data source field whose values must be displayed.

Specifies the data source field whose values must be replaced.

Specifies whether detail sections appear expanded or collapsed.

The automatic expand all.

Enables an end-user to expand/collapse detail sections.

Specifies a custom template for detail sections.

The template.

Specifies the detail grid options.

Specifies the shortcut key that sets focus on the widget.

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

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

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

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

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

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

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.

Specifies whether columns should adjust their widths to the content.

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.

Configures the column chooser.

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

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.

Specifies the minimum width of columns.

When a user resizes a column, the width of the next column changes.

When a user resizes a column, the width of the widget changes. This mode is ignored if you specify the width of any column in percent.

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

An array of grid columns.

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.

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

Binds the widget to data

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.

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.

Specifies whether the widget responds to user interaction.

Configures editing.

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.

Indicates whether to show the error row.

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.

Configures client-side exporting.

Configures the filter panel.

Configures the filter row.

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.

Specifies a filter expression.

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

Specifies whether the focused row feature is enabled.

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.

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

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.

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

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.

Specifies whether the widget can be focused using keyboard navigation.

Configures grouping.

Configures change command.

Configures the group panel.

Configures the header filter feature.

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

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

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

Configures keyboard navigation.

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.

Configures the load panel.

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

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.

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

Configures the pager.

Configures paging.

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.

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

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

Specifies whether to repaint only those cells whose data changed.

Specifies whether rows should be shaded differently.

Configures row reordering using drag and drop gestures.

Configures scrolling.

Configures the search panel.

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

Configures runtime selection.

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.

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

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.

Specifies whether the outer borders of the widget are visible.

Specifies whether column headers are visible.

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

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

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

Configures runtime sorting.

Configures state storing.

Specifies the options of the grid summary

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

Specifies whether to enable two-way data binding.

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.

Specifies whether the widget is visible.

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

Enables paging.

Specifies the page to be displayed using a zero-based index.

Specifies the page size.

Specifies the way an end-user applies the selected value.

The apply value mode.

Specifies the shortcut key that sets focus on the widget.

Specifies whether to close the widget if a user clicks outside it.

The close on outside click.

Specifies whether to render the widget's content when it is displayed. If false, the content is rendered immediately.

The defer rendering.

Specifies whether the widget responds to user interaction.

The disabled.

Specifies whether or not to allow a user to drag the popup window.

The drag enabled.

Specifies whether the widget can be focused using keyboard navigation.

Specifies whether to display the Popup in full-screen mode.

The full screen.

Specifies the widget's height in pixels.

The height.

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

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

Configures keyboard navigation.

Specifies the maximum height the widget can reach while resizing.

The maximum height.

Specifies the maximum width the widget can reach while resizing.

The maximum width.

Specifies the minimum height the widget can reach while resizing.

The minimum height.

Specifies the minimum width the widget can reach while resizing.

The minimum width.

Positions the widget.

The position.

Specifies whether to repaint only those cells whose data changed.

Specifies whether rows should be shaded differently.

Configures row reordering using drag and drop gestures.

Specifies whether or not an end user can resize the widget.

Switches the widget to a right-to-left representation.

The RTL enabled.

Specifies whether to shade the background when the widget is active.

The shading.

Specifies the shading color. Applies only if shading is enabled.

The color of the shading.

Specifies whether or not the widget displays the Close button.

The show close button.

A Boolean value specifying whether or not to display the title in the popup window.

The show title.

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

The title in the overlay window.

The title.

Specifies whether the widget is visible.

Specifies the widget's width in pixels.

The width.

Configures row dragging and reordering.

Specifies how to highlight the row's drop position.

Rows do not animate, a blue square appears at the place where the dragged row is going to be placed.

Rows move apart with animation, making free space for the dragged row to be placed.

Allows users to drop a row inside another row.

The allow drop inside item. This option allows users to drop rows only in the UI. You should also handle drag-and-drop in code. If users drag and drop rows inside a single component, use the onReorder handler. To allow users to drag and drop rows between components, use the onAdd handler.

Allows row reordering using drag and drop gestures.

The allow reordering. This option only enables dragging. You should also implement the reordering logic in the onReorder handler to enable row reordering inside a component. If you need to perform cross-component drag-and-drop, implement the dragging logic in the onAdd handler.This option only enables dragging. You should also implement the reordering logic in the onReorder handler to enable row reordering inside a component. If you need to perform cross-component drag-and-drop, implement the dragging logic in the onAdd handler.

Gets or sets the animation in dropfeedbackmode push.

The animation configuration. This is not officially documented.

Enables automatic scrolling while dragging a row beyond the viewport.

The automatic scroll. Default: true.

Specifies a DOM element that limits the dragging area.

The boundary.

Specifies a custom container in which the draggable row should be rendered.

The container.

Specifies the cursor offset from the dragged row.

The cursor offset.

A container for custom data.

The data.

Specifies the directions in which a row can be dragged.

The drag direction. Default Value: 'both'.

Specifies how to highlight the row's drop position.

The drop feedback mode.

Specifies a CSS selector for draggable rows.

The filter.

Allows you to group several widgets so that users can drag and drop rows between them.

The group. Set this option to identical values for the widgets you want to collect in a single group.

Specifies a CSS selector (ID or class) for the element(s) that should act as the drag handle(s).

The handle.

Specifies the distance in pixels from the edge of viewport at which scrolling should start. Applies only if autoScroll is true.

The scroll sensitivity. Default Value: 60.

Specifies the scrolling speed when dragging a row beyond the viewport. Applies only if autoScroll is true.

The scroll speed. Default Value: 30.

Shows or hides row dragging icons.

The show drag icons.

Scrolling allows a user to browse data left outside the current viewport. The widget provides several scrolling modes detailed in the mode option description.

Renders all columns at once.

Renders only those columns that get into the viewport.

Renders all the loaded rows at once.

Renders only those rows that get into the viewport. Use this mode if the pageSize is large. Rows that are being currently rendered can be shown as grey boxes.

A user scrolls a single page only. Scrolling is available only if all the page's rows do not fit into the widget's height. In this mode, the pager performs the main navigation and scrolling is auxiliary. If paging is disabled, the widget loads all rows simultaneously which can reduce the widget's performance. In this case, we recommend that you use another scrolling mode.

Each next page is loaded once the scrollbar reaches the end of its scale. In this mode, users scroll data gradually from the first to the last page.

Rows are loaded when they get into the viewport and removed once they leave it. If the rows take time to be loaded and rendered, they display gray boxes. Rendering optimization can reduce rendering time and remove gray boxes. In this mode, users can move to any page instantly.

Specifies the rendering mode for columns. Applies when columns are left outside the viewport. Requires the columnWidth, columnAutoWidth, or width (for all columns) option specified.

Specifies the scrolling mode.

Regardless of the scrolling mode, you can use the paging.pageSize option to specify the number of rows on a page.

Specifies whether the widget should load adjacent pages. Applies only if scrolling.mode is "virtual" or "infinite".

In virtual and infinite scrolling modes, pages are loaded on demand. If you set this option to true, the adjacent pages are loaded in advance for smoother scrolling. This option can reduce the performance on older devices.

Specifies the rendering mode for loaded rows.

Specifies whether a user can scroll the content with a swipe gesture. Applies only if useNative is false.

Specifies whether a user can scroll the content with the scrollbar. Applies only if useNative is false.

Specifies when to show scrollbars. Applies only if useNative is false.

The scrollbars help to scroll the content vertically and horizontally. Vertical scrolling is available when all the rows do not fit in the widget's height. Horizontal scrolling is available when all the columns do not fit in the widget's width, which can happen when columns have fixed widths or the columnAutoWidth option is set to true.

Specifies whether the widget should use native or simulated scrolling.

By default, the widget employs native scrolling on most platforms, except non-Mac desktops and devices based on Android older than version 4. To employ native scrolling on all platforms without exception, assign true to this option. If you assign false, the widget simulates scrolling on all platforms.By default, the widget employs native scrolling on most platforms, except non-Mac desktops and devices based on Android older than version 4. To employ native scrolling on all platforms without exception, assign true to this option. If you assign false, the widget simulates scrolling on all platforms.

Configures runtime selection.

The none

Only one row can be in the selected state at a time.

Several rows can be in the selected state at a time.

Selects records on all pages.

Selects records on currently rendered page.

Check boxes appear once a user clicks anywhere in the selection column, or if two or more rows are selected programmatically or using keyboard shortcuts. Check boxes disappear once rows selection is canceled.

Check boxes are always hidden, which means that selection is always single-like in this mode.

The selection column with all the check boxes is always visible. A user can select a row by clicking the check box or its grid cell, but not the row itself.

The selection column with all the check boxes appears and disappears on long tap, and on click and hold.

Specifies whether a user can select all rows at once.

If this option is set to true, it allows a user to select all rows at once by pressing Ctrl + A or clicking the check box in the selection column's header. The "Select All" check box also allows a user to deselect all rows. The select all functionality allows selecting/deselecting only those rows that meet filtering conditions if a filter is applied. If this option is set to false, it disables the select all functionality. In this case, the check box clears selection and is hidden if no rows are selected.

Specifies the selection mode.

Makes selection deferred.

Consider making selection deferred if the widget needs to operate a large volume of data and the user is allowed to select all rows at once. Unlike usual (or "instant") selection, in the case of deferred selection, the widget requests data only when you demand this using the API, for example, when the getSelectedRowsData() or getSelectedRowKeys() method is called. This mode has certain specifics that determine the API you need to use. For more information, see the Deferred Selection article.

Specifies the mode in which all the records are selected. Applies only if selection.allowSelectAll is true.

selectAllMode specifies how records should be selected on clicking the "Select All" check box and by calling the selectAll()/deselectAll() methods. The following modes are available.

Specifies when to display check boxes in rows. Applies only if selection.mode is "multiple".

The selection behavior in multiple mode depends on the check boxes' visibility. Selection is proper multiple only when check boxes are visible. In other cases, the selection behavior resembles the single mode: clicking (or tapping) a row selects it, but cancels the selection of other rows. However, a user still can select multiple rows in this mode using a click and hold, or long tap.

Configures the filter row.

Rows can be sorted by values of a single column only.

Rows can be sorted by values of several columns.

No sorting.

Specifies the sorting mode.

The mode.

Configures the filter row.

Specifies items of the group summary.

The group summary provides a synopsis of a group of data. Groups of data are formed in the process of grouping. The group summary contains several items. Each item displays a value that is a product of applying an aggregate function to a group of data. To specify the items of the group summary, declare an array of objects, each of which contains at least two fields: column and summaryType. The column field specifies the identifier of the column that provides data for an aggregate function. The summaryType specifies the aggregate function to be applied.

Specifies whether to recalculate summaries while a user edits data.

Specifies whether or not to skip empty strings, null and undefined values when calculating a summary.

Specified in the summary object, this option affects all summaries in the grid. In addition, the same option can be specified for an individual summary. It will override the global setting.

Indicates whether to display group summary items in parentheses after the group row header or to align them by the corresponding columns within the group row.

Specifies the column that provides data for a group summary item.

Specifies the summary item's text.

You can use the following position markers in this text: {0} - formatted summary value. {1} - the parent column's caption. Available if the showInColumn option is specified.

Specifies the group summary item's identifier.

Use this name to access the summary item in callback functions like calculateCustomSummary.

Specifies the column that must hold the summary item when this item is displayed in the group footer or aligned by a column in the group row.

A group summary item can be forced to be displayed in the group row by the column that provides data for this item. Alternatively, you can place an item to the group footer where the item is also held by the column that provides data for it. If you need to place an item in another column, assign the name, data field or caption of this column to the showInColumn option.

pecifies whether or not a summary item must be displayed in the group footer.

By default, summary items are displayed as a part of a group row. If you need a summary item to be displayed in the group footer, assign true to the showInGroupFooter option of this item. This summary item will be located in the column that provides data for it. If you want another column to hold the summary item, specify the showInColumn option of this item.

Specifies whether or not to skip empty strings, null and undefined values when calculating a summary.

Specified in a summary configuration object, this option affects an individual summary item. If you need to apply a single setting to all summaries in a grid, specify the skipEmptyValues option in the summary object.

Specifies how to aggregate data for the group summary item.

Use the SummaryType enum to specify this option when the widget is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Sum, Min, Max, Avg, Count, and Custom. To apply a custom server-side aggregate function, use a string overload instead.

Specifies a summary item value's display format.

Applies the selected value immediately after a user clicks the required value in the drop-down menu. To cancel the selection, click outside the drop-down menu.

Enables an end-user to apply the selected value or cancel the selection using the Apply and Cancel buttons respectively.

Specifies whether the search box is visible.

The search enabled.

Specifies the way an end-user applies the selected value.

The apply value mode.

Specifies the rule type

The the rule type.

Specifies the rule type

The the rule type.

Specifies the rule type

The the rule type.

Specifies the maximum value allowed for the validated value.

The maximum.

Specifies the minimum value allowed for the validated value.

The minimum.

Specifies the rule type

The the rule type.

Indicates whether to remove the Space characters from the validated value.

The trim.

Specifies the rule type

The the rule type.

Indicates whether to remove the Space characters from the validated value.

The trim.

Specifies the maximum length allowed for the validated value.

The maximum.

Specifies the minimum length allowed for the validated value.

The minimum.

Specifies the rule type

The the rule type.

Specifies the message that is shown if the rule is broken.

The message.

If set to true, empty values are valid.

true if empty values are valid; otherwise, false.

None

In Progress

Succeeded

Failed

Warning

Unavailable

Unknown

Gets or sets a value indicating whether the label can be hidden in views with limited screen space.

true if this label can be hidden; otherwise, false. This is intentended for hiding elements in views (like TV mnode), where screen space is limited. Apply this to non-essential elements only as there might be no way to make them visible at the client side.

Gets or sets a value indicating whether the spacer can be hidden in views with limited screen space.

true if this spacer can be hidden; otherwise, false. This is intentended for hiding elements in views (like TV mnode), where screen space is limited. Apply this to non-essential elements only as there might be no way to make them visible at the client side.

Gets or sets a value indicating whether the item can be hidden in views with limited screen space.

true if this item can be hidden; otherwise, false. This is intentended for hiding elements in views (like TV mnode), where screen space is limited. Apply this to non-essential elements only as there might be no way to make them visible at the client side.

Returns a string that represents the current object.

A string that represents the current object.

Initializes a new instance of the class.

Class representing a validation error for descendants of or .

Initializes a new instance of the class.

The editor identifier. Type of the editor. Name of the property. Display name of the property. The string value. The error message.

Initializes a new instance of the class.

Gets or sets the editor identifier.

The editor identifier.

Gets or sets the type of the editor.

The type of the editor.

Gets or sets the name of the property.

The name of the property.

Gets or sets the display name of the property.

The display name of the property.

Gets or sets the string value.

The string value.

Gets or sets the error message.

The error message.

Returns a string that represents the current object.

A string that represents the current object.

Class representing a list of validation errors for descendants of or .

Initializes a new instance of the class.

Gets a message that describes the current exception.

The error message that explains the reason for the exception, or an empty string ("").

Attribute for specifying one or more string aliases for an enum entry.

Attribute for specifying a color.

Attribute indicating the maximum value of a numeric property.

Attribute indicating the minimum value of a numeric property.

Attribute indicating that a property value must not remain null or empty when editing.

Attribute indicating the number of decimal places for display and editing.

Attribute indicating a maximum length for editing string fields.

Attribute indicating a text for the 'true' value in case of nullable bool fields.

Attribute indicating a text for the 'false' value in case of nullable bool fields.

Attribute indicating that available select items are provided by another property.

Attribute indicating that available radio items are provided by another property.

Attribute indicating the property containing the data source.

Attribute indicating the property containing a collection of selected keys.

Attribute indicating the property containing a filter expression.

Attribute indicating that available select items should be shown as radio group.

Attribute indicating that a multiline field should be used for editing.

Attribute indicating that a select item should allow multiple selection.

Attribute indicating that a folder picker should be used for editing.

Attribute indicating that a file picker should be used for editing.

Attribute indicating that a property needs to be treated as password for display and editing.

Attribute indicating that a property corresponds to advanced functionality.

Attribute indicating that a property change should cause a postback.

Initializes a new instance of the class.

The command identifier. Name of the ommand parameter property.

Initializes a new instance of the class.

Name of the property. Sets the command id to the name of the property.

Attribute for specifying additional information for an enum entry.

Attribute defining a condition on a sibling property value for controlling enabled state.

Initializes a new instance of the class.

The target property. The simple condition.

Initializes a new instance of the class.

The target property. The value condition. The value.

Attribute for specifying a tag string that is used for creating unique codec IDs.

Attribute indicating the rank of an enum value with regards to a certain ordering rule.

Conditions on the source value.

Conditions for comparing with a target value.

Attribute base class for specifying a condition on a sibling property value.

Initializes a new instance of the class.

The target property. The simple condition.

Initializes a new instance of the class.

The target property. The value condition. The value.

Gets the target property name or path.

The target property name or path.

Gets the simple condition.

The simple condition.

Gets the value condition.

The value condition.

Gets the value.

The value.

Attribute for specifying a tag string that is used for creating unique codec IDs.

Attribute defining a condition on a sibling property value for controlling visibility.

Initializes a new instance of the class.

The target property. The simple condition.

Initializes a new instance of the class.

The target property. The value condition. The value.

Implements a locally unique ID.

Initializes a new instance of the struct.

The value.

Initializes a new instance of the struct.

The luid string.

Gets the empty Luid.

The empty Luid.

Gets the numeric value.

The numeric value.

Determines whether the specified , is equal to this instance.

The to compare with this instance. true if the specified is equal to this instance; otherwise, false.

Indicates whether the current object is equal to another object of the same type.

An object to compare with this object. true if the current object is equal to the other parameter; otherwise, false.

Returns a hash code for this instance.

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Converts to string.

A that represents this instance.

Converts to a short string.

A that represents this instance. Short strings are suitable for use cases like presentation or others where a high level of uniqueness is not required.

Creates a new object that is a copy of the current instance.

A new object that is a copy of this instance.

Converts to string.

A that represents this instance.

Gets the editor title.

The editor title.

Gets the editor description.

The editor description.