PlaceholderProvider class
Permet aux composants tiers de découvrir et d’utiliser des espaces réservés SharePoint. Les espaces réservés permettent à des composants tiers de restituer du contenu personnalisé dans des régions désignées sur la page.
Remarques
Les espaces réservés sont des régions désignées sur la page, identifiées par l’une des constantes PlaceholderName prédéfinies. Différentes applications et pages peuvent prendre en charge différents noms d’espace réservé. Les espaces réservés peuvent apparaître et disparaître lorsque l’utilisateur interagit avec la page, par exemple via la navigation sur place. Les composants tiers ne doivent pas supposer qu’un espace réservé donné sera toujours disponible.
Utilisez PlaceholderProvider.tryCreateContent() pour tester si un espace réservé est disponible et y ajouter du contenu. Utilisez l’événement PlaceholderProvider.changedEvent pour découvrir quand de nouveaux espaces réservés apparaissent.
Le constructeur de cette classe est marqué comme interne. Le code tiers ne doit pas appeler directement le constructeur ou créer des sous-classes qui étendent la PlaceholderProvider classe.
Propriétés
| is |
|
| placeholder |
Retourne les noms des espaces réservés actuellement disponibles. |
Méthodes
| dispose() | |
| try |
Teste si la page contient l’espace réservé spécifié. Si c’est le cas, un nouvel objet PlaceholderContent est créé, ce qui permet à l’appelant de restituer du contenu personnalisé à l’intérieur de l’espace réservé. |
Événements
| changed |
Cet événement est déclenché lorsque la liste des espaces réservés actuellement disponibles est modifiée. |
Détails de la propriété
isDisposed
get isDisposed(): boolean;Valeur de propriété
boolean
placeholderNames
Retourne les noms des espaces réservés actuellement disponibles.
get placeholderNames(): ReadonlyArray<PlaceholderName>;Valeur de propriété
ReadonlyArray<PlaceholderName>
Détails de la méthode
dispose()
dispose(): void;Retours
void
tryCreateContent(name, options)
Teste si la page contient l’espace réservé spécifié. Si c’est le cas, un nouvel objet PlaceholderContent est créé, ce qui permet à l’appelant de restituer du contenu personnalisé à l’intérieur de l’espace réservé.
tryCreateContent(name: PlaceholderName, options?: IPlaceholderCreateContentOptions): PlaceholderContent | undefined;Paramètres
- name
- PlaceholderName
Espace réservé demandé
- options
- IPlaceholderCreateContentOptions
Des options supplémentaires, par exemple pour détecter quand l’espace réservé est supprimé.
Retours
PlaceholderContent | undefined
Nouvel objet PlaceholderContent ou non défini si l’espace réservé demandé n’existe pas.
Remarques
L’application hôte ne garantit pas la disponibilité d’un espace réservé donné. Dans les situations où un espace réservé attendu n’est pas disponible, l’extension tierce doit le gérer correctement, par exemple en ne rendant rien ou en choisissant un autre espace réservé.
Détails de l'événement
changedEvent
Cet événement est déclenché lorsque la liste des espaces réservés actuellement disponibles est modifiée.
get changedEvent(): SPEvent<SPEventArgs>;Type d'événement
Remarques
L’application peut modifier sa liste d’espaces réservés disponibles à tout moment. Cela signifie que les espaces réservés existants peuvent être supprimés ou que de nouveaux espaces réservés peuvent être ajoutés. Utilisez cet événement pour découvrir de nouveaux espaces réservés lorsqu’ils apparaissent.