ComponentBase クラス

  • リファレンス

定義

名前空間:
Microsoft.AspNetCore.Components
アセンブリ:
Microsoft.AspNetCore.Components.dll
パッケージ:
Microsoft.AspNetCore.Components v3.0.3
パッケージ:
Microsoft.AspNetCore.Components v3.1.18
パッケージ:
Microsoft.AspNetCore.Components v5.0.9
パッケージ:
Microsoft.AspNetCore.Components v6.0.6
パッケージ:
Microsoft.AspNetCore.Components v7.0.5
パッケージ:
Microsoft.AspNetCore.Components v8.0.0

コンポーネントの省略可能な基底クラス。 または、コンポーネントを直接実装 IComponent することもできます。

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 IHandleEvent
    interface IHandleAfterRender
Public MustInherit Class ComponentBase
Implements IComponent, IHandleAfterRender, IHandleEvent
継承
Object
ComponentBase
派生
実装
IComponent IHandleAfterRender IHandleEvent

コンストラクター

ComponentBase()

のインスタンス ComponentBaseを構築します。

メソッド

BuildRenderTree(RenderTreeBuilder)

コンポーネントを指定された RenderTreeBuilderにレンダリングします。
DispatchExceptionAsync(Exception)

指定された exception を、このコンポーネントによってスローされると見なします。 これにより、外側の ErrorBoundary が失敗状態に遷移します。 囲み ErrorBoundary がない場合、それを囲むレンダラーからの例外と見なされます。

これは、コンポーネント ライフサイクル メソッドの外部で例外が発生したが、コンポーネント ライフサイクル メソッドの例外と同じように処理する場合に便利です。
InvokeAsync(Action)

関連付けられたレンダラーの同期コンテキストで、指定された作業項目を実行します。
InvokeAsync(Func<Task>)

関連付けられたレンダラーの同期コンテキストで、指定された作業項目を実行します。
OnAfterRender(Boolean)

コンポーネントが対話形式でレンダリングされ、UI の更新が完了するたびに呼び出されるメソッド (たとえば、ブラウザー DOM に要素が追加された後)。 すべての ElementReference フィールドは、この実行時までに設定されます。

これらのプロセスはライブ ブラウザー DOM にアタッチされておらず、DOM が更新される前に既に完了しているため、プリレンダリング中またはサーバー側のレンダリング中にこのメソッドは呼び出されません。
OnAfterRenderAsync(Boolean)

コンポーネントが対話形式でレンダリングされ、UI の更新が完了するたびに呼び出されるメソッド (たとえば、ブラウザー DOM に要素が追加された後)。 すべての ElementReference フィールドは、この実行時までに設定されます。

これらのプロセスはライブ ブラウザー DOM にアタッチされておらず、DOM が更新される前に既に完了しているため、プリレンダリング中またはサーバー側のレンダリング中にこのメソッドは呼び出されません。

コンポーネントは、返された Taskの完了後に自動的に再レンダリングされないことに注意してください。これは、無限のレンダリング ループが発生するためです。
OnInitialized()

コンポーネントが起動する準備ができたときに呼び出されるメソッド。レンダリング ツリー内の親から初期パラメーターを受け取ります。
OnInitializedAsync()

コンポーネントが起動する準備ができたときに呼び出されるメソッド。レンダリング ツリー内の親から初期パラメーターを受け取ります。

非同期操作を実行し、その操作が完了したときにコンポーネントを更新する場合は、このメソッドをオーバーライドします。
OnParametersSet()

コンポーネントがレンダー ツリー内の親からパラメーターを受け取り、受信値がプロパティに割り当てられているときに呼び出されるメソッド。
OnParametersSetAsync()

コンポーネントがレンダー ツリー内の親からパラメーターを受け取り、受信値がプロパティに割り当てられているときに呼び出されるメソッド。
SetParametersAsync(ParameterView)

レンダリング ツリー内のコンポーネントの親によって提供されるパラメーターを設定します。
ShouldRender()

コンポーネントをレンダリングするかどうかを示すフラグを返します。
StateHasChanged()

状態が変更されたことをコンポーネントに通知します。 必要に応じて、コンポーネントが再レンダリングされます。

明示的なインターフェイスの実装

IComponent.Attach(RenderHandle)

コンポーネントの省略可能な基底クラス。 または、コンポーネントを直接実装 IComponent することもできます。
IHandleAfterRender.OnAfterRenderAsync()

コンポーネントの省略可能な基底クラス。 または、コンポーネントを直接実装 IComponent することもできます。
IHandleEvent.HandleEventAsync(EventCallbackWorkItem, Object)

コンポーネントの省略可能な基底クラス。 または、コンポーネントを直接実装 IComponent することもできます。

適用対象