Configuration 元素(网站)

上次修改时间: 2015年3月9日

适用范围: SharePoint Foundation 2010

本文内容
属性
子元素
父元素
出现次数

指定创建 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>

属性

属性

说明

AllowGlobalFeatureAssociations

可选属性,类型为 Boolean。针对使用网站定义配置创建的网站,指定是否允许全局功能关联。

CustomMasterUrl

可选属性,类型为 Text。指定替换 .master 页的 URL,该 .master 页可用于通过网站定义配置创建的网站中的页面(无需自定义这些页面)。

备注

只需在需要使用替换母版页的页面上更改 MasterPageFile 属性的值,便可自定义那些页面,并使其存储在内容数据库中,而不是存储在前端 Web 服务器的文件系统中。

有关如何使用 CustomMasterUrl 的值的详细信息,请参阅应用程序页上的母版页

Description

可选属性,类型为 Text。包含 SharePoint Foundation UI 中显示的网站定义配置的特定于区域设置的说明。

DisplayCategory

可选属性,类型为 Text。指定网站定义配置显示在 SharePoint Foundation UI 中的类别,例如 Collaboration、Meetings 或某个自定义名称。

FilterCategories

可选属性,类型为 Text。此属性不能用于 SharePoint Foundation。它可用于在 SharePoint Foundation 上构建的增强门户或内容管理解决方案(例如 Microsoft SharePoint Server),以便用作网站配置分类方式,以这样的方式不能正确映射至 UI 中显示的类别。(另请参阅 DisplayCategory 属性。)

Hidden

可选属性,类型为 Boolean。指定网站定义配置是否作为选项显示在 SharePoint Foundation UI 中。

ID

必需属性,类型为 Integer。指定网站定义配置的 ID,它在网站定义中是唯一的。诸如 STS 或 MPS 等定义是由 WebTemp*.xml 文件中的 Template 元素和用于定义的相应 Onet.xml 文件定义的。请参阅下面的父元素说明

ImageUrl

必需属性,类型为 Text。包含 SharePoint Foundation UI 中显示的预览图像的 URL。

MasterUrl

可选属性,类型为 Text。指定用于通过网站定义配置创建的网站的默认母版页。

Name

可选属性,类型为 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

可选属性,类型为 Text。指定 ProvisionClassProvision(SPWebProvisioningProperties) 方法使用的数据(请参阅上文)。这可以是包含结构化数据的文件的路径。例如:

ProvisionData="SiteTemplates\\MySiteManifest.xml"

RootWebOnly

可选属性,类型为 Boolean。如果为 TRUE,则指定根据配置创建的网站只能作为网站集中的根网站存在。在存储在解决方案中的 Web 模板(.wsp 文件)中不强制执行此属性。

SubWebOnly

可选属性,类型为 Boolean。如果为 TRUE,则指定根据配置创建的网站只能作为网站集中的子网站存在。在存储在解决方案中的 Web 模板(.wsp 文件)中不强制执行此属性。

SupportsMultilingualUI

可选属性,类型为 Boolean。如果为 TRUE(默认值),则指定管理员可为根据配置创建的网站启用替换语言。如果为 FALSE,则阻止管理员启用此功能。

Title

可选属性,类型为 Text。包含 SharePoint Foundation UI 中显示的网站定义配置的标题。

Type

可选属性,类型为 Text。标识网站定义,例如 STS 或 MPS。

VisibilityFeatureDependency

可选属性,类型为 Text。用于在 WebTemp*.xml 文件中根据指定功能的激活状态隐藏网站定义配置。当某配置包含依赖另一功能的功能时,如果未安装或未激活指定功能,则设置此属性可防止此配置作为选项显示在 SharePoint Foundation UI 中。Web 应用程序范围内的功能不支持此属性。

子元素

ExecuteUrlListsModulesSiteFeaturesWebFeatures

父元素

ConfigurationsTemplate

出现次数

最小值:0

最大值:无限制

备注

在 WebTemp*.xml 文件中使用 Configuration 元素(请参阅 WebTemp.xml)可在网站定义中标识可用的网站定义配置。在 Onet.xml 文件中使用该元素可定义根据网站定义配置创建网站时使用的列表、模块和功能的配置。在 WebTemp*.xml 文件中,此元素包含在 Template 元素中,后者可指定网站定义。在 Onet.xml 中,此元素包含在 Configurations 元素中,后者可指定其列表在 Onet.xml 中定义的配置。

在 WebTemp*.xml 文件和 Onet.xml 文件中,均有一个用于每个网站定义的 Template 元素。

ID 属性可将 WebTemp*.xml 文件中给定网站定义的 Configuration 元素与 Onet.xml 中该相同网站定义的相应 Configuration 元素关联。

网站定义配置不同,Web 模板通过存储在 SharePoint 数据库中的 .wsp 文件内 elements.xml 文件中的 WebTemplate 元素进行定义。在 .wsp 文件中,还有一个带有单个 Configuration 元素的 Onet.xml 文件,用于指定 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>

请参阅

概念

Web 模板

网站定义和配置