EnvironmentBoundary Classe

Définition

Espace de noms:
Microsoft.AspNetCore.Components.Web
Assembly:
Microsoft.AspNetCore.Components.Web.dll
Paquet:
Microsoft.AspNetCore.Components.Web v11.0.0-preview.3.26207.106
Source:
EnvironmentBoundary.cs

Composant qui affiche son contenu enfant uniquement lorsque l’environnement d’hébergement actuel correspond à l’un des noms d’environnement spécifiés.

public sealed class EnvironmentBoundary : Microsoft.AspNetCore.Components.ComponentBase
type EnvironmentBoundary = class
    inherit ComponentBase
Public NotInheritable Class EnvironmentBoundary
Inherits ComponentBase
Héritage
Object
ComponentBase
EnvironmentBoundary

Remarques

Ce composant est similaire au tag helper d’environnement dans les pages MVC et Razor.

L’exemple suivant montre comment afficher le contenu de manière conditionnelle en fonction de l’environnement : 
<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>

Constructeurs

Nom Description
EnvironmentBoundary()

Composant qui affiche son contenu enfant uniquement lorsque l’environnement d’hébergement actuel correspond à l’un des noms d’environnement spécifiés.

Propriétés

Nom Description
Assets

Obtient l’application ResourceAssetCollection .

(Hérité de ComponentBase)
AssignedRenderMode

Obtient l’affectation IComponentRenderMode à ce composant.

(Hérité de ComponentBase)
ChildContent

Obtient ou définit le contenu à afficher lorsque l’environnement correspond.
Exclude

Obtient ou définit une liste séparée par des virgules de noms d’environnement dans laquelle le contenu ne sera pas rendu.
Include

Obtient ou définit une liste séparée par des virgules des noms d’environnement dans lesquels le contenu doit être rendu. Si l’environnement actuel figure également dans la Exclude liste, le contenu ne sera pas rendu.
RendererInfo

Obtient le RendererInfo composant en cours d’exécution.

(Hérité de ComponentBase)

Méthodes

Nom Description
BuildRenderTree(RenderTreeBuilder)

Affiche le composant sur le composant fourni RenderTreeBuilder.

(Hérité de ComponentBase)
DispatchExceptionAsync(Exception)

Traite l’élément fourni exception comme étant levée par ce composant. Cela entraîne la transition de la limite d’erreur englobante en état d’échec. S’il n’existe aucune limite d’erreur englobante, elle est considérée comme une exception du renderer englobant.

Cela est utile si une exception se produit en dehors des méthodes de cycle de vie des composants, mais que vous souhaitez la traiter comme une exception d’une méthode de cycle de vie de composant.

(Hérité de ComponentBase)
InvokeAsync(Action)

Exécute l’élément de travail fourni dans le contexte de synchronisation du renderer associé.

(Hérité de ComponentBase)
InvokeAsync(Func<Task>)

Exécute l’élément de travail fourni dans le contexte de synchronisation du renderer associé.

(Hérité de ComponentBase)
OnAfterRender(Boolean)

Méthode appelée après chaque rendu interactif du composant et de la mise à jour de l’interface utilisateur (par exemple, après l’ajout d’éléments au DOM du navigateur). Tous les ElementReference champs seront renseignés au moment de l’exécution.

Cette méthode n’est pas appelée pendant le rendu côté serveur ou avant l’affichage côté serveur, car ces processus ne sont pas attachés à un DOM de navigateur en direct et sont déjà terminés avant la mise à jour du DOM.

(Hérité de ComponentBase)
OnAfterRenderAsync(Boolean)

Méthode appelée après chaque rendu interactif du composant et de la mise à jour de l’interface utilisateur (par exemple, après l’ajout d’éléments au DOM du navigateur). Tous les ElementReference champs seront renseignés au moment de l’exécution.

Cette méthode n’est pas appelée pendant le rendu côté serveur ou avant l’affichage côté serveur, car ces processus ne sont pas attachés à un DOM de navigateur en direct et sont déjà terminés avant la mise à jour du DOM.

Notez que le composant ne réexécure pas automatiquement après l’achèvement d’un élément retourné Task, car cela provoquerait une boucle de rendu infinie.

(Hérité de ComponentBase)
OnInitialized()

Méthode appelée lorsque le composant est prêt à démarrer, ayant reçu ses paramètres initiaux de son parent dans l’arborescence de rendu.

(Hérité de ComponentBase)
OnInitializedAsync()

Méthode appelée lorsque le composant est prêt à démarrer, ayant reçu ses paramètres initiaux de son parent dans l’arborescence de rendu.

Remplacez cette méthode si vous effectuez une opération asynchrone et souhaitez que le composant s’actualise une fois cette opération terminée.

(Hérité de ComponentBase)
OnParametersSet()

Méthode appelée lorsque le composant a reçu des paramètres de son parent dans l’arborescence de rendu et que les valeurs entrantes ont été affectées aux propriétés.

(Hérité de ComponentBase)
OnParametersSetAsync()

Méthode appelée lorsque le composant a reçu des paramètres de son parent dans l’arborescence de rendu et que les valeurs entrantes ont été affectées aux propriétés.

(Hérité de ComponentBase)
SetParametersAsync(ParameterView)

Définit les paramètres fournis par le parent du composant dans l’arborescence de rendu.

(Hérité de ComponentBase)
ShouldRender()

Retourne un indicateur pour indiquer si le composant doit être rendu.

(Hérité de ComponentBase)
StateHasChanged()

Avertit le composant que son état a changé. Le cas échéant, le composant sera recréé.

(Hérité de ComponentBase)

Implémentations d’interfaces explicites

Nom Description
IComponent.Attach(RenderHandle)

Composant qui affiche son contenu enfant uniquement lorsque l’environnement d’hébergement actuel correspond à l’un des noms d’environnement spécifiés.

(Hérité de ComponentBase)
IHandleAfterRender.OnAfterRenderAsync()

Composant qui affiche son contenu enfant uniquement lorsque l’environnement d’hébergement actuel correspond à l’un des noms d’environnement spécifiés.

(Hérité de ComponentBase)
IHandleEvent.HandleEventAsync(EventCallbackWorkItem, Object)

Composant qui affiche son contenu enfant uniquement lorsque l’environnement d’hébergement actuel correspond à l’un des noms d’environnement spécifiés.

(Hérité de ComponentBase)

S’applique à