menu

ASP.NET MVC - EJ2

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class TreeGridSelectionSettingsBuilder - ASP.NETMVC-EJ2 API Reference | Syncfusion

    Show / Hide Table of Contents

    Class TreeGridSelectionSettingsBuilder

    Inheritance
    System.Object
    Syncfusion.EJ2.ControlBuilder
    TreeGridSelectionSettingsBuilder
    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)

    Determines the mode for cell selection, available options are flow and box. Requires the selection mode to be either cell or both. Flow: Selects the range between start and end indexes, including other cells of selected rows. Box: Selects cells within the start and end column indexes within the selected rows.

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

    CheckboxMode(CheckboxSelectionType)

    Specifies the mode for checkbox selection: Default: Allows selection of multiple rows by clicking on each row individually. ResetOnRowClick: Resets prior selection when a new row is clicked. Multiple rows can be selected using CTRL or SHIFT keys.

    Declaration
    public TreeGridSelectionSettingsBuilder CheckboxMode(CheckboxSelectionType value)
    Parameters
    Type Name Description
    CheckboxSelectionType value
    Returns
    Type
    TreeGridSelectionSettingsBuilder

    CheckboxOnly(Boolean)

    If set to true, TreeGrid selection is allowed only through checkboxes. Ensure the column type is set to checkbox to enable this mode.

    Declaration
    public TreeGridSelectionSettingsBuilder CheckboxOnly(bool value)
    Parameters
    Type Name Description
    System.Boolean value
    Returns
    Type
    TreeGridSelectionSettingsBuilder

    EnableToggle(Boolean)

    Enables toggling of the selected row. When true, users can toggle the selection of a row.

    Declaration
    public TreeGridSelectionSettingsBuilder EnableToggle(bool value)
    Parameters
    Type Name Description
    System.Boolean value
    Returns
    Type
    TreeGridSelectionSettingsBuilder

    Mode(SelectionMode)

    Specifies the selection mode for the TreeGrid, which supports row, cell, and both (row and cell) selection modes. Row: Selects the entire row. Cell: Selects a single cell. Both: Selects the entire row and its cells.

    Declaration
    public TreeGridSelectionSettingsBuilder Mode(SelectionMode value)
    Parameters
    Type Name Description
    SelectionMode value
    Returns
    Type
    TreeGridSelectionSettingsBuilder

    PersistSelection(Boolean)

    When set to true, the TreeGrid selection persists even during various grid operations such as sorting or paging. Requires at least one column to be configured as the primary key for persistence.

    Declaration
    public TreeGridSelectionSettingsBuilder PersistSelection(bool value)
    Parameters
    Type Name Description
    System.Boolean value
    Returns
    Type
    TreeGridSelectionSettingsBuilder

    Type(SelectionType)

    Defines the selection type, specifying whether single or multiple selections are allowed. Single: Allows selection of only a single row or cell. Multiple: Allows selection of multiple rows or cells.

    Declaration
    public TreeGridSelectionSettingsBuilder Type(SelectionType value)
    Parameters
    Type Name Description
    SelectionType value
    Returns
    Type
    TreeGridSelectionSettingsBuilder
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved