Class GridCommandColumn

Configures grid command column.

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

Constructors

GridCommandColumn()

Declaration
public GridCommandColumn()

Properties

ButtonOption

Define the button model.

Declaration
[Parameter]
public CommandButtonOptions ButtonOption { get; set; }
Property Value
Type
CommandButtonOptions

ID

Define the command button ID.

Declaration
[Parameter]
public string? ID { get; set; }
Property Value
Type
string

Title

Define the command button tooltip.

Declaration
[Parameter]
public string? Title { get; set; }
Property Value
Type
string

Type

Define the command button type.

  • NoneDefault. A command button with no default action. Use this for custom command actions.
  • EditA edit command button that edit current record.
  • DeleteA delete command button that delete current record.
  • SaveA save command button that saves the current edited record.
  • CancelA cancel command button that cancels the edit state.
Declaration
[Parameter]
public CommandButtonType Type { get; set; }
Property Value
Type
CommandButtonType
Remarks

To use custom command button, set Type as None and use CommandClicked event to perform custom action.

Uid

Gets or sets a unique identifier for the command column instance.

Declaration
[Parameter]
public string? Uid { get; set; }
Property Value
Type
string

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
RenderTreeBuilder __builder
Overrides

OnInitializedAsync()

Initializes the grid command column and registers it with the parent grid.

Declaration
protected override Task OnInitializedAsync()
Returns
Type
Task
Overrides

OnParametersSetAsync()

Updates cached button properties when parameters change.

Declaration
protected override Task OnParametersSetAsync()
Returns
Type
Task
Overrides

Implements