Class TreeGridEvents<TValue>

Configures Tree Grid events

Inheritance

System.Object

Syncfusion.Blazor.SfBaseComponent

SfDataBoundComponent

TreeGridEvents<TValue>

Inherited Members

SfDataBoundComponent.SetDataManager<T>(Object)

SfDataBoundComponent.OnParametersSetAsync()

SfDataBoundComponent.OnAfterRenderAsync(Boolean)

SfDataBoundComponent.DataManager

SfDataBoundComponent.MainParent

Namespace: Syncfusion.Blazor.TreeGrid

Assembly: Syncfusion.Blazor.dll

Syntax

public class TreeGridEvents<TValue> : SfDataBoundComponent

Type Parameters

Name	Description
TValue

Constructors

TreeGridEvents()

Declaration

public TreeGridEvents()

Properties

BeforeBatchAdd

Triggers before records are added in batch mode.

Declaration

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

Property Value

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

BeforeBatchDelete

Triggers before records are deleted in batch mode.

Declaration

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

Property Value

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

BeforeBatchSave

Triggers before records are saved in batch mode.

Declaration

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

Property Value

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

CellDeselected

Triggers after any cell deselection occurs.

Declaration

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

Property Value

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

CellDeselecting

Triggers before any cell deselection 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>>

CheckboxChange

Triggers when checkbox column state changed.

Declaration

public EventCallback<CheckBoxChangeEventArgs<TValue>> CheckboxChange { get; set; }

Property Value

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

Collapsed

Triggers after the record is collapsed.

Declaration

public EventCallback<RowCollapsedEventArgs<TValue>> Collapsed { get; set; }

Property Value

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

Collapsing

Triggers while collapsing the TreeGrid record

Declaration

public EventCallback<RowCollapsingEventArgs<TValue>> Collapsing { get; set; }

Property Value

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

ColumnMenuItemClicked

Triggers when click on column menu.

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 before context menu is opened.

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 TreeGrid.

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>>

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.

Declaration

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

Property Value

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

Expanded

Triggers after the record is expanded

Declaration

public EventCallback<RowExpandedEventArgs<TValue>> Expanded { get; set; }

Property Value

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

Expanding

Triggers while expanding the TreeGrid record

Declaration

public EventCallback<RowExpandingEventArgs<TValue>> Expanding { get; set; }

Property Value

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

HeaderCellInfo

Triggered for stacked header.

Declaration

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

Property Value

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

OnActionBegin

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

Declaration

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

Property Value

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

OnActionComplete

Triggers when TreeGrid actions such as sorting, filtering, paging 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 TreeGrid 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>>

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 Tree Grid.

Declaration

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

Property Value

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

OnExcelExport

Triggers before TreeGrid data is exported to Excel file.

Declaration

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

Property Value

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

OnLoad

This event allows customization of TreeGrid properties before rendering.

Declaration

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

Property Value

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

OnPdfExport

Triggers before TreeGrid data is exported to PDF document.

Declaration

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

Property Value

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

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 SfTreeGrid<TValue> Parent { get; set; }

Property Value

Type	Description
SfTreeGrid<TValue>

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 EventCallback<PdfQueryCellInfoEventArgs<TValue>> PdfQueryCellInfoEvent { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<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 TreeGrid 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 TreeGrid 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()