Class GridKeySettings

Configures keyboard navigation for grid.

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

Constructors

GridKeySettings()

Declaration
public GridKeySettings()

Properties

MoveDownCell

Defines the action keys for the down cell movement.

  • EnterMoves to down cell on pressing Enter key
  • ArrowDownMoves to down cell on pressing down arrow key
  • ShiftDownMoves to down cell on pressing shift+down arrow key
Declaration
[Parameter]
public string MoveDownCell { get; set; }
Property Value
Type
string

MoveLeftCell

Defines the action keys for the left cell movement.

  • ShiftTabMoves to left cell on pressing Shift+Tab key
  • ArrowLeftMoves to left cell on pressing left arrow key
  • ShiftLeftMoves to left cell on pressing shift+left arrow key
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
  • ArrowRightMoves to right cell on pressing right arrow key
  • ShiftRightMoves to right cell on pressing shift+right arrow key
Declaration
[Parameter]
public string MoveRightCell { get; set; }
Property Value
Type
string

MoveUpCell

Defines the action keys for the up cell movement.

  • ShiftEnterMoves to top cell on pressing Shit+Enter key
  • ArrowUpMoves to top cell on pressing up arrow key
  • ShiftUpMoves to top cell on pressing shift+up arrow key
Declaration
[Parameter]
public string MoveUpCell { get; set; }
Property Value
Type
string

Methods

OnInitializedAsync()

Invoked during component initialization. Updates the parent grid with the current key navigation settings and initializes internal state fields.

Declaration
protected override Task OnInitializedAsync()
Returns
Type
Task
Overrides

OnParametersSetAsync()

Invoked when component parameters are set or updated. Updates internal navigation settings for cell movement (up, down, left, right) if any of these values have changed.

Declaration
protected override Task OnParametersSetAsync()
Returns
Type
Task
Overrides

Implements