PageContext class
SharePoint 页面上下文对象。
注解
页面上下文为公共 SharePoint 对象提供了标准的定义，该对象需要在客户端应用程序、Web 部件和其他组件之间共享。 导航至新页时通常通过 REST 查询提取数据，但也可以通过 Web 服务器预先加载，或从自定义应用程序缓存中进行填充。
构造函数
| (constructor)(service |
构造 类的新实例 |
属性
| aad |
用于与 Azure Active Directory 通信的上下文信息。 如果当前页没有关联的 Azure Active Directory 租户，则此属性将未定义。 |
| culture |
它为应用程序的当前用户提供区域性信息。 此类主要用于 |
| is |
返回是否已 |
| legacy |
提供某些旧脚本可能需要的经典 SharePoint 属性的对象。 |
| list | 承载该页面的 SharePoint 列表的上下文信息。 如果没有与当前页关联的列表，则未定义此属性。 |
| list |
承载该页面的 SharePoint 列表项的上下文信息。 如果没有与当前页关联的列表项，则未定义此属性。 |
| page | 公开与当前显示的 SharePoint 网页关联的信息。 |
| service |
PageContext 的服务密钥。 |
| site | 承载页面的 SharePoint 网站集 (“SPSite”) 上下文信息。 |
| user | 它为访问该页的 SharePoint 用户提供上下文信息。 此类主要用于 |
| web | 托管页面的 SharePoint 网站的上下文信息 (“SPWeb”) 。 |
构造函数详细信息
(constructor)(serviceScope)
属性详细信息
aadInfo
用于与 Azure Active Directory 通信的上下文信息。 如果当前页没有关联的 Azure Active Directory 租户，则此属性将未定义。
get aadInfo(): AzureActiveDirectoryInfo | undefined;属性值
AzureActiveDirectoryInfo | undefined
cultureInfo
isInitialized
返回是否已 PageContext 初始化 。
get isInitialized(): boolean;属性值
boolean
legacyPageContext
提供某些旧脚本可能需要的经典 SharePoint 属性的对象。
get legacyPageContext(): any;属性值
any
注解
提供此属性是为了促进旧代码的迁移。 它返回一个 JavaScript 对象，其内容类似于经典页面中的 _spPageContextInfo 窗口变量。 SharePoint 的未来版本可能会更改此变量的内容。 因此，建议新项目改用 SharePoint 框架 TypeScript API，因为它们已完整记录，并提供可靠的向后兼容性保证。
注意：如果在 中 legacyPageContext 公开了某些功能，但似乎没有适当的 TypeScript API，请在 GitHub 上提出问题。 其意图是，任何新式应用程序都不应依赖于 对象 legacyPageContext 。
list
承载该页面的 SharePoint 列表的上下文信息。 如果没有与当前页关联的列表，则未定义此属性。
get list(): SPList | undefined;属性值
SPList | undefined
listItem
承载该页面的 SharePoint 列表项的上下文信息。 如果没有与当前页关联的列表项，则未定义此属性。
get listItem(): SPListItem | undefined;属性值
SPListItem | undefined
page
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
公开与当前显示的 SharePoint 网页关联的信息。
get page(): Page;