BaseComponent class

Pacote:

@microsoft/sp-component-base

A classe base para componentes do lado do cliente, como BaseClientSideWebPart ou BaseExtension.

Comentários

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

Propriedades

componentId	Devolve o identificador do componente conforme definido no manifesto associado do componente.
context	Utilize o objeto de contexto para aceder a serviços comuns e ao estado associado ao componente.
instanceId	Um identificador exclusivo para a instância do componente.
isDisposed	Devolve true se o componente já tiver sido eliminado.
manifest	Fornece acesso ao manifesto para o componente do lado do cliente. virtual

Métodos

dispose()	Elimina o componente.
onDispose()	Este método de evento é chamado no final do ciclo de vida do componente. Proporciona uma oportunidade para libertar quaisquer recursos associados, cancelar quaisquer pedidos pendentes, etc. virtual

Detalhes da propriedade

componentId

Devolve o identificador do componente conforme definido no manifesto associado do componente.

get componentId(): string;

Valor da propriedade

string

Comentários

Cada componente do lado do cliente tem um manifesto associado que é utilizado pelo sp-loader para carregar os scripts e que pode incluir metadados adicionais sobre o componente. O manifesto é identificado exclusivamente com uma cadeia de texto que contém um valor GUID em minúsculas.

context

Utilize o objeto de contexto para aceder a serviços comuns e ao estado associado ao componente.

protected context?: BaseComponentContext;

Valor da propriedade

BaseComponentContext

Comentários

Espera-se que as classes subordinadas substituam este campo ao voltar a declará-lo com um tipo especializado. Destina-se a ser uma propriedade só de leitura; o tipo não pode ser declarado como só de leitura na classe base (porque está inicializado fora do construtor), mas as classes subordinadas devem voltar a declará-lo como só de leitura.

instanceId

Um identificador exclusivo para a instância do componente.

get instanceId(): string;

Valor da propriedade

string

Comentários

Uma implementação de componentes pode ser carregada várias vezes na página. Por exemplo, se o componente for uma peça Web de gráfico, podem ser adicionadas várias instâncias desta peça Web à tela do SharePoint. O instanceId identifica exclusivamente cada uma destas instâncias.

isDisposed

Devolve true se o componente já tiver sido eliminado.

get isDisposed(): boolean;

Valor da propriedade

boolean

manifest

Fornece acesso ao manifesto para o componente do lado do cliente. virtual

get manifest(): IClientSideComponentManifest;

Valor da propriedade

IClientSideComponentManifest

Comentários

As classes subordinadas podem substituí-lo por tipos de manifesto mais especializados.

Detalhes do método

dispose()

Elimina o componente.

dispose(): void;

Retornos

void

Comentários

Geralmente, o código de terceiros não tem de chamar este método; é invocado automaticamente quando o ciclo de vida termina para uma peça Web ou extensão. Para efetuar uma limpeza personalizada quando o componente é eliminado, substitua o método BaseComponent.onDispose( ).

onDispose()

Este método de evento é chamado no final do ciclo de vida do componente. Proporciona uma oportunidade para libertar quaisquer recursos associados, cancelar quaisquer pedidos pendentes, etc. virtual

protected onDispose(): void;

Retornos

void