Class GridSelectionSettings

Configures grid selection.

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

Constructors

GridSelectionSettings()

Declaration
public GridSelectionSettings()

Properties

AllowDragSelection

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

Declaration
[Parameter]
[JsonPropertyName("allowDragSelection")]
public bool AllowDragSelection { get; set; }
Property Value
Type Description
bool

true, if the row and cell selection enabled when dragging mouse. Otherwise, false.
Remarks

To perform drag selection in blazor grid, set Type as should be Multiple.

CellSelectionMode

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

  • FlowDefault. Selects the range of cells between start index and end index that also includes the other cells of the selected rows..
  • BoxSelects the range of cells within the start and end column indexes that includes in between cells of rows within the range
Declaration
[Parameter]
public CellSelectionMode CellSelectionMode { get; set; }
Property Value
Type
CellSelectionMode

CheckboxMode

Defines options for checkbox selection Mode. They are,.

  • DefaultDefault. In this mode, user can select multiple rows by clicking rows one by one.
  • ResetOnRowClickIn 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
[Parameter]
public CheckboxSelectionType CheckboxMode { get; set; }
Property Value
Type
CheckboxSelectionType

CheckboxOnly

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

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

EnableSimpleMultiRowSelection

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

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

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
bool

Mode

Specifies the selection mode. Available modes are,.

  • RowDefault. Row selection is enabled
  • CellCell selection is enabled.
  • BothBoth Row and Cell selection is enabled.
Declaration
[Parameter]
public SelectionMode Mode { get; set; }
Property Value
Type
SelectionMode

PersistSelection

If PersistSelection set to true, then the Grid selection is persisted on all operations. For persisting selection in the Grid, any one of the column must be enabled as a primary key.

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

Type

Defines options for selection type. They are.

  • SingleDefault. Allows selection of only a row or a cell.
  • MultipleAllows user to select a multiple rows or cells.
Declaration
[Parameter]
public SelectionType Type { get; set; }
Property Value
Type
SelectionType

Methods

OnInitializedAsync()

Declaration
protected override Task OnInitializedAsync()
Returns
Type
Task
Overrides

OnParametersSetAsync()

Declaration
protected override Task OnParametersSetAsync()
Returns
Type
Task
Overrides

Implements