PlaceholderProvider class
Permite que componentes de terceiros descubram e utilizem marcadores de posição do SharePoint. Os marcadores de posição permitem aos componentes de terceiros compor conteúdo personalizado em regiões designadas na página.
Comentários
Os marcadores de posição são regiões designadas na página, identificadas por uma das constantes predefinidas PlaceholderName . Diferentes aplicações e páginas podem suportar nomes de marcadores de posição diferentes. Os marcadores de posição podem aparecer e desaparecer à medida que o utilizador interage com a página, por exemplo, através da navegação no local. Os componentes de terceiros não devem assumir que um determinado marcador de posição estará sempre disponível.
Utilize PlaceholderProvider.tryCreateContent() para testar se um marcador de posição está disponível e adicionar conteúdo ao mesmo. Utilize o evento PlaceholderProvider.changedEvent para detetar quando são apresentados novos marcadores de posição.
O construtor desta classe é marcado como interno. O código de terceiros não deve chamar diretamente o construtor ou criar subclasses que ampliem a classe PlaceholderProvider.
Propriedades
| is |
|
| placeholder |
Devolve os nomes dos marcadores de posição atualmente disponíveis. |
Métodos
| dispose() | |
| try |
Testa se a página contém o marcador de posição especificado. Em caso afirmativo, é criado um novo objeto PlaceholderContent, que permite ao autor da chamada compor conteúdo personalizado dentro do marcador de posição. |
Eventos
| changed |
Este evento é gerado quando a lista de marcadores de posição atualmente disponíveis é alterada. |
Detalhes da propriedade
isDisposed
get isDisposed(): boolean;Valor da propriedade
boolean
placeholderNames
Devolve os nomes dos marcadores de posição atualmente disponíveis.
get placeholderNames(): ReadonlyArray<PlaceholderName>;Valor da propriedade
ReadonlyArray<PlaceholderName>
Detalhes do método
dispose()
dispose(): void;Retornos
void
tryCreateContent(name, options)
Testa se a página contém o marcador de posição especificado. Em caso afirmativo, é criado um novo objeto PlaceholderContent, que permite ao autor da chamada compor conteúdo personalizado dentro do marcador de posição.
tryCreateContent(name: PlaceholderName, options?: IPlaceholderCreateContentOptions): PlaceholderContent | undefined;Parâmetros
- name
- PlaceholderName
O marcador de posição pedido
- options
- IPlaceholderCreateContentOptions
Opções adicionais, por exemplo, para detetar quando o marcador de posição é eliminado.
Retornos
PlaceholderContent | undefined
Um novo objeto PlaceholderContent ou indefinido se o marcador de posição pedido não existir.
Comentários
A aplicação anfitriã não garante a disponibilidade de um determinado marcador de posição. Em situações em que um marcador de posição esperado não esteja disponível, a extensão de terceiros tem de processá-lo corretamente, por exemplo, por não compor nada ou ao escolher um marcador de posição alternativo.
Detalhes do evento
changedEvent
Este evento é gerado quando a lista de marcadores de posição atualmente disponíveis é alterada.
get changedEvent(): SPEvent<SPEventArgs>;Tipo de evento
Comentários
A aplicação pode alterar a lista de marcadores de posição disponíveis em qualquer altura. Isto significa que os marcadores de posição existentes podem ser eliminados ou podem ser adicionados novos marcadores de posição. Utilize este evento para detetar novos marcadores de posição quando forem apresentados.