PageContext class
SharePoint ページ コンテキスト オブジェクト。
注釈
ページ コンテキストは、クライアント側のアプリケーション、Web パーツ、およびその他のコンポーネント間で共有する必要のある、共通の SharePoint オブジェクトに対する標準の定義を提供します。 一般に、データは新しいページに移動するときに REST クエリによってフェッチされますが、Web サーバーによって事前に読み込ませることも、カスタムのアプリケーション キャッシュから設定することもできます。
コンストラクター
| (constructor)(service |
|
プロパティ
| aad |
Azure Active Directory と通信するためのコンテキスト情報。 現在のページに Azure Active Directory テナントが関連付けられていない場合、このプロパティは未定義になります。 |
| culture |
アプリケーションの現在のユーザーについてのカルチャ情報を提供します。 このクラスは、主に |
| is |
|
| legacy |
特定のレガシ スクリプトで必要になる可能性がある従来の SharePoint プロパティを提供するオブジェクト。 |
| list | ページをホストしている SharePoint リストについてのコンテキスト情報。 現在のページに関連付けられているリストが存在しない場合、このプロパティは未定義になります。 |
| list |
ページをホストしている SharePoint リスト アイテムについてのコンテキスト情報。 現在のページに関連付けられているリスト アイテムが存在しない場合、このプロパティは未定義になります。 |
| service |
PageContext のサービス キー。 |
| site | ページをホストしている SharePoint サイト コレクション ("SPSite") のコンテキスト情報。 |
| user | ページにアクセスしている SharePoint ユーザーについてのコンテキスト情報を提供します。 このクラスは、主に |
| web | ページをホストしている SharePoint サイト ("SPWeb") のコンテキスト情報。 |
コンストラクターの詳細
(constructor)(serviceScope)
PageContext クラスの新しいインスタンスを構築します
constructor(serviceScope: ServiceScope);パラメーター
- serviceScope
- ServiceScope
プロパティの詳細
aadInfo
Azure Active Directory と通信するためのコンテキスト情報。 現在のページに Azure Active Directory テナントが関連付けられていない場合、このプロパティは未定義になります。
get aadInfo(): AzureActiveDirectoryInfo | undefined;プロパティ値
@microsoft/sp-page-context!AzureActiveDirectoryInfo:class | undefined
cultureInfo
アプリケーションの現在のユーザーについてのカルチャ情報を提供します。 このクラスは、主に PageContext クラスで使用されます。
get cultureInfo(): CultureInfo;プロパティ値
isInitialized
PageContextが初期化されているかどうかを返します。
get isInitialized(): boolean;プロパティ値
boolean
legacyPageContext
特定のレガシ スクリプトで必要になる可能性がある従来の SharePoint プロパティを提供するオブジェクト。
get legacyPageContext(): any;プロパティ値
any
注釈
このプロパティは、レガシ コードの移行を容易にするために提供されます。 これは、コンテンツがクラシック ページの _spPageContextInfo ウィンドウ変数に似ている JavaScript オブジェクトを返します。 この変数の内容は、SharePoint の今後のリリースで変更される可能性があります。 このため、新しいプロジェクトは、完全に文書化され、信頼性の高い下位互換性の保証を提供するため、代わりに SharePoint Framework TypeScript API を使用することをお勧めします。
注: 特定の機能が legacyPageContext で公開されていても、適切な TypeScript API がない場合は、GitHub に問題を報告してください。 その目的は、最新のアプリケーションが legacyPageContext オブジェクトに依存する必要がないということです。
list
ページをホストしている SharePoint リストについてのコンテキスト情報。 現在のページに関連付けられているリストが存在しない場合、このプロパティは未定義になります。
get list(): SPList | undefined;プロパティ値
SPList | undefined
listItem
ページをホストしている SharePoint リスト アイテムについてのコンテキスト情報。 現在のページに関連付けられているリスト アイテムが存在しない場合、このプロパティは未定義になります。
get listItem(): SPListItem | undefined;プロパティ値
SPListItem | undefined
serviceKey
PageContext のサービス キー。
static readonly serviceKey: ServiceKey<PageContext>;プロパティ値
site
user
ページにアクセスしている SharePoint ユーザーについてのコンテキスト情報を提供します。 このクラスは、主に PageContext クラスで使用されます。
get user(): SPUser;