Feature 元素（功能）

适用于：SharePoint 2016 |SharePoint Foundation 2013 |SharePoint Online |SharePoint Server 2013

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

定义

<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>

元素和属性

下面各部分介绍了属性、子元素和父元素。

Attributes

属性	说明
ActivateOnDefault	可选属性，类型为 Boolean。 如果在安装过程中或在创建 Web 应用程序时激活该功能（默认情况下），则为 TRUE；如果未激活该功能，则为 FALSE。 默认情况下，此属性等于 TRUE。 ActivateOnDefault 属性不适用于网站集 (网站) 或网站 (Web) 范围内的功能。 通常，服务器场范围内的功能在安装过程中会激活，当创建新的 Web 应用程序时，其中所有已安装的 Web 应用程序范围内的功能都会激活。
AlwaysForceInstall	可选属性，类型为 Boolean。 如果在安装过程中强制安装功能（即使功能已安装），则为 TRUE。 例如，如果设置为 TRUE，则每当用户尝试安装功能 (时， 功能部署事件处理程序 将始终触发，即使它已安装) 使用 scanforfeatures 或 installfeature 命令行操作。 默认情况下，此属性等于 FALSE。 AlwaysForceInstall 属性会影响所有范围内的功能。
AutoActivateInCentralAdmin	可选属性，类型为 Boolean。 如果在管理网站、网站集或 Web 应用程序中默认激活该功能，则为 TRUE。 默认情况下，此属性等于 FALSE。 AutoActivateInCentralAdmin 属性不适用于 Farm 范围内的功能。
Creator	可选 文本。
DefaultResourceFile	可选 文本。 指示用于检索功能 XML 资源的公共资源文件。 如果未在文件中指定资源，SharePoint Foundation 默认在 %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATES\FEATURES\*FeatureName*\Resources\Resources._Culture_.resx 中查找。 但是，如果要为应用程序中的所有功能提供共享核心资源文件，可以使用 DefaultResourceFile 指定一个备用文件，通过该文件访问资源。 例如，如果设置 DefaultResourceFile=“_MyFile_”，SharePoint Foundation 将在 %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\Resources\*MyFile*._Culture_.resx 中检索功能的本地化资源。
说明	可选属性，类型为 String。 返回功能执行的内容的较长表示形式。
Hidden	可选属性，类型为 Boolean。 默认情况下，此属性等于 FALSE。
Id	必需 文本。 包含功能的全局唯一标识符 (GUID)。
ImageUrl	可选 文本。 包含一个相对于 \_layouts/IMAGES 目录的 URL，该图像用于表示用户界面 (UI) 中的功能。
ImageUrlAltText	可选属性，类型为 Text。 包含表示功能的图像的替代文字。
ReceiverAssembly	可选 文本。 如果随 ReceiverClass 一起设置，则指定位于全局程序集缓存中的已签名程序集的强名称，从全局程序集缓存中可加载用于处理功能事件的接收器。
ReceiverClass	可选 文本。 如果随 ReceiverAssembly 一起设置，则指定实现功能事件处理器的类。
RequireResources	可选属性，类型为 Boolean。 如果为 TRUE ，则指定 SharePoint Foundation 通过验证功能的标准“sentinel”资源是否存在于特定区域性来检查功能的资源是否存在。 资源文件根据 格式 <Feature Directory>\Resources\Resources..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 。 例如，如果通过在 %ProgramFiles%\Common Files\Microsoft Shared\Web 服务器扩展\15\TEMPLATE\1054\XML 中放置webtempThai.xml来提供网站定义的泰文版本，则必须验证文件夹中包含的每个功能是否具有相应的资源。 * 一般情况下，SharePoint Foundation 可确保该功能的用户界面扩展组件不会显示在没有资源的网站中，但存在例外情况。 即使仔细设置 RequireResources 并且不部署网站定义，除非所有功能都有资源，功能仍会显示在资源不可用的站点中。 作为示例方案，假设你有一个自定义功能，其中包含两种语言的资源，这些语言提供自定义工具栏按钮和网站设置链接，并且你已使用其中一种语言的根网站预配了新的网站集。 然后，下载并安装第三种语言的语言包后，在原始根网站下预配此第三种语言的新子网站。 如果未将 RequireResources 设置为 TRUE，则自定义功能将尝试回退并使用 (的回退资源，即定义为 Resources\Resources.resx的资源，没有区域性。) 如果没有回退资源，SharePoint Foundation 将呈现空字符串。 但是，如果将 RequireResources 设置为 TRUE，则功能 (的用户界面扩展组件（例如，通过 CustomAction、 ListTemplate 或 FeatureSiteTemplateAssociation 元素定义的组件) ，如果没有可用资源，则子网站中将不会显示这些组件，因此自定义链接和网站设置将自动隐藏。 设置此属性仅适用于通过用户界面激活功能，而不适用于STSADM.EXE命令行操作或对象模型。
Scope	必需 文本。 指定可激活功能的范围，并包含以下值之一： 服务器场 (场) 、 WebApplication (Web 应用程序) 、 网站 (网站集) 、 Web (网站) 。 有关范围的信息，请参阅Element Scope。
SolutionId	可选 文本。 指定功能所属的解决方案。
标题	可选属性，类型为 Text。 返回功能的标题。 最多为 255 个字符。
UIVersion	可选属性，类型为 Text。 指定此功能的用户界面 (UI) 版本。 UIVersion 以多种方式指定。 * =#- 网站的 UIVersion 必须等于 #。* <# - 网站的 UIVersion 必须小于 #。* ># - 网站的 UIVersion 必须大于 #。<=#* - 网站的 UIVersion 必须小于或等于 #。* >=#- 网站的 UIVersion 必须大于或等于 。- 网站的 UIVersion 必须大于或等于 #。 * #;#- 网站的 UIVersion 必须位于以分号分隔的数字列表中。
版本	可选 文本。 指定功能版本的 System.Version 兼容的表示形式。 最多可以用小数分隔的四位数字来表示版本。

子元素

ActivationDependencies、ElementManifests、Properties、UpgradeActions Element (Feature)

父元素

无

备注

SharePoint Foundation 仅支持功能文件夹和文件名的低顺序 ASCII 字符，且不支持空格。

示例

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