Renderer.DispatchEventAsync Method

  • Reference

Definition

Namespace:
Microsoft.AspNetCore.Components.RenderTree
Assembly:
Microsoft.AspNetCore.Components.dll
Package:
Microsoft.AspNetCore.Components v3.0.3
Package:
Microsoft.AspNetCore.Components v3.1.18
Package:
Microsoft.AspNetCore.Components v5.0.9
Package:
Microsoft.AspNetCore.Components v6.0.6
Package:
Microsoft.AspNetCore.Components v7.0.5
Package:
Microsoft.AspNetCore.Components v8.0.0

Overloads

DispatchEventAsync(UInt64, EventFieldInfo, EventArgs)

Notifies the renderer that an event has occurred.
DispatchEventAsync(UInt64, EventFieldInfo, EventArgs, Boolean)

Notifies the renderer that an event has occurred.

DispatchEventAsync(UInt64, EventFieldInfo, EventArgs)

Source:
Renderer.cs
Source:
Renderer.cs
Source:
Renderer.cs
Source:
Renderer.cs
Source:
Renderer.cs
Source:
Renderer.cs

Notifies the renderer that an event has occurred.

public:
 virtual System::Threading::Tasks::Task ^ DispatchEventAsync(System::UInt64 eventHandlerId, Microsoft::AspNetCore::Components::RenderTree::EventFieldInfo ^ fieldInfo, EventArgs ^ eventArgs);
public virtual System.Threading.Tasks.Task DispatchEventAsync (ulong eventHandlerId, Microsoft.AspNetCore.Components.RenderTree.EventFieldInfo fieldInfo, EventArgs eventArgs);
public virtual System.Threading.Tasks.Task DispatchEventAsync (ulong eventHandlerId, Microsoft.AspNetCore.Components.RenderTree.EventFieldInfo? fieldInfo, EventArgs eventArgs);
abstract member DispatchEventAsync : uint64 * Microsoft.AspNetCore.Components.RenderTree.EventFieldInfo * EventArgs -> System.Threading.Tasks.Task
override this.DispatchEventAsync : uint64 * Microsoft.AspNetCore.Components.RenderTree.EventFieldInfo * EventArgs -> System.Threading.Tasks.Task
Public Overridable Function DispatchEventAsync (eventHandlerId As ULong, fieldInfo As EventFieldInfo, eventArgs As EventArgs) As Task

Parameters

eventHandlerId
UInt64

The AttributeEventHandlerId value from the original event attribute.

fieldInfo
EventFieldInfo

Information that the renderer can use to update the state of the existing render tree to match the UI.

eventArgs
EventArgs

Arguments to be passed to the event handler.

Returns

Task

A Task which will complete once all asynchronous processing related to the event has completed.

Applies to

DispatchEventAsync(UInt64, EventFieldInfo, EventArgs, Boolean)

Source:
Renderer.cs

Notifies the renderer that an event has occurred.

public virtual System.Threading.Tasks.Task DispatchEventAsync (ulong eventHandlerId, Microsoft.AspNetCore.Components.RenderTree.EventFieldInfo? fieldInfo, EventArgs eventArgs, bool waitForQuiescence);
abstract member DispatchEventAsync : uint64 * Microsoft.AspNetCore.Components.RenderTree.EventFieldInfo * EventArgs * bool -> System.Threading.Tasks.Task
override this.DispatchEventAsync : uint64 * Microsoft.AspNetCore.Components.RenderTree.EventFieldInfo * EventArgs * bool -> System.Threading.Tasks.Task
Public Overridable Function DispatchEventAsync (eventHandlerId As ULong, fieldInfo As EventFieldInfo, eventArgs As EventArgs, waitForQuiescence As Boolean) As Task

Parameters

eventHandlerId
UInt64

The AttributeEventHandlerId value from the original event attribute.

fieldInfo
EventFieldInfo

Information that the renderer can use to update the state of the existing render tree to match the UI.

eventArgs
EventArgs

Arguments to be passed to the event handler.

waitForQuiescence
Boolean

A flag indicating whether to wait for quiescence.

Returns

Task

A Task which will complete once all asynchronous processing related to the event has completed.

Applies to