BaseWebPart class

Pacote:

@microsoft/sp-webpart-base

Esta classe abstrata implementa a funcionalidade de base agnóstica da IU para uma peça Web do lado do cliente. O objetivo é permitir um núcleo comum entre Peças Web 2D e MR.

Extends

BaseComponent

Construtores

(constructor)()

Construtor para a BaseWebPart classe .

Propriedades

accessibleTitle	Essa propriedade aponta para o título acessível da Web Part disponibilizado aos leitores de tela. A implementação básica retorna esse título padrão no manifesto. As Web Parts que desejam fornecer um título mais descritivo contendo informações contextuais precisam substituir essa API. virtual
context	Utilize o objeto de contexto para aceder a serviços comuns e ao estado associado ao componente.
dataVersion	O valor dessa propriedade é armazenado nos dados serializados da Web Part para permitir que os desenvolvedores gerenciem as versões da Web Part. A versão padrão é a 1.0
description	Descrição da Web Part
disableReactivePropertyChanges	Esta propriedade é utilizada para alterar a interação do painel de propriedades da peça Web de Reactive para NonReactive. virtual
displayMode	Essa propriedade é o modo de exibição atual da Web Part.
previewImageUrl	Essa propriedade aponta para a imagem de visualização da Web Part. A implementação básica retorna indefinida. As Web Parts que desejam fornecer uma url de imagem de visualização válida precisam substituir essa API. A url de imagem de visualização pode ser usada para criar uma visualização da Web Part ou da página na qual a Web Part está presente. virtual
properties	Essa propriedade é o ponteiro para o recipiente de propriedades personalizado da Web Part.
propertiesMetadata	Essa propriedade define metadados para o recipiente de propriedades da Web Part. Os metadados podem ajudar o SharePoint a entender melhor o conteúdo das propriedades e executar serviços relevantes nos dados. virtual
title	Título da Web Part

Métodos

getPropertyPaneConfiguration()	Essa API é usada na configuração para compilar o painel de propriedades da Web Part. Se quiser que a Web Part use o PropertyPane na configuração, essa API precisa ser substituída e a Web Part precisa retornar a configuração para o PropertyPane. Esta API não é invocada até que a promessa "loadPropertyPaneResources" seja resolvida. Veja IPropertyPane e outra documentação do wiki de integração do PropertyPane para obter mais detalhes. virtual
getTopActionsConfiguration()	Devolve a configuração para as ações principais ou indefinidas desta peça Web se a peça Web não suportar as ações principais.
loadPropertyPaneResources()	Esta API permite o carregamento assíncrono de recursos relacionados com o painel de propriedades da peça Web.
onAfterDeserialize(deserializedObject, dataVersion)	Essa API é chamada depois que a Web Part é desserializada para um objeto, pouco antes do recipiente de propriedades ser preenchido. virtual
onAfterPropertyPaneChangesApplied()	Essa API é invocada depois que as alterações feitas no PropertyPane são aplicadas quando o PropertyPane é usado no modo Não Reativo. Esta API não é invocada quando o PropertyPane é usado em modo Reativo. virtual
onBeforeSerialize()	Este método de evento é chamado antes de a peça Web ser serializada. virtual
onDisplayModeChanged(oldDisplayMode)	Este método de evento é chamado quando o modo de apresentação de uma peça Web é alterado. virtual
onDispose()	Essa API deve ser usada para atualizar o conteúdo do PropertyPane. virtual
onInit()	Este método de evento é chamado quando a peça Web é inicializada. virtual
onPropertyPaneConfigurationComplete()	Essa API é invocada quando a configuração for concluída no PropertyPane. virtual
onPropertyPaneConfigurationStart()	Este método de evento é invocado quando a configuração é iniciada no PropertyPane. virtual
onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)	Essa API é invocada depois de atualizar o novo valor da propriedade no recipiente de propriedades quando o PropertyPane está sendo usado no modo Reativo. virtual
onPropertyPaneRendered()	Essa API é invocada quando o PropertyPane é renderizado. virtual

Detalhes do construtor

(constructor)()

Construtor para a BaseWebPart classe .

constructor();

Comentários

É altamente recomendável que a Web Part use a API OnInit para executar qualquer inicialização específica da Web Part. A maioria dos recursos de Web Parts como this.context e this.properties não está disponível para uso antes da parte onInit do ciclo de vida de carregamento da Web Part.

Detalhes da propriedade

accessibleTitle

Essa propriedade aponta para o título acessível da Web Part disponibilizado aos leitores de tela. A implementação básica retorna esse título padrão no manifesto. As Web Parts que desejam fornecer um título mais descritivo contendo informações contextuais precisam substituir essa API. virtual

protected get accessibleTitle(): string;

Valor da propriedade

string

context

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

readonly context: BaseWebPartContext;

Valor da propriedade

BaseWebPartContext

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.

dataVersion

O valor dessa propriedade é armazenado nos dados serializados da Web Part para permitir que os desenvolvedores gerenciem as versões da Web Part. A versão padrão é a 1.0

protected get dataVersion(): Version;

Valor da propriedade

Version

description

Descrição da Web Part

protected get description(): string;

Valor da propriedade

string

disableReactivePropertyChanges

Esta propriedade é utilizada para alterar a interação do painel de propriedades da peça Web de Reactive para NonReactive. virtual

protected get disableReactivePropertyChanges(): boolean;

Valor da propriedade

boolean

Comentários

O comportamento predefinido é Reativo.

Reativo implica que as alterações efetuadas no PropertyPane são transmitidas instantaneamente para a peça Web e o utilizador pode ver atualizações instantâneas. Isso ajuda o criador da página a obter comentários instantâneos e decidir se deve manter ou não as novas alterações na configuração.

NonReactive implica que as alterações de configuração são transmitidas para a peça Web apenas após o botão "Aplicar" PropertyPane ser clicado.

displayMode

Essa propriedade é o modo de exibição atual da Web Part.

get displayMode(): DisplayMode;

Valor da propriedade

DisplayMode

previewImageUrl

Essa propriedade aponta para a imagem de visualização da Web Part. A implementação básica retorna indefinida. As Web Parts que desejam fornecer uma url de imagem de visualização válida precisam substituir essa API. A url de imagem de visualização pode ser usada para criar uma visualização da Web Part ou da página na qual a Web Part está presente. virtual

get previewImageUrl(): string | undefined;

Valor da propriedade

string | undefined

properties

Essa propriedade é o ponteiro para o recipiente de propriedades personalizado da Web Part.

protected get properties(): TProperties;

Valor da propriedade

TProperties

propertiesMetadata

Essa propriedade define metadados para o recipiente de propriedades da Web Part. Os metadados podem ajudar o SharePoint a entender melhor o conteúdo das propriedades e executar serviços relevantes nos dados. virtual

protected get propertiesMetadata(): IWebPartPropertiesMetadata | undefined;

Valor da propriedade

IWebPartPropertiesMetadata | undefined

Comentários

Veja IWebPartPropertiesMetadata para obter mais informações sobre como definir metadados

title

Título da Web Part

protected get title(): string;

Valor da propriedade

string

Detalhes do método

getPropertyPaneConfiguration()

Essa API é usada na configuração para compilar o painel de propriedades da Web Part. Se quiser que a Web Part use o PropertyPane na configuração, essa API precisa ser substituída e a Web Part precisa retornar a configuração para o PropertyPane.

Esta API não é invocada até que a promessa "loadPropertyPaneResources" seja resolvida.

Veja IPropertyPane e outra documentação do wiki de integração do PropertyPane para obter mais detalhes. virtual

protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration;

Retornos

IPropertyPaneConfiguration

getTopActionsConfiguration()

Devolve a configuração para as ações principais ou indefinidas desta peça Web se a peça Web não suportar as ações principais.

getTopActionsConfiguration(): ITopActions | undefined;

Retornos

ITopActions | undefined

loadPropertyPaneResources()

Esta API permite o carregamento assíncrono de recursos relacionados com o painel de propriedades da peça Web.

/** @virtual */
protected loadPropertyPaneResources(): Promise<void>;

Retornos

Promise<void>

Comentários

Se não for substituída pela peça Web, a peça Web base resolve imediatamente a promessa.

Este método é chamado antes de qualquer APIs do painel de propriedades ser chamada. Não é possível chamar outras APIs do painel de propriedades até que esta promessa seja resolvida. Não são gerados outros eventos relacionados com o painel de propriedades, exceto "PropertyPaneConfigurationComplete".

O evento "PropertyPaneConfigurationComplete" pode ser gerado para limpo quaisquer recursos pendentes, incluindo a promessa "loadPropertyPaneResources".

onAfterDeserialize(deserializedObject, dataVersion)

Essa API é chamada depois que a Web Part é desserializada para um objeto, pouco antes do recipiente de propriedades ser preenchido. virtual

protected onAfterDeserialize(deserializedObject: any, dataVersion: Version): TProperties;

Parâmetros

deserializedObject

any

O objeto desserializado a partir dos dados armazenados. Observe que o esquema desse objeto não é necessariamente consistente com o atual recipiente de propriedades já que a serialização poderia ter sido feita por uma versão anterior da Web Part

dataVersion

Version

A versão de dados dos dados armazenados sendo desserializados. Você pode usar esse valor para determinar se os dados foram serializados por uma Web Part mais antiga. As Web Parts podem definir sua versão de dados ao substituir a propriedade dataVersion.

Retornos

TProperties

O recipiente de propriedades da Web Part

Comentários

A implementação padrão é não operacional. Um desenvolvedor de Web Parts pode substituir essa API se o objeto desserializado não refletir completamente o estado inicial do recipiente de propriedades. Isso oferece ao desenvolvedor de Web Parts a chance de preencher o recipiente de propriedades logo após os dados serem desserializados para um objeto.

A atualização é um cenário importante para ser usado com a desserialização. Uma peça Web atualizada pode carregar os dados que foram serializados por uma versão mais antiga da peça Web que suportava um esquema diferente do saco de propriedades, o que faz com que o objeto com serialização anulada seja inconsistente com o esquema atual do saco de propriedades. O programador pode utilizar onAfterDeserialize para marcar dataVersion e corrigir o saco de propriedades.

onAfterPropertyPaneChangesApplied()

Essa API é invocada depois que as alterações feitas no PropertyPane são aplicadas quando o PropertyPane é usado no modo Não Reativo. Esta API não é invocada quando o PropertyPane é usado em modo Reativo. virtual

protected onAfterPropertyPaneChangesApplied(): void;

Retornos

void

onBeforeSerialize()

Este método de evento é chamado antes de a peça Web ser serializada. virtual

protected onBeforeSerialize(): void;

Retornos

void

Comentários

A implementação padrão é não operacional. O processo de serialização serializa o saco de propriedades da peça Web, ou seja, this.properties. Esta API dá à peça Web a oportunidade de atualizar o seu conjunto de propriedades antes da serialização acontecer. Algumas peças Web podem manter o estado de outros objetos ou mesmo no DOM. Se uma peça Web precisar de manter algum desse estado, tem de substituir esta API e atualizar o pacote de propriedades da peça Web para o estado mais recente. Se uma peça Web atualizar o saco de propriedades com valores de propriedade inválidos, estes serão mantidos. Portanto, isso deve ser evitado. O conjunto de propriedades da peça Web deve conter sempre valores de propriedade válidos.

onDisplayModeChanged(oldDisplayMode)

Este método de evento é chamado quando o modo de apresentação de uma peça Web é alterado. virtual

protected onDisplayModeChanged(oldDisplayMode: DisplayMode): void;

Parâmetros

oldDisplayMode

DisplayMode

O modo de exibição antigo.

Retornos

void

Comentários

A implementação padrão dessa API chama o método de renderização da Web Part para renderizar a Web Part novamente com o novo modo de exibição. Se o desenvolvedor de Web Parts não desejar que uma nova renderização completa aconteça na alteração do modo de exibição, ele pode substituir essa API e executar atualizações específicas no DOM da Web Part para mudar seu modo de exibição.

Se a peça Web for inicializada ou re-inicializada ao mudar para um modo de visualização diferente, este método de ciclo de vida não é chamado. Exemplo: Página de Site do SharePoint.

onDispose()

Essa API deve ser usada para atualizar o conteúdo do PropertyPane. virtual

protected onDispose(): void;

Retornos

void

Comentários

Essa API é chamada no final do ciclo de vida da Web Part em uma página. Ela deve ser usada para descartar recursos locais (ou seja, elementos DOM) que mantêm a Web Part. Essa API deve ser chamada em cenários como a navegação de página, ou seja, o host está fazendo a transição de uma página para outra e descarta a página que está sendo migrada.

onInit()

Este método de evento é chamado quando a peça Web é inicializada. virtual

protected onInit(): Promise<void>;

Retornos

Promise<void>

Comentários

Essa API deve ser substituída para realizar operações de longa duração, por exemplo, obtenção de dados de um serviço remoto antes da renderização inicial da Web Part. O indicador de carregamento é exibido durante o ciclo de vida desse método. Essa API é chamada apenas uma vez durante o ciclo de vida de uma Web Part.

onPropertyPaneConfigurationComplete()

Essa API é invocada quando a configuração for concluída no PropertyPane. virtual

protected onPropertyPaneConfigurationComplete(): void;

Retornos

void

Comentários

Este método de evento é invocado nos seguintes casos:

• Quando o CONFIGURATION_COMPLETE_TIMEOUT(atualmente, o valor é de 5 segundos) decorridos após a última alteração.

• Quando o utilizador clica no botão "X" (fechar) antes de CONFIGURATION_COMPLETE_TIMEOUT decorridos.

• Quando o utilizador clica no botão "Aplicar" antes do CONFIGURATION_COMPLETE_TIMEOUT decorridos.

• Quando o utilizador muda de peças Web, a peça Web atual obtém este evento.

onPropertyPaneConfigurationStart()

Este método de evento é invocado quando a configuração é iniciada no PropertyPane. virtual

protected onPropertyPaneConfigurationStart(): void;

Retornos

void

Comentários

Este método de evento é invocado nos seguintes casos:

• Quando o PropertyPane é aberto.

• Quando o utilizador muda de peças Web, a nova peça Web obtém este evento.

onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)

Essa API é invocada depois de atualizar o novo valor da propriedade no recipiente de propriedades quando o PropertyPane está sendo usado no modo Reativo. virtual

protected onPropertyPaneFieldChanged(propertyPath: string, oldValue: any, newValue: any): void;

Parâmetros

propertyPath

string

O caminho JSON da propriedade no recipiente de propriedades. No caso do campo personalizado, se não for fornecida nenhuma propriedade de destino, é atribuído um valor personalizado, que estará sob a forma de __CustomField_<key provided when the custom field is created>.

oldValue

any

O valor antigo da propriedade. Este valor pode ser indefinido/vazio no caso do campo personalizado.

newValue

any

Novo valor da propriedade. Este valor pode ser indefinido/vazio no caso do campo personalizado.

Retornos

void

onPropertyPaneRendered()

Essa API é invocada quando o PropertyPane é renderizado. virtual

protected onPropertyPaneRendered(): void;

Retornos

void