BaseComponent class

Paket:

@microsoft/sp-component-base

Die Basisklasse für clientseitige Komponenten wie BaseClientSideWebPart oder BaseExtension.

Hinweise

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

Eigenschaften

componentId	Gibt den Komponentenbezeichner wie im zugeordneten Manifest der Komponente definiert zurück.
context	Verwenden Sie das Kontextobjekt, um auf allgemeine Dienste und den Zustand zuzugreifen, die der Komponente zugeordnet sind.
instanceId	Ein eindeutiger Bezeichner für die instance der Komponente.
isDisposed	Gibt true zurück, wenn die Komponente bereits verworfen wurde.
manifest	Bietet Zugriff auf das Manifest für die clientseitige Komponente. virtuell

Methoden

dispose()	Löscht die Komponente.
onDispose()	Diese Ereignismethode wird am Ende des Lebenszyklus der Komponente aufgerufen. Es bietet die Möglichkeit, alle zugeordneten Ressourcen freizugeben, alle ausstehenden Anforderungen abzubrechen usw.

Details zur Eigenschaft

componentId

Gibt den Komponentenbezeichner wie im zugeordneten Manifest der Komponente definiert zurück.

get componentId(): string;

Eigenschaftswert

string

Hinweise

Jede clientseitige Komponente verfügt über ein zugeordnetes Manifest, das vom sp-loader zum Laden der Skripts verwendet wird und das zusätzliche Metadaten zur Komponente enthalten kann. Das Manifest wird mithilfe einer Textzeichenfolge, die einen GUID-Wert in Kleinbuchstaben enthält, eindeutig identifiziert.

context

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

protected context?: BaseComponentContext;

Eigenschaftswert

BaseComponentContext

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.

instanceId

Ein eindeutiger Bezeichner für die instance der Komponente.

get instanceId(): string;

Eigenschaftswert

string

Hinweise

Eine Komponentenimplementierung kann mehrmals auf der Seite geladen werden. Wenn es sich bei der Komponente beispielsweise um ein Diagrammwebpart handelt, können mehrere Instanzen dieses Webparts zum SharePoint-Zeichenbereich hinzugefügt werden. Die instanceId identifiziert jede dieser Instanzen eindeutig.

isDisposed

Gibt true zurück, wenn die Komponente bereits verworfen wurde.

get isDisposed(): boolean;

Eigenschaftswert

boolean

manifest

Bietet Zugriff auf das Manifest für die clientseitige Komponente. virtuell

get manifest(): IClientSideComponentManifest;

Eigenschaftswert

IClientSideComponentManifest

Hinweise

Untergeordnete Klassen können dies mit spezialisierteren Manifesttypen überschreiben.

Details zur Methode

dispose()

Löscht die Komponente.

dispose(): void;

Gibt zurück

void

Hinweise

Code von Drittanbietern muss diese Methode im Allgemeinen nicht aufrufen. Sie wird automatisch aufgerufen, wenn der Lebenszyklus für ein Webpart oder eine Erweiterung endet. Um eine benutzerdefinierte Bereinigung durchzuführen, wenn ihre Komponente verworfen wird, überschreiben Sie die BaseComponent.onDispose()- Methode.

onDispose()

Diese Ereignismethode wird am Ende des Lebenszyklus der Komponente aufgerufen. Es bietet die Möglichkeit, alle zugeordneten Ressourcen freizugeben, alle ausstehenden Anforderungen abzubrechen usw.

protected onDispose(): void;

Gibt zurück

void