PlaceholderProvider class
Permite que los componentes de terceros detecten y usen marcadores de posición de SharePoint. Los marcadores de posición permiten que los componentes de terceros representen contenido personalizado en las regiones designadas de la página.
Comentarios
Los marcadores de posición son regiones designadas en la página, identificadas por una de las constantes PlaceholderName predefinidas. Las distintas aplicaciones y páginas pueden admitir nombres de marcador de posición diferentes. Los marcadores de posición pueden aparecer y desaparecer a medida que el usuario interactúa con la página, por ejemplo, mediante la navegación local. Los componentes de terceros no deben suponer que un marcador de posición determinado siempre estará disponible.
Use PlaceholderProvider.tryCreateContent() para probar si un marcador de posición está disponible y agregarle contenido. Use el evento PlaceholderProvider.changedEvent para detectar cuándo aparecen nuevos marcadores de posición.
El constructor de esta clase está marcado como interno. El código de terceros no debe llamar directamente al constructor ni crear subclases que extiendan la clase PlaceholderProvider.
Propiedades
| is |
|
| placeholder |
Devuelve los nombres de los marcadores de posición disponibles actualmente. |
Métodos
| dispose() | |
| try |
Comprueba si la página contiene el marcador de posición especificado. Si es así, se crea un nuevo objeto PlaceholderContent, que permite al autor de la llamada representar contenido personalizado dentro del marcador de posición. |
Eventos
| changed |
Este evento se genera cuando se cambia la lista de marcadores de posición disponibles actualmente. |
Detalles de las propiedades
isDisposed
get isDisposed(): boolean;Valor de propiedad
boolean
placeholderNames
Devuelve los nombres de los marcadores de posición disponibles actualmente.
get placeholderNames(): ReadonlyArray<PlaceholderName>;Valor de propiedad
ReadonlyArray<PlaceholderName>
Detalles del método
dispose()
dispose(): void;Devoluciones
void
tryCreateContent(name, options)
Comprueba si la página contiene el marcador de posición especificado. Si es así, se crea un nuevo objeto PlaceholderContent, que permite al autor de la llamada representar contenido personalizado dentro del marcador de posición.
tryCreateContent(name: PlaceholderName, options?: IPlaceholderCreateContentOptions): PlaceholderContent | undefined;Parámetros
- name
- PlaceholderName
Marcador de posición solicitado
- options
- IPlaceholderCreateContentOptions
Opciones adicionales, por ejemplo, para detectar cuándo se elimina el marcador de posición.
Devoluciones
PlaceholderContent | undefined
Un nuevo objeto PlaceholderContent o undefined si el marcador de posición solicitado no existe.
Comentarios
La aplicación host no garantiza la disponibilidad de un marcador de posición determinado. En situaciones en las que un marcador de posición esperado no está disponible, la extensión de terceros debe controlarlo correctamente, por ejemplo, sin representar nada o eligiendo un marcador de posición alternativo.
Detalles del evento
changedEvent
Este evento se genera cuando se cambia la lista de marcadores de posición disponibles actualmente.
get changedEvent(): SPEvent<SPEventArgs>;Tipo de evento
Comentarios
La aplicación puede cambiar su lista de marcadores de posición disponibles en cualquier momento. Esto significa que los marcadores de posición existentes pueden eliminarse o se pueden agregar nuevos marcadores de posición. Use este evento para detectar nuevos marcadores de posición cuando aparezcan.