Class DxGridSelection

Configures runtime selection.

Inheritance
System.Object
DxGridSelection
Namespace: Emby.Web.GenericEdit.Elements.DxGrid
Assembly: Emby.Web.GenericEdit.dll
Syntax
public class 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.

Properties

allowSelectAll

Specifies whether a user can select all rows at once.

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

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.

deferred

Makes selection deferred.

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

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.

mode

Specifies the selection mode.

Declaration
public DxGridSelection.SelectionMode? mode { get; set; }
Property Value
Type Description
System.Nullable<DxGridSelection.SelectionMode>

selectAllMode

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

Declaration
public DxGridSelection.SelectAllMode? selectAllMode { get; set; }
Property Value
Type Description
System.Nullable<DxGridSelection.SelectAllMode>
Remarks

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.

showCheckBoxesMode

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

Declaration
public DxGridSelection.ShowCheckBoxesMode? showCheckBoxesMode { get; set; }
Property Value
Type Description
System.Nullable<DxGridSelection.ShowCheckBoxesMode>
Remarks

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.

Extension Methods