OwningComponentBase<TService> Class

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.

A base class that creates a service provider scope, and resolves a service of type TService.

generic <typename TService>
public ref class OwningComponentBase abstract : Microsoft::AspNetCore::Components::OwningComponentBase, IDisposable

public abstract class OwningComponentBase<TService> : Microsoft.AspNetCore.Components.OwningComponentBase, IDisposable

type OwningComponentBase<'Service> = class
    inherit OwningComponentBase
    interface IDisposable

Public MustInherit Class OwningComponentBase(Of TService)
Inherits OwningComponentBase
Implements IDisposable

Type Parameters

TService

The service type.

Inheritance: Object

ComponentBase

OwningComponentBase
OwningComponentBase<TService>

Implements: IDisposable

Remarks

Use the OwningComponentBase<TService> class as a base class to author components that control the lifetime of a service or multiple services. This is useful when using a transient or scoped service that requires disposal such as a repository or database abstraction. Using OwningComponentBase<TService> as a base class ensures that the service and relates services that share its scope are disposed with the component.

Constructors

OwningComponentBase<TService>()

Properties

Assets	Gets the ResourceAssetCollection for the application. (Inherited from ComponentBase)
AssignedRenderMode	Gets the IComponentRenderMode assigned to this component. (Inherited from ComponentBase)
IsDisposed	Gets a value determining if the component and associated services have been disposed. (Inherited from OwningComponentBase)
RendererInfo	Gets the RendererInfo the component is running on. (Inherited from ComponentBase)
ScopedServices	Gets the scoped IServiceProvider that is associated with this component. (Inherited from OwningComponentBase)
Service	Gets the `TService` that is associated with this component.

Methods

BuildRenderTree(RenderTreeBuilder)	Renders the component to the supplied RenderTreeBuilder. (Inherited from ComponentBase)
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)
Dispose(Boolean)	(Inherited from OwningComponentBase)
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)
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()	(Inherited from OwningComponentBase)
IHandleAfterRender.OnAfterRenderAsync()	(Inherited from ComponentBase)
IHandleEvent.HandleEventAsync(EventCallbackWorkItem, Object)	(Inherited from ComponentBase)

Applies to

Share via