ErrorBoundary Class

Definition

Namespace:

Microsoft.AspNetCore.Components.Web

Assembly:

Microsoft.AspNetCore.Components.Web.dll

Package:

Microsoft.AspNetCore.Components.Web v8.0.0

Source:

ErrorBoundary.cs

Captures errors thrown from its child content.

public class ErrorBoundary : Microsoft.AspNetCore.Components.ErrorBoundaryBase

type ErrorBoundary = class
    inherit ErrorBoundaryBase

Public Class ErrorBoundary
Inherits ErrorBoundaryBase

Inheritance

Object

ComponentBase

ErrorBoundaryBase

ErrorBoundary

Constructors

ErrorBoundary()

Properties

ChildContent	The content to be displayed when there is no error. (Inherited from ErrorBoundaryBase)
CurrentException	Gets the current exception, or null if there is no exception. (Inherited from ErrorBoundaryBase)
ErrorContent	The content to be displayed when there is an error. (Inherited from ErrorBoundaryBase)
MaximumErrorCount	The maximum number of errors that can be handled. If more errors are received, they will be treated as fatal. Calling Recover() resets the count. (Inherited from ErrorBoundaryBase)

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. (Inherited from ComponentBase)
InvokeAsync(Action)	Executes the supplied work item on the associated renderer's synchronization context. (Inherited from ComponentBase)
InvokeAsync(Func<Task>)	Executes the supplied work item on the associated renderer's synchronization context. (Inherited from ComponentBase)
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. (Inherited from ComponentBase)
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. (Inherited from ComponentBase)
OnErrorAsync(Exception)	Invoked by the base class when an error is being handled. The default implementation logs the error.
OnInitialized()	Method invoked when the component is ready to start, having received its initial parameters from its parent in the render tree. (Inherited from ComponentBase)
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. (Inherited from ComponentBase)
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. (Inherited from ComponentBase)
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. (Inherited from ComponentBase)
Recover()	Resets the error boundary to a non-errored state. If the error boundary is not already in an errored state, the call has no effect. (Inherited from ErrorBoundaryBase)
SetParametersAsync(ParameterView)	Sets parameters supplied by the component's parent in the render tree. (Inherited from ComponentBase)
ShouldRender()	Returns a flag to indicate whether the component should render. (Inherited from ComponentBase)
StateHasChanged()	Notifies the component that its state has changed. When applicable, this will cause the component to be re-rendered. (Inherited from ComponentBase)

Explicit Interface Implementations

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