BaseExtension class

Paket:

@microsoft/sp-extension-base

Die Basisklasse für alle clientseitigen Erweiterungen.

Extends

BaseComponent

Hinweise

Der Konstruktor für diese Klasse ist als intern gekennzeichnet. Drittanbietercode sollte den Konstruktor nicht direkt aufrufen oder Unterklassen erstellen, die die Klasse BaseExtension erweitern.

Eigenschaften

context	Verwenden Sie das Kontextobjekt, um auf allgemeine Dienste und den Zustand zuzugreifen, die der Komponente zugeordnet sind.
properties	Erweiterungseigenschaften sind ein JavaScript-Objekt, das von der Anwendung übergeben wird, die die Erweiterung initialisiert.

Methoden

onInit()

Diese Ereignismethode wird aufgerufen, wenn die clientseitige Erweiterung zum ersten Mal auf der Seite aktiviert wird. virtuell

Details zur Eigenschaft

context

Verwenden Sie das Kontextobjekt, um auf allgemeine Dienste und den Zustand zuzugreifen, die der Komponente zugeordnet sind.

protected readonly context: ExtensionContext;

Eigenschaftswert

ExtensionContext

Hinweise

Von untergeordneten Klassen wird erwartet, dass sie dieses Feld überschreiben, indem es mit einem speziellen Typ neu deklariert wird. Es soll eine schreibgeschützte Eigenschaft sein. Der Typ kann in der Basisklasse nicht als schreibgeschützt deklariert werden (da er außerhalb des Konstruktors initialisiert wird), aber untergeordnete Klassen sollten ihn als schreibgeschützt neu definieren.

properties

Erweiterungseigenschaften sind ein JavaScript-Objekt, das von der Anwendung übergeben wird, die die Erweiterung initialisiert.

protected get properties(): TProperties;

Eigenschaftswert

TProperties

Hinweise

Eigenschaften können im Erweiterungscode verwendet werden, um konfigurierbare Verhaltensweisen zu definieren. Die Anwendung hat die Kontrolle darüber, welche Eigenschaften für eine instance der Erweiterung bereitgestellt werden sollen. Die gängigste Methode wäre jedoch, sie als JSON auf dem Server zu speichern und bei der Initialisierung unverändert an die Erweiterung zu übergeben.

Details zur Methode

onInit()

Diese Ereignismethode wird aufgerufen, wenn die clientseitige Erweiterung zum ersten Mal auf der Seite aktiviert wird. virtuell

protected onInit(): Promise<void>;

Gibt zurück

Promise<void>