Class GridSelectionSettingsBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
GridSelectionSettingsBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class GridSelectionSettingsBuilder : ControlBuilder
Constructors
GridSelectionSettingsBuilder()
Declaration
public GridSelectionSettingsBuilder()
GridSelectionSettingsBuilder(GridSelectionSettings)
Declaration
public GridSelectionSettingsBuilder(GridSelectionSettings model)
Parameters
Methods
AllowColumnSelection(Boolean)
If 'allowColumnSelection' set to true, then the user can able to select the columns.
Declaration
public GridSelectionSettingsBuilder AllowColumnSelection(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
CellSelectionMode(CellSelectionMode)
The cell selection modes are flow and box. It requires the selection
mode to be either cell or both.
Flow: Selects the range of cells between start index and end index that also includes the other cells of the selected rows.
Box: Selects the range of cells within the start and end column indexes that includes in between cells of rows within the range.
BoxWithBorder: Selects the range of cells as like Box mode with borders.
Declaration
public GridSelectionSettingsBuilder CellSelectionMode(CellSelectionMode value)
Parameters
Returns
CheckboxMode(CheckboxSelectionType)
Defines options for checkbox selection Mode. They are
Default: This is the default value of the checkboxMode. In this mode, user can select multiple rows by clicking rows one by one.
ResetOnRowClick: In ResetOnRowClick mode, on clicking a row it will reset previously selected row and also multiple
rows can be selected by using CTRL or SHIFT key.
Declaration
public GridSelectionSettingsBuilder CheckboxMode(CheckboxSelectionType value)
Parameters
Returns
CheckboxOnly(Boolean)
If 'checkboxOnly' set to true, then the Grid selection is allowed only through checkbox.
Declaration
public GridSelectionSettingsBuilder CheckboxOnly(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
EnableSimpleMultiRowSelection(Boolean)
If 'enableSimpleMultiRowSelection' set to true, then the user can able to perform multiple row selection with single clicks.
Declaration
public GridSelectionSettingsBuilder EnableSimpleMultiRowSelection(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
EnableToggle(Boolean)
If 'enableToggle' set to true, then the user can able to perform toggle for the selected row.
Declaration
public GridSelectionSettingsBuilder EnableToggle(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Mode(SelectionMode)
Grid supports row, cell, and both (row and cell) selection mode.
Declaration
public GridSelectionSettingsBuilder Mode(SelectionMode value)
Parameters
Returns
PersistSelection(Boolean)
If 'persistSelection' set to true, then the Grid selection is persisted on all operations.
For persisting selection in the Grid, any one of the column should be enabled as a primary key.
Declaration
public GridSelectionSettingsBuilder PersistSelection(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Type(SelectionType)
Defines options for selection type. They are
Single: Allows selection of only a row or a cell.
Multiple: Allows selection of multiple rows or cells.
Declaration
public GridSelectionSettingsBuilder Type(SelectionType value)
Parameters
Returns
