Class KanbanEvents<TValue>

Defines event handlers for the Kanban component to handle various user interactions and component actions.

Inheritance

System.Object

KanbanEvents<TValue>

Namespace: Syncfusion.Blazor.Kanban

Assembly: Syncfusion.Blazor.dll

Syntax

public class KanbanEvents<TValue> : ComponentBase

Type Parameters

Name
TValue

Remarks

The KanbanEvents<TValue> class provides a set of predefined event callbacks that enable users to subscribe to and handle events triggered by user interactions or internal component states in the Kanban control.

Constructors

KanbanEvents()

Declaration

public KanbanEvents()

Properties

ActionBegin

Triggers at the beginning of every Kanban action.

Declaration

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

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ActionEventArgs<TValue>>	An Microsoft.AspNetCore.Components.EventCallback<> that processes action initiation, where T is ActionEventArgs<TValue>.

Remarks

This event is useful for tasks that need to be initiated before any Kanban action begins, such as logging or validation.

ActionComplete

Triggers on successful completion of the Kanban actions.

Declaration

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

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ActionEventArgs<TValue>>	An Microsoft.AspNetCore.Components.EventCallback<> that processes the completion of actions, where T is ActionEventArgs<TValue>.

Remarks

Use this event to implement tasks subsequent to a successful Kanban action, like updating UI or notifying users.

ActionFailure

Triggers when a Kanban action fails or is interrupted, providing error information.

Declaration

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

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ActionEventArgs<TValue>>	An Microsoft.AspNetCore.Components.EventCallback<> that processes failure of actions, where T is ActionEventArgs<TValue>.

Remarks

Use this event to handle exceptions and errors during Kanban operations, such as retrying operations or displaying errors.

CardClick

Triggers on single-clicking a Kanban card.

Declaration

public EventCallback<CardClickEventArgs<TValue>> CardClick { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<CardClickEventArgs<TValue>>	An Microsoft.AspNetCore.Components.EventCallback<> that handles single-click events on cards, where T is CardClickEventArgs<TValue>.

Remarks

This event allows actions to be taken when a card is clicked, such as selecting or focusing the card.

CardDoubleClick

Triggers on double-clicking a Kanban card.

Declaration

public EventCallback<CardClickEventArgs<TValue>> CardDoubleClick { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<CardClickEventArgs<TValue>>	An Microsoft.AspNetCore.Components.EventCallback<> that handles double-click events on cards, where T is CardClickEventArgs<TValue>.

Remarks

Useful for opening detailed views or performing actions that require explicit double-click confirmation.

CardRendered

Triggers before each card is rendered on the Kanban board.

Declaration

public EventCallback<CardRenderedEventArgs<TValue>> CardRendered { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<CardRenderedEventArgs<TValue>>	An Microsoft.AspNetCore.Components.EventCallback<> that handles pre-rendering logic for cards, where T is CardRenderedEventArgs<TValue>.

Remarks

Allows customization or final adjustments to the card UI or data right before rendering.

Created

Triggers after the Kanban component is created.

Declaration

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

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>	An Microsoft.AspNetCore.Components.EventCallback<> to be executed post-creation of the Kanban component.

Remarks

Use this event to perform setup tasks that require the Kanban component to be fully instantiated.

DataBinding

Triggers before the data binds to the Kanban.

Declaration

public EventCallback<DataBindingEventArgs<TValue>> DataBinding { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<DataBindingEventArgs<TValue>>	An Microsoft.AspNetCore.Components.EventCallback<> handling pre-binding data logic, where T is DataBindingEventArgs<TValue>.

Remarks

This event is ideal for modifying or validating data before it is presented in the Kanban board.

DialogClose

Triggers before the dialog closes.

Declaration

public EventCallback<DialogCloseEventArgs<TValue>> DialogClose { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<DialogCloseEventArgs<TValue>>	An Microsoft.AspNetCore.Components.EventCallback<> to handle operations prior to dialog closure, where T is DialogCloseEventArgs<TValue>.

Remarks

Allows for any cleanup or verification processes before the dialog is completely closed.

DialogOpen

Triggers before the dialog opens.

Declaration

public EventCallback<DialogOpenEventArgs<TValue>> DialogOpen { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<DialogOpenEventArgs<TValue>>	An Microsoft.AspNetCore.Components.EventCallback<> to handle operations prior to dialog opening, where T is DialogOpenEventArgs<TValue>.

Remarks

Useful for preparing data or state necessary for the dialog before it is displayed to the user.

DragStart

Triggers when card drag actions start.

Declaration

public EventCallback<DragEventArgs<TValue>> DragStart { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<DragEventArgs<TValue>>	An Microsoft.AspNetCore.Components.EventCallback<> that handles drag start operations, where T is DragEventArgs<TValue>.

Remarks

Initiates when a user begins dragging a card, useful for preparing the UI or data for a move.

DragStop

Triggers when card drag actions stop.

Declaration

public EventCallback<DragEventArgs<TValue>> DragStop { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<DragEventArgs<TValue>>	An Microsoft.AspNetCore.Components.EventCallback<> that completes drag operation processing, where T is DragEventArgs<TValue>.

Remarks

This event is triggered when a drag operation is completed, useful for finalizing a card's new position.

OnLoad

Occurs when the Kanban component is first loaded, allowing pre-render customizations.

Declaration

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

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>	An Microsoft.AspNetCore.Components.EventCallback<> that serves as a function to be invoked when the load event occurs.

Remarks

Use this event to make initial configurations or preparations before the Kanban component is fully rendered.

QueryCellInfo

Triggers before each column of the Kanban is rendered.

Declaration

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

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<QueryCellInfoEventArgs<TValue>>	An Microsoft.AspNetCore.Components.EventCallback<> for handling pre-render logic of columns, where T is QueryCellInfoEventArgs<TValue>.

Remarks

Allows customization or formatting of column data prior to it being displayed.

SwimlaneSorting

Triggers before swimlane rows are rendered.

Declaration

public EventCallback<SwimlaneSortEventArgs> SwimlaneSorting { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<SwimlaneSortEventArgs>	An Microsoft.AspNetCore.Components.EventCallback<> that processes operations before swimlane row rendering.

Remarks

Use this to manage or adjust swimlane row data for better organizational functionality or display.

Methods

OnInitializedAsync()

Method invoked when the component is ready to start.

Declaration

protected override Task OnInitializedAsync()

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing any asynchronous operation.