BaseComponent class

Paquete:

@microsoft/sp-component-base

Clase base para componentes del lado cliente como BaseClientSideWebPart o BaseExtension.

Comentarios

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

Propiedades

componentId	Devuelve el identificador de componente tal como se define en el manifiesto asociado del componente.
context	Use el objeto de contexto para acceder a los servicios comunes y al estado asociados al componente.
instanceId	Identificador único para la instancia del componente.
isDisposed	Devuelve true si el componente ya se ha eliminado.
manifest	Proporciona acceso al manifiesto para el componente del lado cliente. Virtual

Métodos

dispose()	Elimina el componente.
onDispose()	Se llama a este método de evento al final del ciclo de vida del componente. Proporciona la oportunidad de liberar los recursos asociados, cancelar las solicitudes pendientes, etc. virtual

Detalles de las propiedades

componentId

Devuelve el identificador de componente tal como se define en el manifiesto asociado del componente.

get componentId(): string;

Valor de propiedad

string

Comentarios

Cada componente del lado cliente tiene un manifiesto asociado que el sp-loader usa para cargar sus scripts y que puede incluir metadatos adicionales sobre el componente. El manifiesto se identifica de forma única mediante una cadena de texto que contiene un valor GUID en minúsculas.

context

Use el objeto de contexto para acceder a los servicios comunes y al estado asociados al componente.

protected context?: BaseComponentContext;

Valor de propiedad

BaseComponentContext

Comentarios

Se espera que las clases secundarias invaliden este campo al volver a declararlo con un tipo especializado. Está pensado para ser una propiedad de solo lectura; el tipo no se puede declarar como de solo lectura en la clase base (porque se inicializa fuera del constructor), pero las clases secundarias deben volver a declararlo como readonly.

instanceId

Identificador único para la instancia del componente.

get instanceId(): string;

Valor de propiedad

string

Comentarios

Una implementación de componente se puede cargar varias veces en la página. Por ejemplo, si el componente es un elemento web de gráficos, se podrían agregar varias instancias de este elemento web al lienzo de SharePoint. InstanceId identifica de forma única cada una de estas instancias.

isDisposed

Devuelve true si el componente ya se ha eliminado.

get isDisposed(): boolean;

Valor de propiedad

boolean

manifest

Proporciona acceso al manifiesto para el componente del lado cliente. Virtual

get manifest(): IClientSideComponentManifest;

Valor de propiedad

IClientSideComponentManifest

Comentarios

Las clases secundarias pueden invalidar esto con tipos de manifiesto más especializados.

Detalles del método

dispose()

Elimina el componente.

dispose(): void;

Devoluciones

void

Comentarios

Por lo general, el código de terceros no necesita llamar a este método; se invoca automáticamente cuando finaliza el ciclo de vida de un elemento web o una extensión. Para realizar una limpieza personalizada cuando se elimina el componente, invalide el método BaseComponent.onDispose().

onDispose()

Se llama a este método de evento al final del ciclo de vida del componente. Proporciona la oportunidad de liberar los recursos asociados, cancelar las solicitudes pendientes, etc. virtual

protected onDispose(): void;

Devoluciones

void