Le principe de feature stapling, bien qu'il est assez méconnu, est assez pratique. Celui-ci sert à activer automatiquement une feature à la création d'un site basé sur un certain modèle. Le principe est donc d'associer une feature à une définition de site pour que cette feature soit activée automatiquement lorsqu'un site basé sur cette définition est créé.

Nous allons développer un exemple tout simple pour montrer ce principe. Effectivement, nous allons créer une feature qui va ajouter une liste sur le site racine d'une collection de site. Nous lierons ensuite cette feature à la définition du site d'équipe pour qu'elle soit automatiquement activée si un utilisateur crée un site de ce type.

Commencez donc par ouvrir Visual Studio, créez un nouveau projet WSP Builder Project et nommez-le FeatureStapling.



Nous allons ensuite créer la feature qui devra être automatiquement activée. Ici, nous allons utiliser le principe de feature receiver pour créer la liste à l'activation de la feature. Cliquez donc avec le bouton droit de votre souris sur votre projet et faites Add > New Item et choisissez Blank feature :



Choisissez Site pour le scope de cette feature. Supprimez ensuite le fichier Elements.xml ainsi que le contenu de l'élément ElementManifest. Au final, votre fichier feature.xml devrait contenir ceci :

<?xml version="1.0" encoding="utf-8"?> <Feature Id="94f6fe5f-3f44-4f60-89af-fdbe87fff421" Title="Automatic Feature" Description="Description for AutomaticFeature" Version="12.0.0.0" Hidden="FALSE" Scope="Site" DefaultResourceFile="core" xmlns="http://schemas.microsoft.com/sharepoint/"> <ElementManifests /> </Feature>

Ajoutez ensuite une nouvelle classe à votre projet que vous nommerez AutomaticFeatureReceiver.cs.



Cliquez ensuite avec le bouton droit de votre souris sur le dossier References de votre projet et cliquez sur Add Reference. Dans la liste qui apparaît, choisissez Windows SharePoint Services et validez. Revenez ensuite dans votre classe et rendez-la publique en rajoutant public devant le mot-clé class. Ajoutez enfin la directive suivante :

using Microsoft.SharePoint;

Faites également dériver votre classe de SPFeatureReceiver :

public class AutomaticFeatureReceiver : SPFeatureReceiver { public override void FeatureActivated(SPFeatureReceiverProperties properties) { } public override void FeatureDeactivating(SPFeatureReceiverProperties properties) { } public override void FeatureInstalled(SPFeatureReceiverProperties properties) { } public override void FeatureUninstalling(SPFeatureReceiverProperties properties) { } }

Le code de la fonction FeatureActivated ne va pas être compliqué, il va se contenter de créer une liste sur le site racine de la collection de site. Le code nécessaire pour cela est :

SPSite site = (SPSite)properties.Feature.Parent; site.RootWeb.Lists.Add("Automatic list", "My automatic list", SPListTemplateType.GenericList);

Nous récupérons simplement le parent de la feature, c'est à dire, l'objet SPSite et nous ajoutons une liste au site racine de cette collection. Nous allons maintenant lier ce code à la feature pour que celui-ci s'exécute à l'activation de celle-ci. Commencez par compiler votre solution pour obtenir votre fichier dll. Ouvrez ensuite Reflector et récupérez la signature de votre assembly. Enfin, ajoutez l'attribut ReceiverAssembly et ReceiverClass à votre fichier feature.xml. Au final, vous devriez obtenir quelque chose de similaire à :

<?xml version="1.0" encoding="utf-8"?> <Feature Id="94f6fe5f-3f44-4f60-89af-fdbe87fff421" Title="Automatic Feature" Description="Description for AutomaticFeature" Version="12.0.0.0" Hidden="FALSE" Scope="Site" ReceiverAssembly="FeatureStapling, Version=1.0.0.0, Culture=neutral, PublicKeyToken=58e37111f6a76adf" ReceiverClass="FeatureStapling.AutomaticFeatureReceiver" DefaultResourceFile="core" xmlns="http://schemas.microsoft.com/sharepoint/"> <ElementManifests /> </Feature>

Maintenant que notre feature est développée, nous allons développer la feature permettant d'associer celle que nous venons de créer et la définition du site d'équipe. Cliquez donc avec le bouton droit de votre souris sur votre projet et choisissez Add > New Item et sélectionnez Blank Feature. Nommez cette feature FeatureStapling et modifiez sa portée sur Farm. Effectivement, cette feature devra être activée avant que l'on crée un site, nous la plaçons donc au niveau de la ferme.



Ouvrez maintenant le fichier Elements.xml de cette feature. C'est dans ce fichier que nous allons définir l'association de la feature et de la définition de site. C'est extrêmement simple, effectivement, il suffit de taper : <?xml version="1.0" encoding="utf-8" ?> <Elements xmlns="http://schemas.microsoft.com/sharepoint/"> <FeatureSiteTemplateAssociation Id="94f6fe5f-3f44-4f60-89af-fdbe87fff421" TemplateName="STS#0" /> </Elements>

Comme vous voyez, tout cela se fait en une ligne grâce à l'élément FeatureSiteTemplateAssociation. Le premier attribut de cet élément va nous permettre de dire quelle feature nous voulons associer. Il suffit simplement de faire passer le GUID de cette feature. Le deuxième attribut permet d'indiquer la définition de site auquel nous voulons associer la feature. La manière de connaitre la valeur de l'attribut TemplateName est assez simple. Si vous vous rendez dans le dossier 12\TEMPLATE\1033\XML, il y a un fichier WEBTEMP.XML. Si vous ouvrez ce dernier, vous verrez :

<Template Name="STS" ID="1"> <Configuration ID="0" Title="Team Site" Hidden="FALSE" ImageUrl="/_layouts/images/stsprev.png" Description="A site for teams to quickly organize, author, and share information. It provides a document library, and lists for managing announcements, calendar items, tasks, and discussions." DisplayCategory="Collaboration" /> <Configuration ID="1" Title="Blank Site" Hidden="FALSE" ImageUrl="/_layouts/images/blankprev.png" Description="A blank site for you to customize based on your requirements." DisplayCategory="Collaboration" AllowGlobalFeatureAssociations="False" /> <Configuration ID="2" Title="Document Workspace" Hidden="FALSE" ImageUrl="/_layouts/images/dwsprev.png" Description="A site for colleagues to work together on a document. It provides a document library for storing the primary document and supporting files, a tasks list for assigning to-do items, and a links list for resources related to the document." DisplayCategory="Collaboration" /> </Template>

Ce code permet de faire apparaitre une définition de site dans la liste des templates disponibles à la création d'un nouveau site. Vous verrez que le template se nomme STS. Nous avons ensuite différente configuration avec un ID défini. Ici, en mettant STS#0, nous indiquons que nous nous basons sur le template STS et la configuration 0 (=> Team Site). Autrement dit, si vous aviez voulu associer votre feature à un Blank Site, vous auriez dû mettre STS#1.

Compilez et déployez maintenant votre projet. Une fois ceci fait, rendez-vous dans la centrale d'administration de SharePoint et créez un nouveau site d'équipe (Team site). Une fois celui-ci créé, affichez tout le contenu de ce site, et vous verrez apparaître une liste nommée Automatic List. Allez maintenant dans Site Settings > Site collection features :



Vous voyez que notre feature est automatiquement activée à la création du site d'équipe.

Télécharger l'exemple