Renderer.RenderRootComponentAsync 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
Package:
Microsoft.AspNetCore.Components v9.0.0-preview.6.24328.4

Overloads

RenderRootComponentAsync(Int32)

Performs the first render for a root component, waiting for this component and all children components to finish rendering in case there is any asynchronous work being done by any of the components. After this, the root component makes its own decisions about when to re-render, so there is no need to call this more than once.
RenderRootComponentAsync(Int32, ParameterView)

Supplies parameters for a root component, normally causing it to render. This can be used to trigger the first render of a root component, or to update its parameters and trigger a subsequent render. Note that components may also make their own decisions about when to re-render, and may re-render at any time.

The returned Task waits for this component and all descendant components to finish rendering in case there is any asynchronous work being done by any of them.

RenderRootComponentAsync(Int32)

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

Performs the first render for a root component, waiting for this component and all children components to finish rendering in case there is any asynchronous work being done by any of the components. After this, the root component makes its own decisions about when to re-render, so there is no need to call this more than once.

protected:
 System::Threading::Tasks::Task ^ RenderRootComponentAsync(int componentId);
protected System.Threading.Tasks.Task RenderRootComponentAsync (int componentId);
member this.RenderRootComponentAsync : int -> System.Threading.Tasks.Task
Protected Function RenderRootComponentAsync (componentId As Integer) As Task

Parameters

componentId
Int32

The ID returned by AssignRootComponentId(IComponent).

Returns

Task

Remarks

Rendering a root component is an asynchronous operation. Clients may choose to not await the returned task to start, but not wait for the entire render to complete.

Applies to

RenderRootComponentAsync(Int32, ParameterView)

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

Supplies parameters for a root component, normally causing it to render. This can be used to trigger the first render of a root component, or to update its parameters and trigger a subsequent render. Note that components may also make their own decisions about when to re-render, and may re-render at any time.

The returned Task waits for this component and all descendant components to finish rendering in case there is any asynchronous work being done by any of them.

protected:
 System::Threading::Tasks::Task ^ RenderRootComponentAsync(int componentId, Microsoft::AspNetCore::Components::ParameterView initialParameters);
protected System.Threading.Tasks.Task RenderRootComponentAsync (int componentId, Microsoft.AspNetCore.Components.ParameterView initialParameters);
protected internal System.Threading.Tasks.Task RenderRootComponentAsync (int componentId, Microsoft.AspNetCore.Components.ParameterView initialParameters);
member this.RenderRootComponentAsync : int * Microsoft.AspNetCore.Components.ParameterView -> System.Threading.Tasks.Task
Protected Function RenderRootComponentAsync (componentId As Integer, initialParameters As ParameterView) As Task
Protected Friend Function RenderRootComponentAsync (componentId As Integer, initialParameters As ParameterView) As Task

Parameters

componentId
Int32

The ID returned by AssignRootComponentId(IComponent).

initialParameters
ParameterView

The ParameterView with the initial or updated parameters to use for rendering.

Returns

Task

Remarks

Rendering a root component is an asynchronous operation. Clients may choose to not await the returned task to start, but not wait for the entire render to complete.

Applies to