Feature, élément (Feature)

  • Article

S’applique à : SharePoint 2016 | SharePoint Foundation 2013 | | SharePoint Online SharePoint Server 2013

Définit un Composant fonctionnel à activer ou à désactiver au niveau d’une étendue spécifiée.

Définition

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

Éléments et attributs

Les sections suivantes décrivent les attributs, les éléments enfants et les éléments parents.

Attributs

Attribut Description
ActivateOnDefault Facultatif Boolean. TRUE si le Composant fonctionnel est activé par défaut pendant l’installation ou lorsqu’une application Web est créée ; FALSE si le Composant fonctionnel n’est pas activé. Cet attribut correspond à TRUE par défaut. L’attribut ActivateOnDefault ne s’applique pas aux fonctionnalités délimitées à la collection de sites (Site) ou au site web (Web).

En général, les fonctionnalités étendues à la batterie de serveurs sont activées lors de l’installation, et lorsqu’une nouvelle application web est créée, toutes les fonctionnalités installées dans l’étendue de l’application web sont activées.
AlwaysForceInstall Facultatif Boolean. TRUE si le Composant fonctionnel est installé d’office au cours de l’installation, même s’il est déjà installé. Par exemple, s’il est défini sur TRUE, les gestionnaires d’événements de déploiement de fonctionnalités sont toujours déclenchés chaque fois qu’un utilisateur tente d’installer la fonctionnalité (même si elle est déjà installée) à l’aide de l’opération de ligne de commande scanforfeatures ou installfeature . Cet attribut correspond à FALSE par défaut. L’attribut AlwaysForceInstall affecte les Composants fonctionnels de toutes étendues.
AutoActivateInCentralAdmin Facultatif Boolean. TRUE si la fonctionnalité est activée par défaut dans le site web d’administration, la collection de sites ou l’application Web. Cet attribut correspond à FALSE par défaut. L’attribut AutoActivateInCentralAdmin ne s’applique pas aux Composants fonctionnels d'étendue Farm.
Creator Texte facultatif.
DefaultResourceFile Texte facultatif. Indique un fichier de ressources courantes pour la récupération des ressources XML des Composants fonctionnels. Si vous ne spécifiez pas de ressource dans le fichier, SharePoint Foundation recherche par défaut %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATES\FEATURES\*FeatureName*\Resources\Resources._Culture_.resx.

Toutefois, si vous souhaitez fournir un fichier de ressources de base partagé pour toutes les fonctionnalités de votre application, vous pouvez spécifier un autre fichier par le biais duquel accéder aux ressources à l’aide de DefaultResourceFile. Par exemple, si vous définissez DefaultResourceFile="_MyFile_ », SharePoint Foundation recherche %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\Resources\*MyFile*._Culture_.resx pour récupérer des ressources localisées pour votre fonctionnalité.
Description Argument de type String facultatif. Retourne une représentation plus longue de ce que fait le Composant fonctionnel.
Hidden Facultatif Boolean. Cet attribut correspond à FALSE par défaut.
Id Texte obligatoire. Contient l’identificateur global unique (GUID) pour le Composant fonctionnel.
Imageurl Texte facultatif. Contient une URL relative au répertoire \_layouts/IMAGES qu’une image doit utiliser pour représenter la fonctionnalité dans l’interface utilisateur.
ImageUrlAltText Argument Text facultatif. Contient le texte de remplacement pour l’image qui représente la fonctionnalité.
ReceiverAssembly Texte facultatif. Si défini en même temps que ReceiverClass, spécifie le nom fort de l’assembly signé situé dans le Global Assembly Cache à partir duquel charger un récepteur pour gérer les événements des Composants fonctionnels.
ReceiverClass Texte facultatif. Si défini en même temps que ReceiverAssembly, spécifie la classe qui implémente le processeur des événements des Composants fonctionnels.
RequireResources Facultatif Boolean. TRUE pour spécifier que SharePoint Foundation vérifie si des ressources existent pour la fonctionnalité en vérifiant que la ressource « sentinel » standard pour la fonctionnalité est présente pour une culture particulière.

Le fichier de ressources est nommé selon le format <Feature Directory>\Resources\Resources..resx, où <Culture Name> est le nom qui identifie la culture. SharePoint Foundation prend en charge les formats suivants pour les noms de culture :

ll-CC
ll-Ssss-CC


Exemples de noms de culture :

en-US English (États-Unis)

de-DE German (Germany)

fr-FR Français (France)

ja-JP Japonais (Japon)

sr-Latn-CS Serbe (Latin, Serbie)

The Internet Engineering Task Force (IETF) le format de balise de langue est ll(l)-Ssss-CC, où :* ll(l)

désigne l’identificateur de langue à deux lettres requis (ou trois lettres s’il n’existe aucun code ISO à deux lettres pour la langue).
Ssss* désigne un identificateur de script facultatif.* CC
Désigne un identificateur de région facultatif.

L’attribut RequireResources vous permet de rétrécir la visibilité de certaines fonctionnalités selon que les ressources existent ou non dans un langage particulier pour la fonctionnalité.

Remarque : SharePoint Foundation n’utilise pas le fichier spécifié par l’attribut DefaultResourceFile, le cas échéant, comme fichier de sauvegarde pour vérifier la prise en charge d’une langue particulière pour une fonctionnalité.

Si le fichier n’est pas présent pour la langue d’un site web ou d’une collection de sites particulière, deux comportements peuvent se produire :

* La fonctionnalité est masquée de l’interface utilisateur pour l’activation des fonctionnalités dans le site web ou la collection de sites si les ressources correspondantes pour la langue ne sont pas disponibles.

N’oubliez pas que l’attribut RequireResources est appliqué uniquement dans l’interface utilisateur. Une fonctionnalité sans ressources pour un langage particulier peut toujours être activée pour un site web par le biais d’opérations en ligne de commande avec stsadm.exe ou via le modèle objet.

SharePoint Foundation n’applique pas RequireResources pour les fonctionnalités qui font partie d’une définition de site plus grande. Si vous fournissez, par exemple, une version thaïlandaise d’une définition de site en plaçant un webtempThai.xml dans %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATE\1054\XML, vous devez vérifier que chaque fonctionnalité contenue dans le dossier dispose des ressources appropriées.

* En général, SharePoint Foundation garantit que les composants d’extension d’interface utilisateur de la fonctionnalité ne s’affichent pas dans les sites web qui n’ont pas de ressources, mais il existe des exceptions. Même si vous définissez soigneusement RequireResources et que vous ne déployez pas de définitions de site, sauf si toutes les fonctionnalités contiennent des ressources, les fonctionnalités peuvent toujours apparaître dans les sites où les ressources ne sont pas disponibles.

Par exemple, supposons que vous disposez d’une fonctionnalité personnalisée avec des ressources pour deux langues qui fournit des boutons de barre d’outils personnalisés et des liens de paramètres de site, et que vous avez provisionné une nouvelle collection de sites avec un site web racine dans l’une des langues. Ensuite, après avoir téléchargé et installé le module linguistique pour une troisième langue, vous approvisionnez un nouveau sous-site dans cette troisième langue sous le site web racine d’origine. Si RequireResources n’est pas défini sur TRUE, la fonctionnalité personnalisée tente de revenir en arrière et d’utiliser les ressources de secours (en d’autres termes, celles définies comme Resources\Resources.resx, sans culture).) S’il n’existe aucune ressource de secours, SharePoint Foundation affiche les chaînes vides. Toutefois, si RequireResources est défini sur TRUE, les composants d’extension d’interface utilisateur de la fonctionnalité (par exemple, ceux définis par le biais d’un élément CustomAction, ListTemplate ou FeatureSiteTemplateAssociation) ne s’affichent pas dans les sous-sites si aucune ressource n’est disponible, de sorte que les liens personnalisés et les paramètres de site sont automatiquement masqués.

La définition de cet attribut s’applique uniquement à l’activation des fonctionnalités via l’interface utilisateur, et non par STSADM.EXE opérations de ligne de commande ou le modèle objet.
Scope Texte obligatoire. Spécifie l’étendue dans laquelle la fonctionnalité peut être activée et contient l’une des valeurs suivantes : Farm (batterie), WebApplication (application Web), Site (collection de sites), Web (site web). Pour plus d'informations sur l'étendue, voir Element Scope.
Id de solution Texte facultatif. Spécifie la solution à laquelle appartient le Composant fonctionnel.
Titre Argument Text facultatif. Renvoie le titre du Composant fonctionnel. Limité à 255 caractères.
UIVersion Argument Text facultatif. Spécifie la version d’interface utilisateur pour cette fonctionnalité. UIVersion est spécifié de plusieurs façons.

* =# - l’UIVersion du site doit être égale à #.
<#* - l’UIVersion du site doit être inférieure #à .>#*
- la VALEUR UIVersion du site doit être supérieure #à .
<=#* - la valeur UIVersion du site doit être inférieure ou égale à #.>=#
* - l’UIVersion du site doit être supérieure ou égale à #.
* #;# - l’UIVersion du site doit figurer dans la liste de nombres délimitée par des points-virgules.
Version Texte facultatif. Spécifie une représentation conforme à System.Version de la version d’un Composant fonctionnel. Il peut s’agir de quatre nombres délimités par des décimales qui représentent une version.

Éléments enfants

ActivationDependencies, ElementManifests, Properties, UpgradeActions Element (Feature)

Éléments parents

Aucun

Remarques

SharePoint Foundation prend uniquement en charge les caractères ASCII de faible ordre et aucun espace pour les noms de dossier et de fichier de fonctionnalité.

Exemple

Pour obtenir un exemple d’utilisation de cet élément, consultez Feature.xml Files.