Class TreeGridSelectionSettingsBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
TreeGridSelectionSettingsBuilder
Namespace: Syncfusion.EJ2.TreeGrid
Assembly: Syncfusion.EJ2.dll
Syntax
public class TreeGridSelectionSettingsBuilder : ControlBuilderConstructors
TreeGridSelectionSettingsBuilder()
Declaration
public TreeGridSelectionSettingsBuilder()TreeGridSelectionSettingsBuilder(TreeGridSelectionSettings)
Declaration
public TreeGridSelectionSettingsBuilder(TreeGridSelectionSettings model)Parameters
| Type | Name | Description |
|---|---|---|
| TreeGridSelectionSettings | model |
Methods
CellSelectionMode(CellSelectionMode)
The cell selection modes are flow and box. It requires the selection
mode to be either cell or both.
Declaration
public TreeGridSelectionSettingsBuilder CellSelectionMode(CellSelectionMode value)Parameters
| Type | Name | Description |
|---|---|---|
| CellSelectionMode | value |
Returns
CheckboxMode(CheckboxSelectionType)
Defines options for checkbox selection Mode. They are
rows can be selected by using CTRL or SHIFT key.
Declaration
public TreeGridSelectionSettingsBuilder CheckboxMode(CheckboxSelectionType value)Parameters
| Type | Name | Description |
|---|---|---|
| CheckboxSelectionType | value |
Returns
CheckboxOnly(Boolean)
If 'checkboxOnly' set to true, then the TreeGrid selection is allowed only through checkbox.
Declaration
public TreeGridSelectionSettingsBuilder CheckboxOnly(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 TreeGridSelectionSettingsBuilder EnableToggle(bool value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | value |
Returns
Mode(SelectionMode)
TreeGrid supports row, cell, and both (row and cell) selection mode.
Declaration
public TreeGridSelectionSettingsBuilder Mode(SelectionMode value)Parameters
| Type | Name | Description |
|---|---|---|
| SelectionMode | value |
Returns
PersistSelection(Boolean)
If 'persistSelection' set to true, then the TreeGrid selection is persisted on all operations. For persisting selection in the TreeGrid, any one of the column should be enabled as a primary key.
Declaration
public TreeGridSelectionSettingsBuilder PersistSelection(bool value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | value |
Returns
Type(SelectionType)
Defines options for selection type. They are
Declaration
public TreeGridSelectionSettingsBuilder Type(SelectionType value)Parameters
| Type | Name | Description |
|---|---|---|
| SelectionType | value |