PageContext class
Das SharePoint-Seitenkontextobjekt.
Hinweise
Der Seitenkontext bietet Standarddefinitionen für allgemeine SharePoint-Objekte, die gemeinsam von der clientseitigen Anwendung, den Webparts und anderen Komponenten verwendet werden. In der Regel werden die Daten über REST-Abfragen beim Navigieren zu einer neuen Seite abgerufen, sie können jedoch auch vorab vom Webserver geladen werden oder aus einem benutzerdefinierten Anwendungscache aufgefüllt werden.
Konstruktoren
| (constructor)(service |
Erstellt eine neue instance der |
Eigenschaften
| aad |
Kontextinformationen für die Kommunikation mit Azure Active Directory. Wenn der aktuellen Seite kein Azure Active Directory-Mandant zugeordnet ist, ist diese Eigenschaft nicht definiert. |
| culture |
Sie stellt Gebietsschemainformationen für den aktuellen Benutzer der Anwendung bereit. Diese Klasse wird hauptsächlich mit der |
| is |
Gibt zurück, ob initialisiert |
| legacy |
Ein Objekt, das klassische SharePoint-Eigenschaften bereitstellt, die möglicherweise für bestimmte Legacyskripts erforderlich sind. |
| list | Kontextbezogene Informationen für die SharePoint-Liste, die die Seite hostet. Wenn der aktuellen Seite keine Liste zugeordnet ist, ist diese Eigenschaft nicht definiert. |
| list |
Kontextbezogene Informationen für das SharePoint-Listenelement, das die Seite hostet. Wenn der aktuellen Seite kein Listenelement zugeordnet ist, ist diese Eigenschaft nicht definiert. |
| page | Macht Informationen verfügbar, die der sharePoint-Webseite zugeordnet sind, die derzeit angezeigt wird. |
| service |
Der Diensschlüssel für PageContext. |
| site | Kontextinformationen für die SharePoint-Websitesammlung ("SPSite"), auf der die Seite gehostet wird. |
| user | Sie bietet kontextbezogene Informationen für den SharePoint-Benutzer, der auf die Seite zugreift. Diese Klasse wird hauptsächlich mit der |
| web | Kontextinformationen für die SharePoint-Website ("SPWeb"), auf der die Seite gehostet wird. |
Details zum Konstruktor
(constructor)(serviceScope)
Erstellt eine neue instance der PageContext -Klasse
constructor(serviceScope: ServiceScope);Parameter
- serviceScope
- ServiceScope
Details zur Eigenschaft
aadInfo
Kontextinformationen für die Kommunikation mit Azure Active Directory. Wenn der aktuellen Seite kein Azure Active Directory-Mandant zugeordnet ist, ist diese Eigenschaft nicht definiert.
get aadInfo(): AzureActiveDirectoryInfo | undefined;Eigenschaftswert
AzureActiveDirectoryInfo | undefined
cultureInfo
Sie stellt Gebietsschemainformationen für den aktuellen Benutzer der Anwendung bereit. Diese Klasse wird hauptsächlich mit der PageContext -Klasse verwendet.
get cultureInfo(): CultureInfo;Eigenschaftswert
isInitialized
Gibt zurück, ob initialisiert PageContext wurde.
get isInitialized(): boolean;Eigenschaftswert
boolean
legacyPageContext
Ein Objekt, das klassische SharePoint-Eigenschaften bereitstellt, die möglicherweise für bestimmte Legacyskripts erforderlich sind.
get legacyPageContext(): any;Eigenschaftswert
any
Hinweise
Diese Eigenschaft wird zur Erleichterung der Migration von Legacycode bereitgestellt. Es wird ein JavaScript-Objekt zurückgegeben, dessen Inhalt der _spPageContextInfo Fenstervariablen von klassischen Seiten ähnelt. Der Inhalt dieser Variablen kann sich in zukünftigen Versionen von SharePoint ändern. Aus diesem Grund wird für neue Projekte empfohlen, stattdessen die SharePoint-Framework TypeScript-APIs zu verwenden, da sie vollständig dokumentiert sind und zuverlässige Abwärtskompatibilitätsgarantien bieten.
HINWEIS: Wenn bestimmte Funktionen in verfügbar legacyPageContext gemacht werden, aber anscheinend nicht über eine ordnungsgemäße TypeScript-API verfügen, melden Sie ein Problem auf GitHub. Die Absicht ist, dass keine moderne Anwendung auf das legacyPageContext -Objekt angewiesen sein sollte.
list
Kontextbezogene Informationen für die SharePoint-Liste, die die Seite hostet. Wenn der aktuellen Seite keine Liste zugeordnet ist, ist diese Eigenschaft nicht definiert.
get list(): SPList | undefined;Eigenschaftswert
SPList | undefined
listItem
Kontextbezogene Informationen für das SharePoint-Listenelement, das die Seite hostet. Wenn der aktuellen Seite kein Listenelement zugeordnet ist, ist diese Eigenschaft nicht definiert.
get listItem(): SPListItem | undefined;Eigenschaftswert
SPListItem | undefined
page
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Macht Informationen verfügbar, die der sharePoint-Webseite zugeordnet sind, die derzeit angezeigt wird.
get page(): Page;Eigenschaftswert
serviceKey
Der Diensschlüssel für PageContext.
static readonly serviceKey: ServiceKey<PageContext>;Eigenschaftswert
site
Kontextinformationen für die SharePoint-Websitesammlung ("SPSite"), auf der die Seite gehostet wird.
get site(): SPSite;Eigenschaftswert
user
Sie bietet kontextbezogene Informationen für den SharePoint-Benutzer, der auf die Seite zugreift. Diese Klasse wird hauptsächlich mit der PageContext -Klasse verwendet.
get user(): SPUser;Eigenschaftswert
web
Kontextinformationen für die SharePoint-Website ("SPWeb"), auf der die Seite gehostet wird.
get web(): SPWeb;