Partager via


Feature, élément (Feature)

Dernière modification : vendredi 28 janvier 2011

S’applique à : SharePoint Foundation 2010

Dans cet article
Attributs
Éléments enfants
Éléments parents

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

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

Attributs

Attribut

Description

ActivateOnDefault

Argument Boolean facultatif. 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 Composants fonctionnels d'étendue collection de sites (Site) ou site Web (Web).

En général, les Composants fonctionnels d'étendue Farm deviennent activés au cours de l’installation, et lorsqu’une nouvelle application Web est créée, tous les Composants fonctionnels installés, contenus dans celle-ci et d'étendue Web application, deviennent activés.

AlwaysForceInstall

Argument Boolean facultatif. TRUE si le Composant fonctionnel est installé d’office au cours de l’installation, même s’il est déjà installé. Par exemple, si la valeur est TRUE, les gestionnaires d’événements du déploiement du Composant fonctionnel se déclenchent systématiquement chaque fois qu’un utilisateur tente d’installer le composant fonctionnel (même si celui-ci est déjà installé) à 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

Argument Boolean facultatif. TRUE si le Composant fonctionnel est activé 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

Argument Text facultatif.

DefaultResourceFile

Argument Text 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 effectue une recherche par défaut dans %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\14\TEMPLATES\FEATURES\NomComposantFonctionnel\Resources\Resources. Culture.resx. Toutefois, si vous souhaitez fournir un fichier de ressources essentielles partagé pour tous les Composants fonctionnels dans votre application, vous pouvez spécifier un fichier de remplacement par le biais duquel accéder aux ressources à l’aide de DefaultResourceFile. Par exemple, si vous définissez DefaultResourceFile="MyFile", SharePoint Foundation recherche dans %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\14\Resources\MyFile. Culture.resx pour récupérer les ressources localisées pour votre Composant fonctionnel.

Description

Argument String facultatif. Retourne une représentation plus longue de ce que fait le Composant fonctionnel.

Hidden

Argument Boolean facultatif. Cet attribut correspond à FALSE par défaut.

Id

Argument Text obligatoire. Contient l’identificateur global unique (GUID) pour le Composant fonctionnel.

ImageUrl

Argument Text facultatif. Contient l’URL relative au répertoire /_layouts/IMAGES de l’image à utiliser afin de 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

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

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

Argument Boolean facultatif. TRUE pour spécifier que SharePoint Foundation détermine si des ressources existent pour le Composant fonctionnel en vérifiant que la ressource « sentinelle » standard pour le Composant fonctionnel est présente pour une culture particulière.

Le fichier de ressources est nommé en fonction du format <répertoire du Composant fonctionnel>\Resources\Resources. <nom de la culture>.resx, où <nom de la culture> représente 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 Anglais (États-Unis)

de-DE Allemand (Allemagne)

fr-FR Français (France)

ja-JP Japonais (Japon)

sr-Latn-CS Serbe (Latin, Serbie)

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

  • ll(l) correspond à l'identificateur de langue à deux lettres requis (ou trois lettres si la langue ne possède pas de code à deux lettres ISO).

  • Ssss correspond à un identificateur de script facultatif.

  • CC correspond à un identificateur de région facultatif.

L’attribut RequireResources vous permet de limiter la visibilité de Composants fonctionnels spécifiques selon qu’il existe ou non des ressources dans une langue particulière pour celle-ci.

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

  • Le Composant fonctionnel est masqué dans l’interface utilisateur, pour une activation des Composants fonctionnels dans le site Web ou dans la collection de sites, si les ressources correspondantes pour la langue ne sont pas disponibles.

    Gardez à l’esprit que l’attribut RequireResources est appliqué dans l’interface utilisateur uniquement. Un Composant fonctionnel sans ressources pour une langue particulière peut toujours être activé pour un site Web via les opérations de ligne de commande avec Stsadm.exe ou via le modèle objet.

    SharePoint Foundation n’applique pas RequireResources pour les Composants fonctionnels qui font partie d’une définition de site plus grande. Si vous fournissez, par exemple, une version thaï d’une définition de site en plaçant un fichier webtempThai.xml dans %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\14\TEMPLATE\1054\XML, vous devez vérifier que chaque Composant fonctionnel contenu dans le dossier possède les ressources appropriées.

  • En règle générale, SharePoint Foundation garantit que les composants d’extension de l’interface utilisateur du Composant fonctionnel ne s’affichent pas dans les sites Web dépourvus de ressources, mais il existe des exceptions. Même si vous prenez soin de définir RequireResources et de ne déployer les définitions de site que si tous les Composants fonctionnels y possèdent des ressources, celles-ci peuvent apparaître dans des sites où les ressources ne sont pas disponibles.

    À titre d’exemple de scénario, supposons que vous possédez un Composant fonctionnel personnalisé, doté de ressources pour deux langues et qui fournit des boutons de barre d’outils personnalisés ainsi que des liens de paramètres de site, et que vous avez mis en service 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 mettez en service 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, le Composant fonctionnel personnalisé tentera un repli et utilisera les ressources de secours (en d’autres termes, celles définies en tant que Resources\Resources.resx, sans aucune culture). S’il n’existe aucune ressource de secours, SharePoint Foundation restitue des chaînes vides. Toutefois, si RequireResources a la valeur TRUE, les composants d’extension d’interface utilisateur du Composant fonctionnel (par exemple, ceux définis par le biais d’un élément CustomAction, ListTemplate ou FeatureSiteTemplateAssociation) n’apparaissent pas dans les sous-sites si aucune ressource n’est disponible, si bien que les liens personnalisés et les paramètres de site sont automatiquement masqués.

La définition de cet attribut s’applique seulement à l’activation des Composants fonctionnels via l’interface utilisateur et non via les opérations de ligne de commande STSADM.EXE ou le modèle objet.

Scope

Argument Text obligatoire. Spécifie l'étendue dans laquelle le Composant fonctionnel peut être activé, et contient une des valeurs suivantes : Farm (batterie de serveurs), WebApplication (application Web), Site (collection de sites), Web (site Web). Pour plus d'informations sur l'étendue, voir Scope, paramètre de l'élément Feature.

SolutionId

Argument Text facultatif. Spécifie la solution à laquelle appartient le Composant fonctionnel.

Title

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ée de multiples façons.

  • =# - l’UIVersion du site doit être égale à #.

  • <# - l’UIVersion du site doit être inférieure à #.

  • ># - l’UIVersion du site doit être supérieure à #.

  • <=# - l’UIVersion du site doit être inférieure ou égale à #.

  • >=# - l’UIVersion du site doit être supérieure ou égale à #.

  • #;# - l’UIVersion du site doit se trouver dans la liste de nombres délimitée par un point-virgule.

Version

Argument Text 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, élément (Feature)

Éléments parents

Aucun

Remarques

SharePoint Foundation prend en charge uniquement les caractères ASCII de poids faible, et exclut les espaces, pour les noms de dossiers et de fichiers des Composants fonctionnels.

Exemple

Pour obtenir un exemple d'utilisation de cet élément, voir Fichiers Feature.xml.