Class GridEvents<TValue>

Configures grid events.

Inheritance

System.Object

SfBaseComponent

SfDataBoundComponent

GridEvents<TValue>

Inherited Members

SfDataBoundComponent.SetDataManager<T>(Object)

SfDataBoundComponent.OnParametersSetAsync()

SfDataBoundComponent.OnAfterRenderAsync(Boolean)

SfDataBoundComponent.DataManager

SfDataBoundComponent.MainParent

SfBaseComponent.Dispose()

SfBaseComponent.Dispose(Boolean)

SfBaseComponent.OnObservableChange(String, Object, Boolean, NotifyCollectionChangedEventArgs)

Namespace: Syncfusion.Blazor.Grids

Assembly: Syncfusion.Blazor.dll

Syntax

public class GridEvents<TValue> : SfDataBoundComponent

Type Parameters

Name	Description
TValue

Constructors

GridEvents()

Declaration

public GridEvents()

Properties

BeforeOpenColumnChooser

Triggers when clicked column chooser.

Declaration

public EventCallback<ColumnChooserEventArgs> BeforeOpenColumnChooser { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ColumnChooserEventArgs>

CellDeselected

Declaration

public EventCallback<CellDeselectEventArgs<TValue>> CellDeselected { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<CellDeselectEventArgs<TValue>>

CellDeselecting

Triggers before any cell selection occurs.

Declaration

public EventCallback<CellDeselectEventArgs<TValue>> CellDeselecting { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<CellDeselectEventArgs<TValue>>

CellSaved

Triggers when cell is saved.

Declaration

public EventCallback<CellSaveArgs<TValue>> CellSaved { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<CellSaveArgs<TValue>>

CellSelected

Triggers after a cell is selected.

Declaration

public EventCallback<CellSelectEventArgs<TValue>> CellSelected { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<CellSelectEventArgs<TValue>>

CellSelecting

Triggers before any cell selection occurs.

Declaration

public EventCallback<CellSelectingEventArgs<TValue>> CellSelecting { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<CellSelectingEventArgs<TValue>>

ColumnMenuItemClicked

Triggers when click the context menu items.

Declaration

public EventCallback<ColumnMenuClickEventArgs> ColumnMenuItemClicked { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ColumnMenuClickEventArgs>

CommandClicked

Triggers when command button is clicked.

Declaration

public EventCallback<CommandClickEventArgs<TValue>> CommandClicked { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<CommandClickEventArgs<TValue>>

ContextMenuItemClicked

Triggers when click on context menu.

Declaration

public EventCallback<ContextMenuClickEventArgs<TValue>> ContextMenuItemClicked { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ContextMenuClickEventArgs<TValue>>

ContextMenuOpen

Triggers when open the context menu.

Declaration

public EventCallback<ContextMenuOpenEventArgs<TValue>> ContextMenuOpen { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ContextMenuOpenEventArgs<TValue>>

Created

Triggers when the component is created.

Declaration

public EventCallback<object> Created { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

DataBound

Triggers when data source is populated in the Grid.

Declaration

public EventCallback<object> DataBound { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

Destroyed

Triggers when the component is destroyed.

Declaration

public EventCallback<object> Destroyed { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

DetailDataBound

Triggers after detail row expands.

This event triggers at initial expand.

Declaration

public EventCallback<DetailDataBoundEventArgs<TValue>> DetailDataBound { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<DetailDataBoundEventArgs<TValue>>

ExcelAggregateTemplateInfo

The ExcelAggregateTemplateInfo event is triggered every time a caption/footer/group footer aggregate row created on the excel sheet.

Declaration

public Action<ExcelAggregateEventArgs> ExcelAggregateTemplateInfo { get; set; }

Property Value

Type	Description
System.Action<ExcelAggregateEventArgs>

ExcelGroupCaptionTemplateInfo

The ExcelGroupCaptionTemplateInfo event is triggered every time a caption template row created on the excel sheet.

Declaration

public Action<ExcelCaptionTemplateArgs> ExcelGroupCaptionTemplateInfo { get; set; }

Property Value

Type	Description
System.Action<ExcelCaptionTemplateArgs>

ExcelHeaderQueryCellInfoEvent

The ExcelHeaderQueryCellInfoEvent event is triggered every time a data is entered into a header cell of the Excel sheet.

Declaration

public Action<ExcelHeaderQueryCellInfoEventArgs> ExcelHeaderQueryCellInfoEvent { get; set; }

Property Value

Type	Description
System.Action<ExcelHeaderQueryCellInfoEventArgs>

ExcelQueryCellInfoEvent

The ExcelQueryCellInfoEvent event is triggered every time a data is entered into a cell of the Excel sheet. So this event is triggered as many times as the data is entered into a cell written in the excel sheet.

Declaration

public Action<ExcelQueryCellInfoEventArgs<TValue>> ExcelQueryCellInfoEvent { get; set; }

Property Value

Type	Description
System.Action<ExcelQueryCellInfoEventArgs<TValue>>

ExportComplete

The ExportComplete event is triggered when exporting process was completed.

Declaration

public Action<object> ExportComplete { get; set; }

Property Value

Type	Description
System.Action<System.Object>

FreezeLineMoved

Gets or sets an event callback that is raised after moved freeze line.

Declaration

public EventCallback<FreezeLineEventArgs> FreezeLineMoved { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<FreezeLineEventArgs>

FreezeLineMoving

Gets or sets an event callback that is raised on moving freeze line.

Declaration

public EventCallback<FreezeLineEventArgs> FreezeLineMoving { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<FreezeLineEventArgs>

HeaderCellInfo

Triggered for stacked header.

Declaration

public EventCallback<HeaderCellInfoEventArgs> HeaderCellInfo { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<HeaderCellInfoEventArgs>

OnActionBegin

Triggers when Grid actions such as sorting, filtering, paging, grouping etc., starts.

Declaration

public EventCallback<ActionEventArgs<TValue>> OnActionBegin { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ActionEventArgs<TValue>>

OnActionComplete

Triggers when Grid actions such as sorting, filtering, paging, grouping etc. are completed.

Declaration

public EventCallback<ActionEventArgs<TValue>> OnActionComplete { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ActionEventArgs<TValue>>

OnActionFailure

Triggers when any Grid action failed to achieve the desired results.

Declaration

public EventCallback<FailureEventArgs> OnActionFailure { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<FailureEventArgs>

OnBatchAdd

Triggers before records are added in batch mode.

Declaration

public EventCallback<BeforeBatchAddArgs<TValue>> OnBatchAdd { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<BeforeBatchAddArgs<TValue>>

OnBatchCancel

Triggers when the cancel operation is started in batch mode.

Declaration

public EventCallback<BeforeBatchCancelArgs<TValue>> OnBatchCancel { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<BeforeBatchCancelArgs<TValue>>

OnBatchDelete

Triggers before records are deleted in batch mode.

Declaration

public EventCallback<BeforeBatchDeleteArgs<TValue>> OnBatchDelete { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<BeforeBatchDeleteArgs<TValue>>

OnBatchSave

Triggers before records are saved in batch mode.

Declaration

public EventCallback<BeforeBatchSaveArgs<TValue>> OnBatchSave { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<BeforeBatchSaveArgs<TValue>>

OnBeginEdit

Triggers before the record is to be edit.

Declaration

public EventCallback<BeginEditArgs<TValue>> OnBeginEdit { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<BeginEditArgs<TValue>>

OnCellEdit

Triggers when the cell is being edited.

Declaration

public EventCallback<CellEditArgs<TValue>> OnCellEdit { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<CellEditArgs<TValue>>

OnCellSave

Triggers when cell is saved.

Declaration

public EventCallback<CellSaveArgs<TValue>> OnCellSave { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<CellSaveArgs<TValue>>

OnDataBound

Triggers before data is bound to Grid.

Declaration

public EventCallback<BeforeDataBoundArgs<TValue>> OnDataBound { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<BeforeDataBoundArgs<TValue>>

OnExcelExport

Triggers before Grid data is exported to Excel/Csv Sheet.

Declaration

public Action<object> OnExcelExport { get; set; }

Property Value

Type	Description
System.Action<System.Object>

OnLoad

This event allows customization of Grid properties before rendering.

Declaration

public EventCallback<object> OnLoad { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

OnPdfExport

Triggers before Grid data is exported to PDF document.

Declaration

public Action<object> OnPdfExport { get; set; }

Property Value

Type	Description
System.Action<System.Object>

OnRecordClick

Triggers when record is clicked.

Declaration

public EventCallback<RecordClickEventArgs<TValue>> OnRecordClick { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<RecordClickEventArgs<TValue>>

OnRecordDoubleClick

Triggers when record is double clicked.

Declaration

public EventCallback<RecordDoubleClickEventArgs<TValue>> OnRecordDoubleClick { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<RecordDoubleClickEventArgs<TValue>>

OnResizeStart

Triggers when column resize starts.

Declaration

public EventCallback<ResizeArgs> OnResizeStart { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ResizeArgs>

OnRowDragStart

Triggers when row element's drag(move) starts.

Declaration

public EventCallback<RowDragEventArgs<TValue>> OnRowDragStart { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<RowDragEventArgs<TValue>>

OnToolbarClick

Triggers when toolbar item is clicked.

Declaration

public EventCallback<ClickEventArgs> OnToolbarClick { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ClickEventArgs>

Parent

Declaration

protected SfGrid<TValue> Parent { get; set; }

Property Value

Type	Description
SfGrid<TValue>

PdfAggregateTemplateInfo

The PdfAggregateTemplateInfo event is triggered every time a caption/footer/group footer aggregate row created on the pdf document.

Declaration

public Action<PdfAggregateEventArgs> PdfAggregateTemplateInfo { get; set; }

Property Value

Type	Description
System.Action<PdfAggregateEventArgs>

PdfGroupCaptionTemplateInfo

The PdfGroupCaptionTemplateInfo event is triggered every time a caption template row created on the pdf document.

Declaration

public Action<PdfCaptionTemplateArgs> PdfGroupCaptionTemplateInfo { get; set; }

Property Value

Type	Description
System.Action<PdfCaptionTemplateArgs>

PdfHeaderQueryCellInfoEvent

The PdfHeaderQueryCellInfoEvent event is triggered every time a data is entered into a header cell of the pdf document.

Declaration

public Action<PdfHeaderQueryCellInfoEventArgs> PdfHeaderQueryCellInfoEvent { get; set; }

Property Value

Type	Description
System.Action<PdfHeaderQueryCellInfoEventArgs>

PdfQueryCellInfoEvent

The PdfQueryCellInfoEvent event is triggered every time a data is entered into a cell of the pdf document. So this event is triggered as many times as the data is entered into a cell.

Declaration

public Action<PdfQueryCellInfoEventArgs<TValue>> PdfQueryCellInfoEvent { get; set; }

Property Value

Type	Description
System.Action<PdfQueryCellInfoEventArgs<TValue>>

QueryCellInfo

Triggered every time a request is made to access cell information, element, or data. This will be triggered before the cell element is appended to the Grid element.

Declaration

public EventCallback<QueryCellInfoEventArgs<TValue>> QueryCellInfo { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<QueryCellInfoEventArgs<TValue>>

ResizeStopped

Triggers when column resize ends.

Declaration

public EventCallback<ResizeArgs> ResizeStopped { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ResizeArgs>

RowDataBound

Triggered every time a request is made to access row information, element, or data. This will be triggered before the row element is appended to the Grid element.

Declaration

public EventCallback<RowDataBoundEventArgs<TValue>> RowDataBound { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<RowDataBoundEventArgs<TValue>>

RowDeselected

Triggers when a selected row is deselected.

Declaration

public EventCallback<RowDeselectEventArgs<TValue>> RowDeselected { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<RowDeselectEventArgs<TValue>>

RowDeselecting

Triggers before deselecting the selected row.

Declaration

public EventCallback<RowDeselectEventArgs<TValue>> RowDeselecting { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<RowDeselectEventArgs<TValue>>

RowDropped

Triggers when row elements are dropped on the target row.

Declaration

public EventCallback<RowDragEventArgs<TValue>> RowDropped { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<RowDragEventArgs<TValue>>

RowSelected

Triggers after a row is selected.

Declaration

public EventCallback<RowSelectEventArgs<TValue>> RowSelected { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<RowSelectEventArgs<TValue>>

RowSelecting

Triggers before row selection occurs.

Declaration

public EventCallback<RowSelectingEventArgs<TValue>> RowSelecting { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<RowSelectingEventArgs<TValue>>

Methods

OnInitializedAsync()

Declaration

protected override Task OnInitializedAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

SfDataBoundComponent.OnInitializedAsync()