IPropertyPaneAccessor interface

Pacote:

@microsoft/sp-webpart-base

Interface de acessório do painel de propriedades do contexto da peça Web. Fornece algumas operações mais utilizadas para aceder ao painel de propriedades e ao painel de conteúdo.

Métodos

close()	Esta API deve ser utilizada para fechar o Painel de Propriedades ou o Painel de Conteúdo para ajudar a configurar a peça Web.
isContentPanelOpen()	Devolve true se o ContentPanel estiver aberto.
isPropertyPaneOpen()	Devolve true se PropertyPane estiver aberto.
isPropertyPaneOpen(instanceId)	Devolve true se o Painel de Conteúdo estiver aberto e o instanceId especificado for suportado no painel de conteúdos. OU Devolve verdadeiro se o painel Propriedade estiver aberto e o instanceId especificado for suportado no painel de propriedades.
isRenderedByWebPart()	Indica se o Painel de Propriedades/Painel de Conteúdo foi inicialmente aberto pela peça Web.
open()	Esta API deve ser utilizada para abrir o Painel de Propriedades ou o Painel de Conteúdo para ajudar a configurar a peça Web.
openDetails(context)	Esta API deve ser utilizada para abrir o Painel de Propriedades/Conteúdo de Detalhes para ajudar a configurar os itens na peça Web.
refresh()	Esta API deve ser utilizada para invocar o Painel de Propriedades ou o Painel de Conteúdo para ajudar a configurar a peça Web.

Detalhes do método

close()

Esta API deve ser utilizada para fechar o Painel de Propriedades ou o Painel de Conteúdo para ajudar a configurar a peça Web.

close(): void;

Retornos

void

isContentPanelOpen()

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Devolve true se o ContentPanel estiver aberto.

isContentPanelOpen(): boolean;

Retornos

boolean

Comentários

Devolve true se o Painel de Conteúdo estiver aberto, independentemente de o Painel de Conteúdo estar a compor o painel de propriedades.

isPropertyPaneOpen()

Devolve true se PropertyPane estiver aberto.

isPropertyPaneOpen(): boolean;

Retornos

boolean

Comentários

Isto acontece sempre que o Painel de Propriedades estiver aberto, quer esteja alojado no Painel de Conteúdo ou na IU do Painel de Propriedades tradicional.

isPropertyPaneOpen(instanceId)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Devolve true se o Painel de Conteúdo estiver aberto e o instanceId especificado for suportado no painel de conteúdos. OU Devolve verdadeiro se o painel Propriedade estiver aberto e o instanceId especificado for suportado no painel de propriedades.

isPropertyPaneOpen(instanceId?: string): boolean;

Parâmetros

instanceId

string

Retornos

boolean

isRenderedByWebPart()

Indica se o Painel de Propriedades/Painel de Conteúdo foi inicialmente aberto pela peça Web.

isRenderedByWebPart(): boolean;

Retornos

boolean

Comentários

Por exemplo, se a peça Web chamar this.context.propertyPane.open(), a propriedade será verdadeira, enquanto que se a configuração tiver sido aberta pelo anfitrião, o valor será falso.

open()

Esta API deve ser utilizada para abrir o Painel de Propriedades ou o Painel de Conteúdo para ajudar a configurar a peça Web.

open(): void;

Retornos

void

openDetails(context)

Esta API deve ser utilizada para abrir o Painel de Propriedades/Conteúdo de Detalhes para ajudar a configurar os itens na peça Web.

openDetails(context?: any): void;

Parâmetros

context

any

Adicionar contexto adicional para o painel de propriedades ou painel de conteúdo

Retornos

void

Comentários

Esta API é utilizada principalmente para configurar Detalhes, que é diferente de configurar a própria peça Web.

refresh()

Esta API deve ser utilizada para invocar o Painel de Propriedades ou o Painel de Conteúdo para ajudar a configurar a peça Web.

refresh(): void;

Retornos

void

Comentários

Esta operação só funciona quando o PropertyPane já está aberto para a peça Web atualmente ativa. Se o PropertyPane estiver aberto para outra peça Web, chamar a API de atualização não terá qualquer impacto.