PageContext class
Objet de contexte de page SharePoint.
Remarques
Le contexte de la page fournit des définitions standard pour les objets SharePoint communs qui doivent être partagés entre l’application cliente, les composants WebPart et d’autres composants. Généralement, les données sont récupérées par l’intermédiaire des requêtes REST lors de l’accès à une nouvelle page, mais elles peuvent également être préchargées par le serveur Web ou remplies à partir d’un cache d’application personnalisé.
Constructeurs
| (constructor)(service |
Construit une nouvelle instance de la |
Propriétés
| aad |
Informations contextuelles pour communiquer avec Azure Active Directory. Si aucun locataire Azure Active Directory n’est associé à la page active active, cette propriété n’est pas définie. |
| culture |
Elle fournit les informations culturelles à l’utilisateur de l’application. Cette classe est principalement utilisée avec la |
| is |
Retourne si le |
| legacy |
Objet fournissant des propriétés SharePoint classiques qui peuvent être requises par certains scripts hérités. |
| list | Informations contextuelles pour la liste SharePoint qui héberge la page. Si aucune liste n’est associée à la page active, cette propriété n’est pas définie. |
| list |
Informations contextuelles pour l’élément de liste SharePoint qui héberge la page. Si aucun élément de liste n’est associé à la page active, cette propriété n’est pas définie. |
| service |
Clé de service pour PageContext. |
| site | Informations contextuelles pour la collection de sites SharePoint (« SPSite ») qui héberge la page. |
| user | Elle fournit des informations contextuelles pour l’utilisateur SharePoint qui accède à la page. Cette classe est principalement utilisée avec la |
| web | Informations contextuelles pour le site SharePoint (« SPWeb ») qui héberge la page. |
Détails du constructeur
(constructor)(serviceScope)
Construit une nouvelle instance de la PageContext classe
constructor(serviceScope: ServiceScope);Paramètres
- serviceScope
- ServiceScope
Détails de la propriété
aadInfo
Informations contextuelles pour communiquer avec Azure Active Directory. Si aucun locataire Azure Active Directory n’est associé à la page active active, cette propriété n’est pas définie.
get aadInfo(): AzureActiveDirectoryInfo | undefined;Valeur de propriété
@microsoft/sp-page-context!AzureActiveDirectoryInfo:class | undefined
cultureInfo
Elle fournit les informations culturelles à l’utilisateur de l’application. Cette classe est principalement utilisée avec la PageContext classe .
get cultureInfo(): CultureInfo;Valeur de propriété
isInitialized
Retourne si le PageContext a été initialisé.
get isInitialized(): boolean;Valeur de propriété
boolean
legacyPageContext
Objet fournissant des propriétés SharePoint classiques qui peuvent être requises par certains scripts hérités.
get legacyPageContext(): any;Valeur de propriété
any
Remarques
Cette propriété est fournie pour faciliter la migration du code hérité. Elle renvoie un objet JavaScript dont le contenu est similaire à la _spPageContextInfo variable de fenêtre des pages classiques. Le contenu de cette variable peut changer dans les versions ultérieures de SharePoint. C’est pourquoi les nouveaux projets sont encouragés à utiliser les API TypeScript SharePoint Framework à la place, car ils sont entièrement documentés et fournissent des garanties de compatibilité descendante fiables.
REMARQUE : Si certaines fonctionnalités sont exposées dans le legacyPageContext mais ne semblent pas avoir une API TypeScript appropriée, veuillez signaler un problème sur GitHub. L’intention est qu’aucune application moderne ne doit avoir besoin de s’appuyer sur l’objet legacyPageContext .
list
Informations contextuelles pour la liste SharePoint qui héberge la page. Si aucune liste n’est associée à la page active, cette propriété n’est pas définie.
get list(): SPList | undefined;Valeur de propriété
SPList | undefined
listItem
Informations contextuelles pour l’élément de liste SharePoint qui héberge la page. Si aucun élément de liste n’est associé à la page active, cette propriété n’est pas définie.
get listItem(): SPListItem | undefined;Valeur de propriété
SPListItem | undefined
serviceKey
Clé de service pour PageContext.
static readonly serviceKey: ServiceKey<PageContext>;Valeur de propriété
site
Informations contextuelles pour la collection de sites SharePoint (« SPSite ») qui héberge la page.
get site(): SPSite;Valeur de propriété
user
Elle fournit des informations contextuelles pour l’utilisateur SharePoint qui accède à la page. Cette classe est principalement utilisée avec la PageContext classe .
get user(): SPUser;Valeur de propriété
web
Informations contextuelles pour le site SharePoint (« SPWeb ») qui héberge la page.
get web(): SPWeb;