PlaceholderContent class
Stellt benutzerdefinierten Inhalt dar, der in einem Platzhalter auf einer SharePoint-Seite gerendert wird.
Hinweise
Dieses Objekt wird von PlaceholderProvider.tryCreateContent() zurückgegeben. Es bietet Zugriff auf ein DOM-Element (Document Object Model), in dem der Besitzer seinen benutzerdefinierten Inhalt rendern kann.
Der Konstruktor für diese Klasse ist als intern gekennzeichnet. Drittanbietercode sollte den Konstruktor nicht direkt aufrufen oder Unterklassen erstellen, die die Klasse PlaceholderContent
erweitern.
Eigenschaften
dom |
Das DOM-Element (Document Object Model), in dem der Besitzer seinen benutzerdefinierten Inhalt rendern soll. |
is |
|
is |
Gibt true zurück, wenn dieses PlacholderContent-Objekt sichtbar ist. Wenn Sie einen Platzhalter erstellen und auf der Hostseite dieser nicht angezeigt wird, wird false zurückgegeben. |
name | Gibt den Platzhalter an, dem dieser Inhalt hinzugefügt wurde. |
Methoden
dispose() | Entfernt das PlaceholderContent-Objekt und entfernt das angefügte DOM-Element von der Seite. |
Details zur Eigenschaft
domElement
Das DOM-Element (Document Object Model), in dem der Besitzer seinen benutzerdefinierten Inhalt rendern soll.
get domElement(): HTMLDivElement;
Eigenschaftswert
HTMLDivElement
Hinweise
Wenn der Aufrufer benachrichtigt werden muss, wenn das DOM-Element verworfen wird, verwenden Sie den Rückruf IPlaceholderCreateContentOptions.onDispose .
isDisposed
get isDisposed(): boolean;
Eigenschaftswert
boolean
isVisible
Gibt true zurück, wenn dieses PlacholderContent-Objekt sichtbar ist. Wenn Sie einen Platzhalter erstellen und auf der Hostseite dieser nicht angezeigt wird, wird false zurückgegeben.
get isVisible(): boolean;
Eigenschaftswert
boolean
name
Gibt den Platzhalter an, dem dieser Inhalt hinzugefügt wurde.
get name(): PlaceholderName;
Eigenschaftswert
Hinweise
Beispiel: PlaceholderName.Top
Details zur Methode
dispose()
Entfernt das PlaceholderContent-Objekt und entfernt das angefügte DOM-Element von der Seite.
dispose(): void;
Gibt zurück
void
Hinweise
Diese Methode kann aufgerufen werden, um das angefügte DOM-Element sofort zu löschen. Andernfalls wird sie von der Anwendung verworfen, wenn der enthaltende Platzhalter verworfen wird. Durch Aufrufen von dispose() wird der Rückruf IPlaceholderCreateContentOptions.onDispose aufgerufen, das zugeordnete DOM-Element von der Seite entfernt und das PlaceholderContent-Objekt gelöscht.