|Important||This document may not represent best practices for current development, links to downloads and other resources may no longer be valid. Current recommended version can be found here.|
Feature Element (Feature)
This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This page may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
Defines a Feature to activate or deactivate at a specified scope.
<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" Version = "Text" > </Feature>
Optional Boolean. TRUE if the Feature is activated by default during installation or when a Web application is created; FALSE if the Feature is not activated. This attribute equals TRUE by default. The ActivateOnDefault attribute does not apply to site collection (Site) or Web site (Web) scoped Features.
In general, Farm-scoped Features become activated during installation, and when a new Web application is created, all installed Web application-scoped Features in it become activated.
Optional Boolean. TRUE if the Feature is installed by force during installation even if the Feature is already installed. For example, if set to TRUE, Feature installation callouts will always fire anytime a user tries to install the Feature (even if it is already installed) by using either the scanforfeatures or installfeature command-line operation. This attribute equals FALSE by default. The AlwaysForceInstall attribute affects Features of all scopes.
Optional Boolean. TRUE if the Feature is activated by default in the Administrative Web site, site collection, or Web application. This attribute equals FALSE by default. The AutoActivateInCentralAdmin attribute does not apply to Farm-scoped Features.
Optional Text. Indicates a common resource file for retrieving Feature XML resources. If you do not specify a resource in the file, Windows SharePoint Services looks by default in \12\TEMPLATE\FEATURES\FeatureName\Resources\Resources.<Culture>.resx. However, if you want to provide a shared core resource file for all the Features in your application, you can specify an alternate file through which to access resources by using DefaultResourceFile. For example, if you set DefaultResourceFile="MyFile", Windows SharePoint Services looks in \12\Resources\MyFile.<Culture>.resx to retrieve localized resources for your Feature.
Optional String. Returns a longer representation of what the Feature does.
Optional Boolean. This attribute equals FALSE by default.
Required Text. Contains the globally unique identifier (GUID) for the Feature.
Optional Text. Contains the site-relative URL for an image to use to represent the feature in the user interface (UI).
Optional Text. Contains the alternate text for the image that represents the feature.
Optional Text. If set along with ReceiverClass, specifies the strong name of the signed assembly located in the global assembly cache from which to load a receiver to handle Feature events.
Optional Text. If set along with ReceiverAssembly, specifies the class that implements the Feature event processor.
Optional Boolean. TRUE to specify that Windows SharePoint Services check whether resources exist for the Feature by verifying that the standard "sentinel" resource for the Feature is present for a particular culture.
The resource file is named according to the format <Feature Directory>\Resources\Resources.<Culture Name>.resx, where <Culture Name> is the name that identifies the culture. Windows SharePoint Services 3.0 supports the following formats for culture names:
Culture name examples:
en-US English (United States)
de-DE German (Germany)
fr-FR French (France)
ja-JP Japanese (Japan)
sr-Latn-CS Serbian (Latin, Serbia)
The Internet Engineering Task Force (IETF) language tag format is ll(l)-Ssss-CC, where:
The RequireResources attribute allows you to constrict the visibility of certain Features depending on whether resources exist in a particular language for the Feature.
Windows SharePoint Services does not use the file specified by the DefaultResourceFile attribute, if there is one, as a backup file for verifying support of a particular language for a feature.
If the file is not present for the language of a particular Web site or site collection, then two behaviors can occur:
Setting this attribute only applies to activating Features through the user interface, and not through STSADM.EXE command-line operations or the object model.
Required Text. Specifies the scope in which the Feature can be activated and contains one of the following values: Farm (farm), WebApplication (Web application), Site (site collection), Web (Web site). For information about scope, see Element Scope.
Optional Text. Specifies the solution to which the Feature belongs.
Optional Text. Returns the title of the Feature. Limited to 255 characters.
Optional Text. Specifies a System.Version-compliant representation of the version of a Feature. This can be up to four numbers delimited by decimals that represent a version.