PlaceholderProvider class
サード パーティのコンポーネントが SharePoint プレースホルダーを検出して使用できるようにします。 プレースホルダーを使用すると、サード パーティのコンポーネントは、ページ上の指定されたリージョンにカスタム コンテンツをレンダリングできます。
注釈
プレースホルダーは、定義済みの PlaceholderName 定数のいずれかで識別される、ページ上の指定されたリージョンです。 アプリケーションとページによって、異なるプレースホルダー名がサポートされる場合があります。 プレースホルダーは、ユーザーがページを操作する際に表示および非表示になる場合があります (インプレース ナビゲーションなど)。 サード パーティ製コンポーネントでは、特定のプレースホルダーが常に使用可能であると想定しないでください。
プレースホルダーが使用可能かどうかをテストし、それにコンテンツを追加するには、 PlaceholderProvider.tryCreateContent() を使用します。 PlaceholderProvider.changedEvent イベントを使用して、新しいプレースホルダーがいつ表示されたかを検出します。
このクラスのコンストラクターは、内部にマークされています。 サードパーティのコードは、コンストラクターを直接呼び出したり、PlaceholderProvider クラスを展開するサブクラスを作成したりすることはできません。
プロパティ
| is |
|
| placeholder |
現在使用可能なプレースホルダーの名前を返します。 |
メソッド
| dispose() | |
| try |
指定したプレースホルダーがページに含まれているかどうかをテストします。 その場合は、新しい PlaceholderContent オブジェクトが作成されます。これにより、呼び出し元はプレースホルダー内にカスタム コンテンツをレンダリングできます。 |
イベント
| changed |
このイベントは、現在使用可能なプレースホルダーの一覧が変更されたときに発生します。 |
プロパティの詳細
isDisposed
get isDisposed(): boolean;プロパティ値
boolean
placeholderNames
現在使用可能なプレースホルダーの名前を返します。
get placeholderNames(): ReadonlyArray<PlaceholderName>;プロパティ値
ReadonlyArray<PlaceholderName>
メソッドの詳細
dispose()
dispose(): void;戻り値
void
tryCreateContent(name, options)
指定したプレースホルダーがページに含まれているかどうかをテストします。 その場合は、新しい PlaceholderContent オブジェクトが作成されます。これにより、呼び出し元はプレースホルダー内にカスタム コンテンツをレンダリングできます。
tryCreateContent(name: PlaceholderName, options?: IPlaceholderCreateContentOptions): PlaceholderContent | undefined;パラメーター
- name
- PlaceholderName
要求されたプレースホルダー
- options
- IPlaceholderCreateContentOptions
プレースホルダーが破棄されたタイミングを検出するためのその他のオプション。
戻り値
PlaceholderContent | undefined
新しい PlaceholderContent オブジェクト。要求されたプレースホルダーが存在しない場合は未定義です。
注釈
ホスト アプリケーションは、特定のプレースホルダーの可用性について保証しません。 予期されるプレースホルダーが使用できない場合、サード パーティの拡張機能は、何もレンダリングしない場合や代替プレースホルダーを選択することによって、適切に処理する必要があります。
イベントの詳細
changedEvent
このイベントは、現在使用可能なプレースホルダーの一覧が変更されたときに発生します。
get changedEvent(): SPEvent<SPEventArgs>;イベントの種類
注釈
アプリケーションは、使用可能なプレースホルダーの一覧をいつでも変更できます。 つまり、既存のプレースホルダーが破棄されたり、新しいプレースホルダーが追加されたりする可能性があります。 このイベントを使用して、新しいプレースホルダーが表示されたときに検出します。