配置元素 (站点)
适用于: SharePoint 2016 |SharePoint Foundation 2013 |SharePoint Online |SharePoint Server 2013
指定创建 SharePoint Foundation 网站时使用的列表和模块,该网站基于 Configuration 元素表示的网站定义配置。 这些元素还可表示 Web 模板中的配置。
为简单起见,即使该主题同样适用于 Web 模板配置,也在该主题中使用短语“网站定义配置”。 除非另有指定,否则以下属性说明适用于网站定义和 Web 模板中的 Configuration 元素。
<Configuration
AllowGlobalFeatureAssociations = "TRUE" | "FALSE"
CustomMasterUrl = "Text"
Description = "Text"
DisplayCategory = "Text"
FilterCategories = "Text"
Hidden = "TRUE" | "FALSE"
ID = "Integer"
ImageUrl = "Text"
MasterUrl = "Text"
Name = "Text"
ProvisionAssembly = "Text"
ProvisionClass = "Text"
ProvisionData = "Text"
RootWebOnly = "TRUE" | "FALSE"
SubWebOnly = "TRUE" | "FALSE"
SupportsMultilingualUI = "TRUE" | "FALSE"
Title = "Text"
Type = "Text"
VisibilityFeatureDependency = "Text">
</Configuration>
元素和属性
下面各部分介绍了属性、子元素和父元素。
Attributes
属性 | 说明 |
---|---|
AllowGlobalFeatureAssociations |
可选属性,类型为 Boolean。 针对使用网站定义配置创建的网站,指定是否允许全局功能关联。 |
CustomMasterUrl |
可选 文本。 指定备用 .master 页的 URL,该页可用于通过网站定义配置创建的网站中的页面,而无需自定义这些页面。 注意:只需更改需要备用母版页的页面上 MasterPageFile 属性的值即可自定义这些页面,并使它们存储在内容数据库中,而不是前端 Web 服务器的文件系统中。 有关如何使用 CustomMasterUrl 值的详细信息,请参阅 应用程序页上的母版页。 |
说明 |
可选 文本。 包含 SharePoint Foundation UI 中显示的网站定义配置特定于区域设置的说明。 |
DisplayCategory |
可选 文本。 指定网站定义配置将显示在 SharePoint Foundation UI 中的类别,例如 协作、 会议或某些自定义名称。 |
FilterCategories |
可选 文本。 SharePoint Foundation 不使用此属性。 它可用于基于 SharePoint Foundation 构建的增强门户或内容管理解决方案(如 Microsoft SharePoint Server),以不精确映射到 UI 中显示的分类的方式对网站配置进行分类。 (另请参阅 DisplayCategory 属性。) |
Hidden |
可选属性,类型为 Boolean。 指定网站定义配置是否显示为 SharePoint Foundation UI 中的选项。 |
ID |
必需属性,类型为 Integer。 指定网站定义配置的 ID,它在网站定义中是唯一的。 定义(如 STS 或 MPS)由文件中的 Template 元素 WebTemp*.xml 和定义的相应 Onet.xml 文件定义。 请参阅下面的父元素和说明。 |
ImageUrl |
必需 文本。 包含 SharePoint Foundation UI 中显示的预览图像的 URL。 |
MasterUrl |
可选 文本。 指定要用于通过网站定义配置创建的网站的默认母版页。 |
名称 |
可选属性,类型为 Text。 包含网站定义配置的名称。 |
ProvisionAssembly |
可选属性,类型为 Text。 指定包含 provision 类的程序集(如果有)的名称。 (请参阅下面的 ProvisionClass 。) 例如:ProvisionAssembly="MyCompany.SharePoint.ProvisionHelper, Version=1.0.0.0, Culture=neutral, PublicKeyToken=82f0cdf222f0530d" |
ProvisionClass |
可选属性,类型为 Text。 指定特定类的完全限定名,该类可提供运行库根据配置创建完网站后将执行的设置功能。 不需要有这样的类,但如果自定义配置需要一个类,它必须派生自 SPWebProvisioningProvider 。 例如:ProvisionClass="MyCompany.SharePoint. ProvisionHelper.MySiteProvisioningProvider" |
ProvisionData |
可选 文本。 指定 ProvisionClass (SPWebProvisioningProperties) 方法将使用的数据 (请参阅上面的) 。 这可以是包含结构化数据的文件的路径。 例如:ProvisionData="SiteTemplates\\MySiteManifest.xml" |
RootWebOnly |
可选属性,类型为 Boolean。 如果为 TRUE ,则指定从配置创建的网站仅作为网站集中的根网站存在。 在存储在解决方案 (文件中) .wsp 的 Web 模板中不强制实施此属性。 |
SubWebOnly |
可选属性,类型为 Boolean。 如果为 TRUE,则指定根据配置创建的网站只能作为网站集中的子网站存在。 在存储在解决方案 (文件中) .wsp 的 Web 模板中不强制实施此属性。 |
SupportsMultilingualUI |
可选属性,类型为 Boolean。 如果为 TRUE(默认值),则指定管理员可为根据配置创建的网站启用替换语言。 如果为 FALSE,则阻止管理员启用此功能。 |
标题 |
可选 文本。 包含 SharePoint Foundation UI 中显示的网站定义配置的标题。 |
类型 |
可选属性,类型为 Text。 标识网站定义,例如 STS 或 MPS。 |
VisibilityFeatureDependency |
可选 文本。 在 文件中 WebTemp*.xml 用于根据指定功能的激活状态隐藏网站定义配置。 当配置包含依赖于另一个功能的功能时,如果指定的功能未安装或激活,则设置此属性可防止配置显示为 SharePoint Foundation UI 中的选项。 Web 应用程序范围内的功能不支持此属性。 |
子元素
父元素
出现次数
- 最小值:0
- 最大值:无限制
备注
Configuration 元素在文件中使用WebTemp*.xml
, (查看WebTemp.xml) ,以标识网站定义中的可用站点定义配置。
在 Onet.xml 文件中使用该元素可定义根据网站定义配置创建网站时使用的列表、模块和功能的配置。
在文件中 WebTemp*.xml
,此元素包含在指定网站定义的 Template 元素中。 在 中 Onet.xml
,此元素包含在 Configurations 元素中,该元素指定其列表在 中 Onet.xml
定义的配置。
一个文件中有一个 WebTemp*.xml
Template 元素,每个网站定义都有一个Onet.xml
文件。
ID 属性将 文件中给定网站定义的 Configuration 元素与 中Onet.xml
同一WebTemp*.xml
站点定义的相应 Configuration 元素相关联。
Web 模板不同于网站定义配置,它使用存储在 SharePoint 数据库中的 .wsp 文件中的文件中的 WebTemplate 元素elements.xml
进行定义。 .wsp 文件中还有一个 Onet.xml
文件,其中包含一个 Configuration 元素,用于指定 Web 模板的详细信息。
示例
以下示例来自WebTemp.xml 指定 STS 网站定义的三个配置。
<Template Name="STS" ID="1">
<Configuration ID="0" Title="Team Site" Hidden="FALSE" ImageUrl="/_layouts/images/stts.png" Description="A site for teams to quickly organize, author, and share information. It provides a document library, and lists for managing announcements, calendar items, tasks, and discussions." DisplayCategory="Collaboration" > </Configuration>
<Configuration ID="1" Title="Blank Site" Hidden="FALSE" ImageUrl="/_layouts/images/stbs.png" Description="A blank site for you to customize based on your requirements." DisplayCategory="Collaboration" AllowGlobalFeatureAssociations="False" > </Configuration>
<Configuration ID="2" Title="Document Workspace" Hidden="FALSE" ImageUrl="/_layouts/images/stdw.png" Description="A site for colleagues to work together on a document. It provides a document library for storing the primary document and supporting files, a tasks list for assigning to-do items, and a links list for resources related to the document." DisplayCategory="Collaboration" > </Configuration>
</Template>