PlaceholderContent class

Pacote:

@microsoft/sp-application-base

Representa conteúdo personalizado que é composto dentro de um marcador de posição numa página do SharePoint.

Comentários

Este objeto é devolvido por PlaceholderProvider.tryCreateContent(). Fornece acesso a um elemento do Modelo de Objeto de Documento (DOM) onde o proprietário pode compor o respetivo conteúdo personalizado.

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 PlaceholderContent.

Propriedades

domElement	O elemento Modelo de Objeto de Documento (DOM) em que o proprietário deve compor o respetivo conteúdo personalizado.
isDisposed
isVisible	Devolver verdadeiro se este objeto PlacholderContent estiver visível. Se criar um marcador de posição e a página de anfitrião não estiver a apresentá-lo, será devolvido falso.
name	Identifica o marcador de posição ao qual este conteúdo foi adicionado.

Métodos

dispose()

Elimina o objeto PlaceholderContent e remove o respetivo elemento DOM anexado da página.

Detalhes da propriedade

domElement

O elemento Modelo de Objeto de Documento (DOM) em que o proprietário deve compor o respetivo conteúdo personalizado.

get domElement(): HTMLDivElement;

Valor da propriedade

HTMLDivElement

Comentários

Se o autor da chamada precisar de ser notificado quando o elemento DOM for eliminado, utilize a chamada de retorno IPlaceholderCreateContentOptions.onDispose .

isDisposed

get isDisposed(): boolean;

Valor da propriedade

boolean

isVisible

Devolver verdadeiro se este objeto PlacholderContent estiver visível. Se criar um marcador de posição e a página de anfitrião não estiver a apresentá-lo, será devolvido falso.

get isVisible(): boolean;

Valor da propriedade

boolean

name

Identifica o marcador de posição ao qual este conteúdo foi adicionado.

get name(): PlaceholderName;

Valor da propriedade

PlaceholderName

Comentários

Exemplo: PlaceholderName.Top

Detalhes do método

dispose()

Elimina o objeto PlaceholderContent e remove o respetivo elemento DOM anexado da página.

dispose(): void;

Retornos

void

Comentários

Este método pode ser chamado para eliminar imediatamente o elemento DOM anexado. Caso contrário, será eliminado pela aplicação quando o marcador de posição que contém for eliminado. A chamada dispose() invoca a chamada de retorno IPlaceholderCreateContentOptions.onDispose , remove o elemento DOM associado da página e elimina o objeto PlaceholderContent.