SPWeb class

包:

@microsoft/sp-page-context

此类主要用于 PageContext 类。 它为托管页面的 SharePoint 网站 (“SPWeb”) 提供上下文信息。

注解

此类的构造函数标记为内部。 第三方代码不应直接调用构造函数或创建扩展类的 SPWeb 子类。

属性

absoluteUrl	返回此 SPWeb 的绝对 URL。 例如："https://example.com/sites/PubSite/SubWeb"
description	返回当前 SPWeb 的说明。
firstDayOfWeek	如果尚未设置，则返回 Web 的区域第一天设置或未定义。
id	用于标识服务器上 SPWeb 的 GUID。
isAppWeb	如果此 SPWeb 容器 Web 为 SPApp，则返回 true。
language	返回网站的默认语言的区域设置标识符 (LCID)。
languageName	返回网站默认语言的语言名称。
logoUrl	返回网站徽标的绝对 URL。
permissions	返回表示当前用户所具有的与网站交互的权限集的 SPPermission 对象。
serverRelativeUrl	返回此 SPWeb 相对于服务器的 URL。
templateName	返回表示用于创建网站的网站定义或网站模板的数字标识符的字符串。
timeZoneInfo	返回 Web 的区域时区设置或未定义（如果尚未设置）。
title	返回当前 SPWeb 的标题。

属性详细信息

absoluteUrl

返回此 SPWeb 的绝对 URL。 例如："https://example.com/sites/PubSite/SubWeb"

readonly absoluteUrl: string;

属性值

string

description

返回当前 SPWeb 的说明。

readonly description: string;

属性值

string

firstDayOfWeek

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

如果尚未设置，则返回 Web 的区域第一天设置或未定义。

readonly firstDayOfWeek: SPDayOfWeek | undefined;

属性值

SPDayOfWeek | undefined

id

用于标识服务器上 SPWeb 的 GUID。

readonly id: Guid;

属性值

Guid

isAppWeb

如果此 SPWeb 容器 Web 为 SPApp，则返回 true。

readonly isAppWeb: boolean;

属性值

boolean

language

返回网站的默认语言的区域设置标识符 (LCID)。

readonly language: number;

属性值

number

注解

示例：1033 表示 en-US 的区域设置标识符。

languageName

返回网站默认语言的语言名称。

readonly languageName: string;

属性值

string

注解

示例：en-US 表示美国区域设置中的英语。

logoUrl

返回网站徽标的绝对 URL。

readonly logoUrl: string;

属性值

string

注解

示例： https://example.com/sites/PubSite/SubWeb/logo.jpg

permissions

返回表示当前用户所具有的与网站交互的权限集的 SPPermission 对象。

readonly permissions: SPPermission;

属性值

SPPermission

serverRelativeUrl

返回此 SPWeb 相对于服务器的 URL。

readonly serverRelativeUrl: string;

属性值

string

注解

例如："/sites/PubSite/SubWeb"

templateName

返回表示用于创建网站的网站定义或网站模板的数字标识符的字符串。

readonly templateName: string;

属性值

string

注解

示例： "1" 表示在 SharePoint 上创建新网站时的团队网站模板。

timeZoneInfo

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

返回 Web 的区域时区设置或未定义（如果尚未设置）。

readonly timeZoneInfo: SPTimeZone | undefined;

属性值

SPTimeZone | undefined

title

返回当前 SPWeb 的标题。

readonly title: string;

属性值

string