BaseComponent class

Paquet:

@microsoft/sp-component-base

Classe de base pour les composants côté client tels que BaseClientSideWebPart ou BaseExtension.

Remarques

Le constructeur de cette classe est marqué comme interne. Le code tiers ne doit pas appeler directement le constructeur ou créer des sous-classes qui étendent la BaseComponent classe.

Propriétés

componentId	Retourne l’identificateur de composant tel que défini dans le manifeste associé du composant.
context	Utilisez l’objet de contexte pour accéder aux services courants et à l’état associés au composant.
instanceId	Identificateur unique pour la instance du composant.
isDisposed	Retourne true si le composant a déjà été supprimé.
manifest	Fournit l’accès au manifeste pour le composant côté client. virtuel

Méthodes

dispose()	Supprime le composant.
onDispose()	Cette méthode d’événement est appelée à la fin du cycle de vie du composant. Il offre la possibilité de libérer toutes les ressources associées, d’annuler toutes les demandes en attente, etc. virtuelles

Détails de la propriété

componentId

Retourne l’identificateur de composant tel que défini dans le manifeste associé du composant.

get componentId(): string;

Valeur de propriété

string

Remarques

Chaque composant côté client a un manifeste associé qui est utilisé par le sp-loader pour charger ses scripts et qui peut inclure des métadonnées supplémentaires sur le composant. Le manifeste est identifié de manière unique à l’aide d’une chaîne de texte contenant une valeur GUID en minuscules.

context

Utilisez l’objet de contexte pour accéder aux services courants et à l’état associés au composant.

protected context?: BaseComponentContext;

Valeur de propriété

BaseComponentContext

Remarques

Les classes enfants sont censées remplacer ce champ en le redeclarant avec un type spécialisé. Il s’agit d’une propriété en lecture seule ; Le type ne peut pas être déclaré en lecture seule dans la classe de base (car il est initialisé en dehors du constructeur), mais les classes enfants doivent le redéclarer en lecture seule.

instanceId

Identificateur unique pour la instance du composant.

get instanceId(): string;

Valeur de propriété

string

Remarques

Une implémentation de composant peut être chargée plusieurs fois sur la page. Par exemple, si le composant est un composant WebPart de graphique, plusieurs instances de ce composant WebPart peuvent être ajoutées au canevas SharePoint. L’instanceId identifie de manière unique chacune de ces instances.

isDisposed

Retourne true si le composant a déjà été supprimé.

get isDisposed(): boolean;

Valeur de propriété

boolean

manifest

Fournit l’accès au manifeste pour le composant côté client. virtuel

get manifest(): IClientSideComponentManifest;

Valeur de propriété

IClientSideComponentManifest

Remarques

Les classes enfants peuvent remplacer cela par des types de manifeste plus spécialisés.

Détails de la méthode

dispose()

Supprime le composant.

dispose(): void;

Retours

void

Remarques

Le code tiers n’a généralement pas besoin d’appeler cette méthode ; il est appelé automatiquement lorsque le cycle de vie se termine pour un composant WebPart ou une extension. Pour effectuer un nettoyage personnalisé lorsque votre composant est supprimé, remplacez la méthode BaseComponent.onDispose().

onDispose()

Cette méthode d’événement est appelée à la fin du cycle de vie du composant. Il offre la possibilité de libérer toutes les ressources associées, d’annuler toutes les demandes en attente, etc. virtuelles

protected onDispose(): void;

Retours

void