Partager via

WebPartContext class

  • Référence
Paquet:
@microsoft/sp-webpart-base

Objet de contexte de composant WebPart. Cet objet contient les services contextuels disponibles pour un composant WebPart. par exemple, une instance contextuelle au client HTTP.

Extends
BaseWebPartContext

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 WebPartContext classe.

Propriétés

domElement

Référence à l’élément DOM qui héberge ce composant côté client.
microsoftTeams

Informations contextuelles sur l’onglet Microsoft Teams actuel. Cet objet est défini uniquement si un composant est hébergé dans Microsoft Teams.
sdks

Ensemble conditionnel de Kits de développement logiciel (SDK) fournis par SPFx dépendant de l’environnement.
statusRenderer

Récapitulatif de l’état du composant WebPart.
widthCacheKey

Cette fonction retourne une clé générée par le mode d’affichage des composants WebPart, l’index de disposition et le facteur de section. Elle retourne undefined si sectionFactor ou le mode d’affichage n’est pas défini ; sinon, retourne la clé de cache.

Détails de la propriété

domElement

Référence à l’élément DOM qui héberge ce composant côté client.

get domElement(): HTMLElement;

Valeur de propriété

HTMLElement

microsoftTeams

Avertissement

Cette API est à présent déconseillée.

  • This function has been deprecated

Informations contextuelles sur l’onglet Microsoft Teams actuel. Cet objet est défini uniquement si un composant est hébergé dans Microsoft Teams.

get microsoftTeams(): typeof microsoftTeams | undefined;

Valeur de propriété

typeof @microsoft/sp-webpart-base!~microsoftTeams | undefined

Remarques

Pour plus d’informations, consultez : https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest

sdks

Ensemble conditionnel de Kits de développement logiciel (SDK) fournis par SPFx dépendant de l’environnement.

get sdks(): ISDKs;

Valeur de propriété

ISDKs

statusRenderer

Récapitulatif de l’état du composant WebPart.

get statusRenderer(): IClientSideWebPartStatusRenderer;

Valeur de propriété

IClientSideWebPartStatusRenderer

widthCacheKey

Cette fonction retourne une clé générée par le mode d’affichage des composants WebPart, l’index de disposition et le facteur de section. Elle retourne undefined si sectionFactor ou le mode d’affichage n’est pas défini ; sinon, retourne la clé de cache.

get widthCacheKey(): string | undefined;

Valeur de propriété

string | undefined