Partager via

IPropertyPaneAccessor interface

  • Référence
Paquet:
@microsoft/sp-webpart-base

Interface d’accesseur du volet de propriétés du contexte du composant WebPart. Fournit certaines opérations les plus couramment utilisées pour accéder au volet de propriétés et au panneau de contenu.

Méthodes

close()

Cette API doit être utilisée pour fermer propertypane ou content panel afin de faciliter la configuration du composant WebPart.
isContentPanelOpen()

Retourne true si le ContentPanel est ouvert.
isPropertyPaneOpen()

Retourne true si propertyPane est ouvert.
isPropertyPaneOpen(instanceId)

Retourne la valeur true si le panneau de contenu est ouvert et que l’instanceId spécifié est pris en charge dans le panneau de contenu. OR renvoie la valeur true si le panneau Propriété est ouvert et que l’instanceId spécifié est pris en charge dans le volet des propriétés.
isRenderedByWebPart()

Indique si le volet PropertyPane/Content a été initialement ouvert par le composant WebPart.
open()

Cette API doit être utilisée pour ouvrir propertypane ou content panel afin de configurer le composant WebPart.
openDetails(context)

Cette API doit être utilisée pour ouvrir la propriété DetailsPane/Panneau de contenu afin de faciliter la configuration des éléments dans le composant WebPart.
refresh()

Cette API doit être utilisée pour appeler PropertyPane ou Content Panel pour faciliter la configuration du composant WebPart.

Détails de la méthode

close()

Cette API doit être utilisée pour fermer propertypane ou content panel afin de faciliter la configuration du composant WebPart.

close(): void;

Retours

void

isContentPanelOpen()

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Retourne true si le ContentPanel est ouvert.

isContentPanelOpen(): boolean;

Retours

boolean

Remarques

Retourne la valeur true si le panneau de contenu est ouvert, que le panneau de contenu affiche le volet de propriétés.

isPropertyPaneOpen()

Retourne true si propertyPane est ouvert.

isPropertyPaneOpen(): boolean;

Retours

boolean

Remarques

Cela est vrai chaque fois que le volet de propriétés est ouvert, qu’il soit hébergé dans le panneau de contenu ou dans l’interface utilisateur traditionnelle du volet de propriétés.

isPropertyPaneOpen(instanceId)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Retourne la valeur true si le panneau de contenu est ouvert et que l’instanceId spécifié est pris en charge dans le panneau de contenu. OR renvoie la valeur true si le panneau Propriété est ouvert et que l’instanceId spécifié est pris en charge dans le volet des propriétés.

isPropertyPaneOpen(instanceId?: string): boolean;

Paramètres

instanceId

string

Retours

boolean

isRenderedByWebPart()

Indique si le volet PropertyPane/Content a été initialement ouvert par le composant WebPart.

isRenderedByWebPart(): boolean;

Retours

boolean

Remarques

Par exemple, si le composant WebPart appelle this.context.propertyPane.open(), la propriété est true, tandis que si la configuration a été ouverte par l’hôte, la valeur est false.

open()

Cette API doit être utilisée pour ouvrir propertypane ou content panel afin de configurer le composant WebPart.

open(): void;

Retours

void

openDetails(context)

Cette API doit être utilisée pour ouvrir la propriété DetailsPane/Panneau de contenu afin de faciliter la configuration des éléments dans le composant WebPart.

openDetails(context?: any): void;

Paramètres

context

any

Ajouter un contexte supplémentaire pour le volet de propriétés ou le volet de contenu

Retours

void

Remarques

Cette API est principalement utilisée pour la configuration des détails, ce qui est différent de la configuration du composant WebPart lui-même.

refresh()

Cette API doit être utilisée pour appeler PropertyPane ou Content Panel pour faciliter la configuration du composant WebPart.

refresh(): void;

Retours

void

Remarques

Cette opération ne fonctionne que lorsque PropertyPane est déjà ouvert pour le composant WebPart actuellement actif. Si PropertyPane est ouvert pour un autre composant WebPart, l’appel de l’API d’actualisation n’aura aucun impact.