IPropertyPaneAccessor interface

パッケージ:

@microsoft/sp-webpart-base

Web パーツ コンテキスト プロパティ ウィンドウ アクセサー インターフェイス。 プロパティ ウィンドウとコンテンツ パネルにアクセスするために最もよく使用される操作をいくつか提供します。

メソッド

close()	この API は、Web パーツの構成に役立つ PropertyPane またはコンテンツ パネルを閉じるのに使用する必要があります。
isContentPanelOpen()	ContentPanel が開いている場合は true を返します。
isPropertyPaneOpen()	PropertyPane が開いている場合は true を返します。
isPropertyPaneOpen(instanceId)	コンテンツ パネルが開き、指定した instanceId がコンテンツ パネルでサポートされている場合は true を返します。 OR プロパティ パネルが開き、指定した instanceId がプロパティ ウィンドウでサポートされている場合は true を返します。
isRenderedByWebPart()	PropertyPane/Content Panel が Web パーツによって最初に開かれたかどうかを示します。
open()	この API は、Web パーツの構成に役立つ PropertyPane またはコンテンツ パネルを開くために使用する必要があります。
openDetails(context)	この API を使用して Details PropertyPane/Content Panel を開き、Web パーツ内の項目を構成するのに役立つ必要があります。
refresh()	この API は、Web パーツの構成に役立つ PropertyPane またはコンテンツ パネルを呼び出すために使用する必要があります。

メソッドの詳細

close()

この API は、Web パーツの構成に役立つ PropertyPane またはコンテンツ パネルを閉じるのに使用する必要があります。

close(): void;

戻り値

void

isContentPanelOpen()

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

ContentPanel が開いている場合は true を返します。

isContentPanelOpen(): boolean;

戻り値

boolean

注釈

コンテンツ パネルがプロパティ ウィンドウをレンダリングするかどうかに関係なく、コンテンツ パネルが開いている場合は true を返します。

isPropertyPaneOpen()

PropertyPane が開いている場合は true を返します。

isPropertyPaneOpen(): boolean;

戻り値

boolean

注釈

これは、コンテンツ パネルまたは従来のプロパティ ウィンドウ UI でホストされているかどうかに関係なく、プロパティ ウィンドウが開くたびに当てはまります。

isPropertyPaneOpen(instanceId)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

コンテンツ パネルが開き、指定した instanceId がコンテンツ パネルでサポートされている場合は true を返します。 OR プロパティ パネルが開き、指定した instanceId がプロパティ ウィンドウでサポートされている場合は true を返します。

isPropertyPaneOpen(instanceId?: string): boolean;

パラメーター

instanceId

string

戻り値

boolean

isRenderedByWebPart()

PropertyPane/Content Panel が Web パーツによって最初に開かれたかどうかを示します。

isRenderedByWebPart(): boolean;

戻り値

boolean

注釈

たとえば、Web パーツが this.context.propertyPane.open() を呼び出す場合、プロパティは true になりますが、構成がホストによって開かれた場合、値は false になります。

open()

この API は、Web パーツの構成に役立つ PropertyPane またはコンテンツ パネルを開くために使用する必要があります。

open(): void;

戻り値

void

openDetails(context)

この API を使用して Details PropertyPane/Content Panel を開き、Web パーツ内の項目を構成するのに役立つ必要があります。

openDetails(context?: any): void;

パラメーター

context

any

プロパティ ウィンドウまたはコンテンツ パネルのコンテキストを追加する

戻り値

void

注釈

この API は主に Details の構成に使用されます。これは、Web パーツ自体の構成とは異なります。

refresh()

この API は、Web パーツの構成に役立つ PropertyPane またはコンテンツ パネルを呼び出すために使用する必要があります。

refresh(): void;

戻り値

void

注釈

この操作は、現在アクティブな Web パーツに対して PropertyPane が既に開いている場合にのみ機能します。 PropertyPane が別の Web パーツ用に開かれている場合、更新 API を呼び出しても影響はありません。