ComponentBase Class

  • Reference

Definition

Namespace:
Microsoft.AspNetCore.Components
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-rc.2.24474.3
Source:
ComponentBase.cs
Source:
ComponentBase.cs
Source:
ComponentBase.cs
Source:
ComponentBase.cs
Source:
ComponentBase.cs
Source:
ComponentBase.cs
Source:
ComponentBase.cs

Optional base class for components. Alternatively, components may implement IComponent directly.

public ref class ComponentBase abstract : Microsoft::AspNetCore::Components::IComponent, Microsoft::AspNetCore::Components::IHandleAfterRender, Microsoft::AspNetCore::Components::IHandleEvent
public abstract class ComponentBase : Microsoft.AspNetCore.Components.IComponent, Microsoft.AspNetCore.Components.IHandleAfterRender, Microsoft.AspNetCore.Components.IHandleEvent
type ComponentBase = class
    interface IComponent
    interface IHandleAfterRender
    interface IHandleEvent
type ComponentBase = class
    interface IComponent
    interface IHandleEvent
    interface IHandleAfterRender
Public MustInherit Class ComponentBase
Implements IComponent, IHandleAfterRender, IHandleEvent
Inheritance
Object
ComponentBase
Derived
Implements
IComponent IHandleAfterRender IHandleEvent

Constructors

ComponentBase()

Constructs an instance of ComponentBase.

Properties

Assets

Gets the ResourceAssetCollection for the application.
AssignedRenderMode

Gets the IComponentRenderMode assigned to this component.
RendererInfo

Gets the RendererInfo the component is running on.

Methods

BuildRenderTree(RenderTreeBuilder)

Renders the component to the supplied RenderTreeBuilder.
DispatchExceptionAsync(Exception)

Treats the supplied exception as being thrown by this component. This will cause the enclosing ErrorBoundary to transition into a failed state. If there is no enclosing ErrorBoundary, it will be regarded as an exception from the enclosing renderer.

This is useful if an exception occurs outside the component lifecycle methods, but you wish to treat it the same as an exception from a component lifecycle method.
InvokeAsync(Action)

Executes the supplied work item on the associated renderer's synchronization context.
InvokeAsync(Func<Task>)

Executes the supplied work item on the associated renderer's synchronization context.
OnAfterRender(Boolean)

Method invoked after each time the component has rendered interactively and the UI has finished updating (for example, after elements have been added to the browser DOM). Any ElementReference fields will be populated by the time this runs.

This method is not invoked during prerendering or server-side rendering, because those processes are not attached to any live browser DOM and are already complete before the DOM is updated.
OnAfterRenderAsync(Boolean)

Method invoked after each time the component has been rendered interactively and the UI has finished updating (for example, after elements have been added to the browser DOM). Any ElementReference fields will be populated by the time this runs.

This method is not invoked during prerendering or server-side rendering, because those processes are not attached to any live browser DOM and are already complete before the DOM is updated.

Note that the component does not automatically re-render after the completion of any returned Task, because that would cause an infinite render loop.
OnInitialized()

Method invoked when the component is ready to start, having received its initial parameters from its parent in the render tree.
OnInitializedAsync()

Method invoked when the component is ready to start, having received its initial parameters from its parent in the render tree.

Override this method if you will perform an asynchronous operation and want the component to refresh when that operation is completed.
OnParametersSet()

Method invoked when the component has received parameters from its parent in the render tree, and the incoming values have been assigned to properties.
OnParametersSetAsync()

Method invoked when the component has received parameters from its parent in the render tree, and the incoming values have been assigned to properties.
SetParametersAsync(ParameterView)

Sets parameters supplied by the component's parent in the render tree.
ShouldRender()

Returns a flag to indicate whether the component should render.
StateHasChanged()

Notifies the component that its state has changed. When applicable, this will cause the component to be re-rendered.

Explicit Interface Implementations

IComponent.Attach(RenderHandle)
IHandleAfterRender.OnAfterRenderAsync()
IHandleEvent.HandleEventAsync(EventCallbackWorkItem, Object)

Applies to