Class TreeGridSelectionSettings

Configures Tree Grid sort column.

Inheritance
object
ComponentBase
OwningComponentBase
SfOwningComponentBase
TreeGridSelectionSettings
Implements
Inherited Members
Namespace: Syncfusion.Blazor.TreeGrid
Assembly: Syncfusion.Blazor.dll
Syntax
public class TreeGridSelectionSettings : SfOwningComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Constructors

TreeGridSelectionSettings()

Declaration
public TreeGridSelectionSettings()

Properties

AllowDragSelection

Gets or sets whether to enable selection of multiple rows and cells by dragging mouse.

Declaration
[Parameter]
public bool AllowDragSelection { get; set; }
Property Value
Type Description
bool

true if the row and cell selection enabled when dragging mouse; otherwise, false. The default value is false.
Remarks

To perform drag selection in Blazor TreeGrid, set Type as Multiple.

Examples

In the below code example, enabled AllowDragSelection property

<SfTreeGrid @ref="Treegrid">
<TreeGridSelectionSettings AllowDragSelection = "true" Type="Syncfusion.Blazor.Grids.SelectionType.Multiple" >
........
</SfTreeGrid>

CellSelectionMode

The cell selection modes are flow and box. It requires the selection Mode to be either Cell or Both.

Declaration
[Parameter]
public CellSelectionMode CellSelectionMode { get; set; }
Property Value
Type Description
CellSelectionMode

One of the CellSelectionMode enumeration values. The default is Flow.

CheckboxMode

Defines options for checkbox selection Mode.

Declaration
[Parameter]
public CheckboxSelectionType CheckboxMode { get; set; }
Property Value
Type Description
CheckboxSelectionType

One of the CheckboxSelectionType enumeration values. The default is Default.

CheckboxOnly

If CheckboxOnly set to true, then the TreeGrid selection is allowed only through checkbox.

Declaration
[Parameter]
public bool CheckboxOnly { get; set; }
Property Value
Type Description
bool

true if selection is allowed only through checkbox; otherwise, false.

EnableToggle

If EnableToggle set to true, then the user can able to perform toggle for the selected row.

Declaration
[Parameter]
public bool EnableToggle { get; set; }
Property Value
Type Description
bool

true if toggle for the selected row is enabled; otherwise, false.

Mode

TreeGrid supports row, cell, and both (row and cell) selection mode.

Declaration
[Parameter]
public SelectionMode Mode { get; set; }
Property Value
Type Description
SelectionMode

One of the SelectionMode enumeration values. The default is Row.

MultiSelectWithClick

If RowMultiSelectWithClick is set to true, then the user can able to perform multiple row selection with single clicks.

Declaration
[Parameter]
public bool MultiSelectWithClick { get; set; }
Property Value
Type Description
bool

true if multiple row selection with single clicks is enabled; otherwise, false.

PersistSelection

If PersistSelection set to true, then the TreeGrid selection is persisted on all operations.

Declaration
[Parameter]
public bool PersistSelection { get; set; }
Property Value
Type Description
bool

true if the selection is persisted on all operations; otherwise, false.

Type

Defines options for selection type.

Declaration
[Parameter]
public SelectionType Type { get; set; }
Property Value
Type Description
SelectionType

One of the SelectionType enumeration values. The default is Single.

Methods

OnInitializedAsync()

Method invoked when the component is ready to start, having received its initial parameters from its parent in the render tree. Override this method if you will perform an asynchronous operation and want the component to refresh when that operation is completed.

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
Task

A System.Threading.Tasks.Task representing any asynchronous operation.
Overrides

OnParametersSetAsync()

Method invoked when the component has received parameters from its parent in the render tree, and the incoming values have been assigned to properties.

Declaration
protected override Task OnParametersSetAsync()
Returns
Type Description
Task

A System.Threading.Tasks.Task representing any asynchronous operation.
Overrides

Implements