Class TreeGridSelectionSettingsBuilder

Inheritance
System.Object
ControlBuilder
TreeGridSelectionSettingsBuilder
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.EJ2.TreeGrid
Assembly: Syncfusion.EJ2.dll
Syntax
public class TreeGridSelectionSettingsBuilder : ControlBuilder

Constructors

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

Declaration
public TreeGridSelectionSettingsBuilder CellSelectionMode(CellSelectionMode value)
Parameters
Type Name Description
CellSelectionMode value
Returns
Type Description
TreeGridSelectionSettingsBuilder

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 TreeGridSelectionSettingsBuilder CheckboxMode(CheckboxSelectionType value)
Parameters
Type Name Description
CheckboxSelectionType value
Returns
Type Description
TreeGridSelectionSettingsBuilder

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
Type Description
TreeGridSelectionSettingsBuilder

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
Type Description
TreeGridSelectionSettingsBuilder

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
Type Description
TreeGridSelectionSettingsBuilder

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 Description
TreeGridSelectionSettingsBuilder

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 TreeGridSelectionSettingsBuilder Type(SelectionType value)
Parameters
Type Name Description
SelectionType value
Returns
Type Description
TreeGridSelectionSettingsBuilder