Renderer Class

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.0-preview.5.22303.8

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Types in the Microsoft.AspNetCore.Components.RenderTree are not recommended for use outside of the Blazor framework. These types will change in a future release.

public ref class Renderer abstract : IDisposable

public ref class Renderer abstract : IAsyncDisposable, IDisposable

public abstract class Renderer : IDisposable

public abstract class Renderer : IAsyncDisposable, IDisposable

type Renderer = class
    interface IDisposable

type Renderer = class
    interface IDisposable
    interface IAsyncDisposable

Public MustInherit Class Renderer
Implements IDisposable

Public MustInherit Class Renderer
Implements IAsyncDisposable, IDisposable

Inheritance: Object
Renderer

Derived: Microsoft.AspNetCore.Components.RenderTree.WebRenderer

Implements: IDisposable IAsyncDisposable

Constructors

Renderer(IServiceProvider, ILoggerFactory)	Constructs an instance of Renderer.
Renderer(IServiceProvider, ILoggerFactory, IComponentActivator)	Constructs an instance of Renderer.

Properties

Dispatcher	Gets the Dispatcher associated with this Renderer.
ElementReferenceContext	Gets or sets the ElementReferenceContext associated with this Renderer, if it exists.

Methods

AssignRootComponentId(IComponent)	Associates the IComponent with the Renderer, assigning an identifier that is unique within the scope of the Renderer.
DispatchEventAsync(UInt64, EventFieldInfo, EventArgs)	Notifies the renderer that an event has occurred.
Dispose()	Releases all resources currently used by this Renderer instance.
Dispose(Boolean)	Releases all resources currently used by this Renderer instance.
DisposeAsync()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.
GetCurrentRenderTreeFrames(Int32)	Gets the current render tree for a given component.
GetEventArgsType(UInt64)	Gets the event arguments type for the specified event handler.
HandleException(Exception)	Allows derived types to handle exceptions during rendering. Defaults to rethrowing the original exception.
InstantiateComponent(Type)	Constructs a new component of the specified type.
ProcessPendingRender()	Processes pending renders requests from components if there are any.
RemoveRootComponent(Int32)	Removes the specified component from the renderer, causing the component and its descendants to be disposed.
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.
UpdateDisplayAsync(RenderBatch)	Updates the visible UI.

Events

UnhandledSynchronizationException

Allows the caller to handle exceptions from the SynchronizationContext when one is available.

Applies to