IPropertyPaneAccessor interface
Интерфейс метода доступа к области свойств контекста веб-части. Предоставляет некоторые наиболее часто используемые операции для доступа к области свойств и панели содержимого.
Методы
| close() | Этот API следует использовать для закрытия PropertyPane или панели содержимого, чтобы помочь в настройке веб-части. |
| is |
Возвращает значение true, если ContentPanel открыт. |
| is |
Возвращает значение true, если PropertyPane открыт. |
| is |
Возвращает значение true, если панель содержимого открыта и указанный instanceId поддерживается на панели содержимого. OR Возвращает значение true, если панель Свойства открыта и указанный instanceId поддерживается в области свойств. |
| is |
Указывает, была ли изначально открыта веб-частью PropertyPane/Content Panel. |
| open() | Этот API следует использовать для открытия PropertyPane или панели содержимого для настройки веб-части. |
| open |
Этот API следует использовать для открытия области свойств Сведений или панели содержимого для настройки элементов в веб-части. |
| refresh() | Этот API следует использовать для вызова PropertyPane или панели содержимого для настройки веб-части. |
Сведения о методе
close()
Этот API следует использовать для закрытия PropertyPane или панели содержимого, чтобы помочь в настройке веб-части.
close(): void;Возвращаемое значение
void
isContentPanelOpen()
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает значение true, если ContentPanel открыт.
isContentPanelOpen(): boolean;Возвращаемое значение
boolean
Комментарии
Возвращает значение true, если панель содержимого открыта, независимо от того, отображается ли панель свойств на панели содержимого.
isPropertyPaneOpen()
Возвращает значение true, если PropertyPane открыт.
isPropertyPaneOpen(): boolean;Возвращаемое значение
boolean
Комментарии
Это справедливо, когда область свойств открыта независимо от того, размещена ли она на панели содержимого или в традиционном пользовательском интерфейсе области свойств.
isPropertyPaneOpen(instanceId)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает значение true, если панель содержимого открыта и указанный instanceId поддерживается на панели содержимого. OR Возвращает значение true, если панель Свойства открыта и указанный instanceId поддерживается в области свойств.
isPropertyPaneOpen(instanceId?: string): boolean;Параметры
- instanceId
-
string
Возвращаемое значение
boolean
isRenderedByWebPart()
Указывает, была ли изначально открыта веб-частью PropertyPane/Content Panel.
isRenderedByWebPart(): boolean;Возвращаемое значение
boolean
Комментарии
Например, если веб-часть вызывает this.context.propertyPane.open(), то свойство будет иметь значение true, а если конфигурация была открыта узлом, то значение будет false.
open()
Этот API следует использовать для открытия PropertyPane или панели содержимого для настройки веб-части.
open(): void;Возвращаемое значение
void
openDetails(context)
Этот API следует использовать для открытия области свойств Сведений или панели содержимого для настройки элементов в веб-части.
openDetails(context?: any): void;Параметры
- context
-
any
Добавление дополнительного контекста для области свойств или панели содержимого
Возвращаемое значение
void
Комментарии
Этот API в основном используется для настройки сведений, которая отличается от настройки самой веб-части.
refresh()
Этот API следует использовать для вызова PropertyPane или панели содержимого для настройки веб-части.
refresh(): void;Возвращаемое значение
void
Комментарии
Эта операция работает только в том случае, если PropertyPane уже открыта для активной веб-части. Если PropertyPane открыт для другой веб-части, вызов API обновления не повлияет.