通过

Feature 元素（功能）

  • 项目

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

适用范围： SharePoint Foundation 2010

本文内容
属性
子元素
父元素

定义在指定范围内激活或停用的功能。

<Feature
  ActivateOnDefault = "TRUE" | "FALSE"
  AlwaysForceInstall = "TRUE" | "FALSE"
  AutoActivateInCentralAdmin = "TRUE" | "FALSE"
  Creator = "Text" 
  DefaultResourceFile =  "Text"
  Description = "Text" 
  Hidden = "TRUE" | "FALSE"
  Id = "Text"
  ImageUrl = "Text"
  ImageUrlAltText = "Text"
  ReceiverAssembly = "Text"
  ReceiverClass = "Text"
  RequireResources = "TRUE" | "FALSE"
  Scope = "Text"
  SolutionId = "Text"
  Title = "Text"
  UIVersion = "Text"
  Version = "Text" >
</Feature>

属性

属性

说明

ActivateOnDefault

可选属性，类型为 Boolean。如果在安装过程中或在创建 Web 应用程序时激活该功能（默认情况下），则为 TRUE；如果未激活该功能，则为 FALSE。默认情况下，此属性等于 TRUE。ActivateOnDefault 属性不适用于网站集 (Site) 或网站 (Web) 范围内的功能。

一般来说，Farm 范围的功能在安装过程中会变成激活状态，而在创建新的 Web 应用程序时，此应用程序中的所有安装的 Web application 范围的功能都变为激活状态。

AlwaysForceInstall

可选属性，类型为 Boolean。如果在安装过程中强制安装功能（即使功能已安装），则为 TRUE。例如，如果设置为 TRUE，则只要用户试图使用 scanforfeatures 或 installfeature 命令行操作安装功能（即使功能已安装），就总是会触发功能部署事件处理程序。默认情况下，此属性等于 FALSE。AlwaysForceInstall 属性会影响所有范围内的功能。

AutoActivateInCentralAdmin

可选属性，类型为 Boolean。如果功能在管理网站、网站集或 Web 应用程序中已激活（默认情况），则为 TRUE。默认情况下，此属性等于 FALSE。AutoActivateInCentralAdmin 属性不适用于 Farm 范围内的功能。

Creator

可选属性，类型为 Text。

DefaultResourceFile

可选属性，类型为 Text。指示用于检索功能 XML 资源的公共资源文件。如果不在该文件中指定资源，则 SharePoint Foundation 默认情况下将在 %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\14\TEMPLATES\FEATURES\FeatureName\Resources\Resources. Culture.resx 中查找。但是，若要为应用程序中的所有功能提供共享的核心资源文件，则可以使用 DefaultResourceFile 指定通过其访问资源的替代文件。例如，如果设置 DefaultResourceFile="MyFile"，则 SharePoint Foundation 将在 %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\14\Resources\MyFile. Culture.resx 中查找以检索功能的本地化资源。

Description

可选属性，类型为 String。返回功能执行的内容的较长表示形式。

Hidden

可选属性，类型为 Boolean。默认情况下，此属性等于 FALSE。

Id

必需属性，类型为 Text。包含功能的全局唯一标识符 (GUID)。

ImageUrl

可选属性，类型为 Text。包含用于表示用户界面 (UI) 中功能的图像的相对于 /_layouts/IMAGES 目录的 URL。

ImageUrlAltText

可选属性，类型为 Text。包含表示功能的图像的替代文字。

ReceiverAssembly

可选属性，类型为 Text。如果随 ReceiverClass 一起设置，则指定位于全局程序集缓存中的已签名程序集的强名称，从全局程序集缓存中可加载用于处理功能事件的接收器。

ReceiverClass

可选属性，类型为 Text。如果随 ReceiverAssembly 一起设置，则指定实现功能事件处理器的类。

RequireResources

可选属性，类型为 Boolean。若要指定 SharePoint Foundation 通过验证功能的标准"sentinel"资源是否存在特定区域性来检查针对功能的资源是否存在，则为 TRUE。

资源文件使用格式 <Feature Directory>\Resources\Resources. <Culture Name>.resx 命名，其中 <Culture Name> 是标识区域性的名称。SharePoint Foundation 支持以下格式的区域性名称：

ll-CC

ll-Ssss-CC

区域性名称示例：

en-US 英语(美国)

de-DE 德语(德国)

fr-FR 法语(法国)

ja-JP 日语(日本)

sr-Latn-CS 塞尔维亚语(拉丁语，塞尔维亚)

Internet 工程任务组 (IETF) 语言标记格式为 ll(l)-Ssss-CC，其中：

  • ll(l) 表示所需的双字母语言标识符（或三字母语言标识符，如果该语言没有 ISO 双字母代码）。

  • Ssss 表示一个可选的脚本标识符。

  • CC 表示一个可选的区域标识符。

RequireResources 属性允许您限制某些功能的可见性范围，具体取决于功能的资源是否以特定语言的形式存在。

备注

SharePoint Foundation 不使用 DefaultResourceFile 属性指定的文件，如果存在此文件，则将其作为用于验证功能是否支持特定语言的备份文件。

如果不存在特定网站或网站集语言的文件，则会出现两种行为：

  • 如果语言的相应资源不可用，则将从用户界面隐藏功能以便在网站或网站集中激活功能。

    请记住，RequireResources 属性仅在用户界面中是强制执行的。通过带有 stsadm.exe 的命令行操作或对象模型，仍可以为网站激活不具有特定语言资源的功能。

    SharePoint Foundation 不强制执行作为更大的网站定义的一部分的功能的 RequireResources。例如，如果通过将 webtempThai.xml 放置在 %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\14\TEMPLATE\1054\XML 中来提供网站定义的泰语版本，则必须验证文件夹中包含的每种功能是否具有适当的资源。

  • 通常，SharePoint Foundation 确保功能的用户界面扩展组件不会在不具有资源的网站中显示，但存在一些例外。即使设置 RequireResources 时非常小心且未部署网站定义（除非所有功能都具有网站定义中包含的资源），功能仍可以在其资源不可用的网站中显示。

    作为一个示例方案，假定具有包含两种语言的资源的自定义功能，此功能提供自定义工具栏按钮和网站设置链接；并假定您已设置一个包含使用其中一种语言的根网站的新网站集。然后，在下载并安装第三种语言的语言包后，使用此第三种语言在原来的根网站下设置一个新的子网站。如果 RequireResources 未设置为 TRUE，则自定义功能将尝试回退并使用回退资源（即那些定义为无区域性的 Resources\Resources.resx 的资源）。如果没有回退资源，则 SharePoint Foundation 将呈现空字符串。但是，如果 RequireResources 设置为 TRUE，则在无资源可用时，功能的用户界面扩展组件（例如，通过 CustomAction、ListTemplate 或 FeatureSiteTemplateAssociation 元素定义的组件）将不会在子网站中显示，因此自定义链接和网站设置将自动隐藏。

仅在通过用户界面而不是 STSADM.EXE 命令行操作或对象模型激活功能时，设置此属性。

Scope

必需属性，类型为 Text。指定可以在其中激活功能的范围并包含下列值之一：Farm（服务器场）、WebApplication（Web 应用程序）、Site （网站集）、Web（网站）。有关范围的信息，请参阅元素的作用域。

SolutionId

可选属性，类型为 Text。指定功能所属的解决方案。

Title

可选属性，类型为 Text。返回功能的标题。最多为 255 个字符。

UIVersion

可选属性，类型为 Text。指定此功能的用户界面 (UI) 版本。可通过多种方式指定 UIVersion。

  • =# - 网站的 UIVersion 必须等于 #。

  • <# - 网站的 UIVersion 必须小于 #。

  • ># - 网站的 UIVersion 必须大于 #。

  • <=# - 网站的 UIVersion 必须小于等于 #。

  • >=# - 网站的 UIVersion 必须大于等于 #。

  • #;# - 网站的 UIVersion 必须位于分号分隔的数字列表中。

Version

可选属性，类型为 Text。指定功能版本的 System.Version 兼容的表示形式。最多可以用小数分隔的四位数字来表示版本。

子元素

ActivationDependencies、ElementManifests、Properties、UpgradeActions 元素（功能）

父元素

无

备注

SharePoint Foundation 仅支持对功能文件夹和文件名使用低位 ASCII 字符且不带空格。

示例

有关如何使用此元素的示例，请参阅 Feature.xml 文件。