OwningComponentBase Class

Definition

A base class that creates a service provider scope.

public ref class OwningComponentBase abstract : Microsoft::AspNetCore::Components::ComponentBase, IDisposable
public abstract class OwningComponentBase : Microsoft.AspNetCore.Components.ComponentBase, IDisposable
type OwningComponentBase = class
    inherit ComponentBase
    interface IDisposable
Public MustInherit Class OwningComponentBase
Inherits ComponentBase
Implements IDisposable
Inheritance
OwningComponentBase
Derived
Implements

Remarks

Use the OwningComponentBase class as a base class to author components that control the lifetime of a service provider scope. This is useful when using a transient or scoped service that requires disposal such as a repository or database abstraction. Using OwningComponentBase as a base class ensures that the service provider scope is disposed with the component.

Constructors

OwningComponentBase()

Properties

IsDisposed

Gets a value determining if the component and associated services have been disposed.

ScopedServices

Gets the scoped IServiceProvider that is associated with this component.

Methods

BuildRenderTree(RenderTreeBuilder)

Renders the component to the supplied RenderTreeBuilder.

(Inherited from ComponentBase)
Dispose(Boolean)
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 been rendered.

(Inherited from ComponentBase)
OnAfterRenderAsync(Boolean)

Method invoked after each time the component has been rendered. 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)
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)
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)
IDisposable.Dispose()
IHandleAfterRender.OnAfterRenderAsync() (Inherited from ComponentBase)
IHandleEvent.HandleEventAsync(EventCallbackWorkItem, Object) (Inherited from ComponentBase)

Applies to