EnvironmentBoundary クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
現在のホスティング環境が指定した環境名のいずれかに一致する場合にのみ、その子コンテンツをレンダリングするコンポーネント。
public sealed class EnvironmentBoundary : Microsoft.AspNetCore.Components.ComponentBasetype EnvironmentBoundary = class
inherit ComponentBasePublic NotInheritable Class EnvironmentBoundary
Inherits ComponentBase- 継承
注釈
このコンポーネントは、MVC および Razor Pages の環境タグ ヘルパーに似ています。
<EnvironmentBoundary Include="Development">
<div class="alert alert-warning">
You are running in Development mode. Debug features are enabled.
</div>
</EnvironmentBoundary>
<EnvironmentBoundary Include="Development, Staging">
<p>This is a pre-production environment.</p>
</EnvironmentBoundary>
<EnvironmentBoundary Exclude="Production">
<p>Debug information: @DateTime.Now</p>
</EnvironmentBoundary>
コンストラクター
| 名前 | 説明 |
|---|---|
| EnvironmentBoundary() |
現在のホスティング環境が指定した環境名のいずれかに一致する場合にのみ、その子コンテンツをレンダリングするコンポーネント。 |
プロパティ
| 名前 | 説明 |
|---|---|
| Assets |
アプリケーションの ResourceAssetCollection を取得します。 (継承元 ComponentBase) |
| AssignedRenderMode |
このコンポーネントに割り当てられている IComponentRenderMode を取得します。 (継承元 ComponentBase) |
| ChildContent |
環境が一致したときにレンダリングされるコンテンツを取得または設定します。 |
| Exclude |
コンテンツがレンダリングされない環境名のコンマ区切りのリストを取得または設定します。 |
| Include |
コンテンツをレンダリングする環境名のコンマ区切りのリストを取得または設定します。 現在の環境も Exclude リストに含まれている場合、コンテンツはレンダリングされません。 |
| RendererInfo |
コンポーネントが実行されている RendererInfo を取得します。 (継承元 ComponentBase) |
メソッド
| 名前 | 説明 |
|---|---|
| BuildRenderTree(RenderTreeBuilder) |
指定した RenderTreeBuilderにコンポーネントをレンダリングします。 (継承元 ComponentBase) |
| DispatchExceptionAsync(Exception) |
指定された これは、コンポーネント ライフサイクル メソッドの外部で例外が発生したが、コンポーネント ライフサイクル メソッドからの例外と同じように処理する場合に便利です。 (継承元 ComponentBase) |
| InvokeAsync(Action) |
関連付けられたレンダラーの同期コンテキストで、指定された作業項目を実行します。 (継承元 ComponentBase) |
| InvokeAsync(Func<Task>) |
関連付けられたレンダラーの同期コンテキストで、指定された作業項目を実行します。 (継承元 ComponentBase) |
| OnAfterRender(Boolean) |
コンポーネントが対話形式でレンダリングされ、UI の更新が完了するたびに呼び出されるメソッド (たとえば、ブラウザー DOM に要素が追加された後)。 ElementReferenceフィールドは、この実行時までに設定されます。 これらのプロセスはライブ ブラウザー DOM にアタッチされておらず、DOM が更新される前に既に完了しているため、プリレンダリング中またはサーバー側のレンダリング中にこのメソッドは呼び出されません。 (継承元 ComponentBase) |
| OnAfterRenderAsync(Boolean) |
コンポーネントが対話形式でレンダリングされ、UI の更新が完了するたびに呼び出されるメソッド (たとえば、要素がブラウザー DOM に追加された後)。 ElementReferenceフィールドは、この実行時までに設定されます。 これらのプロセスはライブ ブラウザー DOM にアタッチされておらず、DOM が更新される前に既に完了しているため、プリレンダリング中またはサーバー側のレンダリング中にこのメソッドは呼び出されません。 コンポーネントは、返された Taskが完了した後に自動的に再レンダリングされないことに注意してください。これは、無限のレンダリング ループが発生するためです。 (継承元 ComponentBase) |
| OnInitialized() |
コンポーネントを起動する準備ができたときに呼び出されるメソッド。レンダー ツリー内の親から初期パラメーターを受け取りました。 (継承元 ComponentBase) |
| OnInitializedAsync() |
コンポーネントを起動する準備ができたときに呼び出されるメソッド。レンダー ツリー内の親から初期パラメーターを受け取りました。 非同期操作を実行し、その操作が完了したときにコンポーネントを更新する場合は、このメソッドをオーバーライドします。 (継承元 ComponentBase) |
| OnParametersSet() |
コンポーネントがレンダー ツリー内の親からパラメーターを受け取り、受信値がプロパティに割り当てられているときに呼び出されるメソッド。 (継承元 ComponentBase) |
| OnParametersSetAsync() |
コンポーネントがレンダー ツリー内の親からパラメーターを受け取り、受信値がプロパティに割り当てられているときに呼び出されるメソッド。 (継承元 ComponentBase) |
| SetParametersAsync(ParameterView) |
レンダー ツリー内のコンポーネントの親によって提供されるパラメーターを設定します。 (継承元 ComponentBase) |
| ShouldRender() |
コンポーネントをレンダリングするかどうかを示すフラグを返します。 (継承元 ComponentBase) |
| StateHasChanged() |
状態が変更されたことをコンポーネントに通知します。 該当する場合は、コンポーネントが再レンダリングされます。 (継承元 ComponentBase) |
明示的なインターフェイスの実装
| 名前 | 説明 |
|---|---|
| IComponent.Attach(RenderHandle) |
現在のホスティング環境が指定した環境名のいずれかに一致する場合にのみ、その子コンテンツをレンダリングするコンポーネント。 (継承元 ComponentBase) |
| IHandleAfterRender.OnAfterRenderAsync() |
現在のホスティング環境が指定した環境名のいずれかに一致する場合にのみ、その子コンテンツをレンダリングするコンポーネント。 (継承元 ComponentBase) |
| IHandleEvent.HandleEventAsync(EventCallbackWorkItem, Object) |
現在のホスティング環境が指定した環境名のいずれかに一致する場合にのみ、その子コンテンツをレンダリングするコンポーネント。 (継承元 ComponentBase) |