IPropertyPaneAccessor interface

Paquete:

@microsoft/sp-webpart-base

Interfaz de descriptor de acceso del panel de propiedades de contexto del elemento web. Proporciona algunas de las operaciones más usadas para acceder al panel de propiedades y al panel de contenido.

Métodos

close()	Esta API debe usarse para cerrar el panel de propiedades o contenido para ayudar a configurar el elemento web.
isContentPanelOpen()	Devuelve true si ContentPanel está abierto.
isPropertyPaneOpen()	Devuelve true si propertypane está abierto.
isPropertyPaneOpen(instanceId)	Devuelve true si el panel de contenido está abierto y el valor de instanceId especificado se admite en el panel de contenido. OR Devuelve true si el panel Propiedad está abierto y el valor de instanceId especificado se admite en el panel de propiedades.
isRenderedByWebPart()	Indica si el elemento web abrió inicialmente el panel de propiedades o contenido.
open()	Esta API debe usarse para abrir el Panel de propiedades o contenido para ayudar a configurar el elemento web.
openDetails(context)	Esta API se debe usar para abrir el Panel de contenido o panel de propiedades de detalles para ayudar a configurar los elementos del elemento web.
refresh()	Esta API debe usarse para invocar el panel de propiedades o contenido para ayudar a configurar el elemento web.

Detalles del método

close()

Esta API debe usarse para cerrar el panel de propiedades o contenido para ayudar a configurar el elemento web.

close(): void;

Devoluciones

void

isContentPanelOpen()

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Devuelve true si ContentPanel está abierto.

isContentPanelOpen(): boolean;

Devoluciones

boolean

Comentarios

Devuelve true si el panel de contenido está abierto, independientemente de si el panel de contenido representa el panel de propiedades.

isPropertyPaneOpen()

Devuelve true si propertypane está abierto.

isPropertyPaneOpen(): boolean;

Devoluciones

boolean

Comentarios

Esto es así siempre que el panel de propiedades está abierto, tanto si está hospedado en el panel de contenido como en la interfaz de usuario tradicional del panel de propiedades.

isPropertyPaneOpen(instanceId)

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Devuelve true si el panel de contenido está abierto y el valor de instanceId especificado se admite en el panel de contenido. OR Devuelve true si el panel Propiedad está abierto y el valor de instanceId especificado se admite en el panel de propiedades.

isPropertyPaneOpen(instanceId?: string): boolean;

Parámetros

instanceId

string

Devoluciones

boolean

isRenderedByWebPart()

Indica si el elemento web abrió inicialmente el panel de propiedades o contenido.

isRenderedByWebPart(): boolean;

Devoluciones

boolean

Comentarios

Por ejemplo, si el elemento web llama a this.context.propertyPane.open(), la propiedad sería true, mientras que si el host abrió la configuración, el valor será false.

open()

Esta API debe usarse para abrir el Panel de propiedades o contenido para ayudar a configurar el elemento web.

open(): void;

Devoluciones

void

openDetails(context)

Esta API se debe usar para abrir el Panel de contenido o panel de propiedades de detalles para ayudar a configurar los elementos del elemento web.

openDetails(context?: any): void;

Parámetros

context

any

Agregar contexto adicional para el panel de propiedades o el panel de contenido

Devoluciones

void

Comentarios

Esta API se usa principalmente para configurar Detalles, que es diferente de configurar el propio elemento web.

refresh()

Esta API debe usarse para invocar el panel de propiedades o contenido para ayudar a configurar el elemento web.

refresh(): void;

Devoluciones

void

Comentarios

Esta operación solo funciona cuando el panel de propiedades ya está abierto para el elemento web activo actualmente. Si el panel de propiedades se abre para otro elemento web, llamar a la API de actualización no tendrá ningún impacto.