PlaceholderProvider class
Ermöglicht Drittanbieterkomponenten das Ermitteln und Verwenden von SharePoint-Platzhaltern. Mithilfe von Platzhaltern können Drittanbieterkomponenten benutzerdefinierte Inhalte in bestimmten Regionen auf der Seite rendern.
Hinweise
Platzhalter sind bestimmte Bereiche auf der Seite, die durch eine der vordefinierten PlaceholderName-Konstanten identifiziert werden. Verschiedene Anwendungen und Seiten unterstützen möglicherweise unterschiedliche Platzhalternamen. Platzhalter können angezeigt und ausgeblendet werden, wenn der Benutzer mit der Seite interagiert, z. B. über die direkte Navigation. Komponenten von Drittanbietern sollten nicht davon ausgehen, dass ein bestimmter Platzhalter immer verfügbar ist.
Verwenden Sie PlaceholderProvider.tryCreateContent(), um zu testen, ob ein Platzhalter verfügbar ist, und fügen Sie diesem Inhalt hinzu. Verwenden Sie das PlaceholderProvider.changedEvent-Ereignis , um zu ermitteln, wann neue Platzhalter angezeigt werden.
Der Konstruktor für diese Klasse ist als intern gekennzeichnet. Drittanbietercode sollte den Konstruktor nicht direkt aufrufen oder Unterklassen erstellen, die die Klasse PlaceholderProvider erweitern.
Eigenschaften
| is |
|
| placeholder |
Gibt die Namen der derzeit verfügbaren Platzhalter zurück. |
Methoden
| dispose() | |
| try |
Testet, ob die Seite den angegebenen Platzhalter enthält. Wenn ja, wird ein neues PlaceholderContent-Objekt erstellt, mit dem der Aufrufer benutzerdefinierte Inhalte innerhalb des Platzhalters rendern kann. |
Ereignisse
| changed |
Dieses Ereignis wird ausgelöst, wenn die Liste der derzeit verfügbaren Platzhalter geändert wird. |
Details zur Eigenschaft
isDisposed
get isDisposed(): boolean;Eigenschaftswert
boolean
placeholderNames
Gibt die Namen der derzeit verfügbaren Platzhalter zurück.
get placeholderNames(): ReadonlyArray<PlaceholderName>;Eigenschaftswert
ReadonlyArray<PlaceholderName>
Details zur Methode
dispose()
dispose(): void;Gibt zurück
void
tryCreateContent(name, options)
Testet, ob die Seite den angegebenen Platzhalter enthält. Wenn ja, wird ein neues PlaceholderContent-Objekt erstellt, mit dem der Aufrufer benutzerdefinierte Inhalte innerhalb des Platzhalters rendern kann.
tryCreateContent(name: PlaceholderName, options?: IPlaceholderCreateContentOptions): PlaceholderContent | undefined;Parameter
- name
- PlaceholderName
Der angeforderte Platzhalter
- options
- IPlaceholderCreateContentOptions
Zusätzliche Optionen, z. B. um zu erkennen, wann der Platzhalter verworfen wird.
Gibt zurück
PlaceholderContent | undefined
Ein neues PlaceholderContent-Objekt oder nicht definiert, wenn der angeforderte Platzhalter nicht vorhanden ist.
Hinweise
Die Hostanwendung übernimmt keine Garantien für die Verfügbarkeit eines bestimmten Platzhalters. In Situationen, in denen ein erwarteter Platzhalter nicht verfügbar ist, muss die Drittanbietererweiterung ihn ordnungsgemäß behandeln, z. B. indem nichts gerendert oder ein alternativer Platzhalter ausgewählt wird.
Details zum Ereignis
changedEvent
Dieses Ereignis wird ausgelöst, wenn die Liste der derzeit verfügbaren Platzhalter geändert wird.
get changedEvent(): SPEvent<SPEventArgs>;Ereignistyp
Hinweise
Die Anwendung kann ihre Liste der verfügbaren Platzhalter jederzeit ändern. Dies bedeutet, dass die vorhandenen Platzhalter verworfen oder neue Platzhalter hinzugefügt werden können. Verwenden Sie dieses Ereignis, um neue Platzhalter zu ermitteln, wenn sie angezeigt werden.