Class TreeGridKeySettings

Configures Tree Grid key settings.

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

The properties set to TreeGridKeySettings will handle and/or prevent hot key's default action.

Examples
<SfTreeGrid @ref="TreeGrid" DataSource="@TreeGridData">
<TreeGridKeySettings MoveLeftCell="Shift+Left" MoveRightCell="Tab" MoveUpCell="UpArrow" MoveDownCell=""></TreeGridKeySettings>
........
</SfTreeGrid>

Constructors

TreeGridKeySettings()

Declaration
public TreeGridKeySettings()

Properties

IndentRow

Defines the action keys for indenting the row.

  • Alt+Shift+RightArrowIndent the row on pressing Alt+Shift+RightArrow keys
The default value is Alt+Shift+RightArrow.
Declaration
[Parameter]
public string IndentRow { get; set; }
Property Value
Type
string

MoveDownCell

Defines the action keys for the down cell movement.

  • EnterMoves to down cell on pressing Enter key
  • DownArrowMoves to down cell on pressing DownArrow key
  • Shift+DownArrowMoves to down cell on pressing Shift+DownArrow key
The default value are Enter,DownArrow,Shift+DownArrow.
Declaration
[Parameter]
public string MoveDownCell { get; set; }
Property Value
Type
string

MoveLeftCell

Defines the action keys for the left cell movement.

  • Shift+TabMoves to left cell on pressing Shift+Tab key
  • ArrowLeftMoves to left cell on pressing LeftArrow key
  • ShiftLeftMoves to left cell on pressing Shift+LeftArrow key
The default value are Shift+Tab,LeftArrow,Shift+LeftArrow.
Declaration
[Parameter]
public string MoveLeftCell { get; set; }
Property Value
Type
string

MoveRightCell

Defines the action keys for the right cell movement.

  • TabMoves to right cell on pressing Tab key
  • RightArrowMoves to right cell on pressing RightArrow key
  • Shift+RightArrowMoves to right cell on pressing Shift+RightArrow key
The default value are Tab,RightArrow,Shift+RightArrow.
Declaration
[Parameter]
public string MoveRightCell { get; set; }
Property Value
Type
string

MoveUpCell

Defines the action keys for the up cell movement.

  • Shift+EnterMoves to top cell on pressing Shit+Enter key
  • UpArrowMoves to top cell on pressing UpArrow key
  • Shift+UpArrowMoves to top cell on pressing Shift+UpArrow key
The default value are Shift+Enter,UpArrow,Shift+UpArrow.
Declaration
[Parameter]
public string MoveUpCell { get; set; }
Property Value
Type
string

OutdentRow

Defines the action keys for outdenting the row.

  • Alt+Shift+LeftArrowIndent the row on pressing Alt+Shift+LeftArrow keys
The default value is AltShiftLeft.
Declaration
[Parameter]
public string OutdentRow { get; set; }
Property Value
Type
string

Methods

OnInitializedAsync()

Declaration
protected override Task OnInitializedAsync()
Returns
Type
Task
Overrides

OnParametersSetAsync()

Declaration
protected override Task OnParametersSetAsync()
Returns
Type
Task
Overrides

Implements