Blazor

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class TreeGridSelectionSettings - Blazor API Reference | Syncfusion

    Show / Hide Table of Contents

    Class TreeGridSelectionSettings

    Configures Tree Grid sort column

    Inheritance
    System.Object
    Syncfusion.Blazor.SfBaseComponent
    SfDataBoundComponent
    TreeGridSelectionSettings
    Inherited Members
    SfDataBoundComponent.SetDataManager<T>(Object)
    SfDataBoundComponent.OnAfterRenderAsync(Boolean)
    SfDataBoundComponent.DataManager
    SfDataBoundComponent.MainParent
    Namespace: Syncfusion.Blazor.TreeGrid
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class TreeGridSelectionSettings : SfDataBoundComponent

    Constructors

    TreeGridSelectionSettings()

    Declaration
    public TreeGridSelectionSettings()

    Properties

    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 CellSelectionMode CellSelectionMode { get; set; }
    Property Value
    Type Description
    CellSelectionMode

    CheckboxMode

    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 CheckboxSelectionType CheckboxMode { get; set; }
    Property Value
    Type Description
    CheckboxSelectionType

    CheckboxOnly

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

    Declaration
    public bool CheckboxOnly { get; set; }
    Property Value
    Type Description
    System.Boolean

    EnableToggle

    Declaration
    public bool EnableToggle { get; set; }
    Property Value
    Type Description
    System.Boolean

    Mode

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

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

    PersistSelection

    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 bool PersistSelection { get; set; }
    Property Value
    Type Description
    System.Boolean

    Type

    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 SelectionType Type { get; set; }
    Property Value
    Type Description
    SelectionType

    Methods

    OnInitializedAsync()

    Declaration
    protected override Task OnInitializedAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task
    Overrides
    SfDataBoundComponent.OnInitializedAsync()

    OnParametersSetAsync()

    Declaration
    protected override Task OnParametersSetAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task
    Overrides
    SfDataBoundComponent.OnParametersSetAsync()
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved