PlaceholderContent class
SharePoint ページのプレースホルダー内にレンダリングされるカスタム コンテンツを表します。
注釈
このオブジェクトは、 PlaceholderProvider.tryCreateContent()によって返されます。 所有者がカスタム コンテンツをレンダリングできる Document Object Model (DOM) 要素へのアクセスを提供します。
このクラスのコンストラクターは、内部にマークされています。 サードパーティのコードは、コンストラクターを直接呼び出したり、PlaceholderContent クラスを展開するサブクラスを作成したりすることはできません。
プロパティ
| dom |
所有者がカスタム コンテンツをレンダリングするドキュメント オブジェクト モデル (DOM) 要素。 |
| is |
|
| is |
この PlacholderContent オブジェクトが表示されている場合は true を返します。 プレースホルダーを作成し、ホスト ページに表示されていない場合、false が返されます。 |
| name | このコンテンツが追加されたプレースホルダーを識別します。 |
メソッド
| dispose() | PlaceholderContent オブジェクトを破棄し、添付された DOM 要素をページから削除します。 |
プロパティの詳細
domElement
所有者がカスタム コンテンツをレンダリングするドキュメント オブジェクト モデル (DOM) 要素。
get domElement(): HTMLDivElement;プロパティ値
HTMLDivElement
注釈
DOM 要素が破棄されたときに呼び出し元に通知する必要がある場合は、 IPlaceholderCreateContentOptions.onDispose コールバックを 使用します。
isDisposed
get isDisposed(): boolean;プロパティ値
boolean
isVisible
この PlacholderContent オブジェクトが表示されている場合は true を返します。 プレースホルダーを作成し、ホスト ページに表示されていない場合、false が返されます。
get isVisible(): boolean;プロパティ値
boolean
name
このコンテンツが追加されたプレースホルダーを識別します。
get name(): PlaceholderName;プロパティ値
注釈
例: PlaceholderName.Top
メソッドの詳細
dispose()
PlaceholderContent オブジェクトを破棄し、添付された DOM 要素をページから削除します。
dispose(): void;戻り値
void
注釈
このメソッドを呼び出して、アタッチされた DOM 要素を直ちに破棄できます。 それ以外の場合は、 を含むプレースホルダーが破棄されるときに、アプリケーションによって破棄されます。 dispose() を呼び出すと 、IPlaceholderCreateContentOptions.onDispose コールバックが呼び出され、関連する DOM 要素がページから削除され、PlaceholderContent オブジェクトが破棄されます。