EnvironmentBoundary 类
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
仅当当前宿主环境与指定环境名称之一匹配时,组件才会呈现其子内容。
public sealed class EnvironmentBoundary : Microsoft.AspNetCore.Components.ComponentBase
type EnvironmentBoundary = class
inherit ComponentBase
Public 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) |