Utiliser des modules pour inclure des fichiers dans la solution

  • Article

Il peut arriver que vous souhaitiez déployer des fichiers sur le serveur SharePoint, quel que soit leur type de fichier, comme les nouvelles pages maîtres. Pour ce faire, vous pouvez utiliser des modules (à ne pas confondre avec les modules de code Visual Basic). Les modules sont des conteneurs pour les fichiers d’une solution SharePoint. Lorsque la solution est déployée, les fichiers du module sont copiés dans les dossiers spécifiés sur le serveur SharePoint.

Éléments et éléments de module

Pour créer un module, ajoutez-le à un projet en le choisissant dans la boîte de dialogue Ajouter un nouvel élément. Ensuite, modifiez son fichier Elements.xml pour inclure les noms des fichiers que vous souhaitez déployer, où ils se trouvent sur le système et où ils doivent être copiés sur le serveur SharePoint.

Voici un exemple de fichier Elements.xml pour un module :

<?xml version="1.0" encoding="utf-8"?>
<Elements xmlns="http://schemas.microsoft.com/sharepoint/">
    <Module Name="Module1">
        <File Path="Module1\Sample.txt" Url="Module1/Sample.txt" />
    </Module>
</Elements>

Les modules nouvellement créés contiennent les fichiers par défaut suivants :

Nom de fichier Description
Elements.xml Fichier de définition du module.
Sample.txt Fichier d’espace réservé qui sert d’exemple de fichier dans le module.

Le fichier Elements.xml contient les éléments suivants :

Nom de l’élément Description
Éléments Contient tous les éléments définis dans le module.
Module L’élément de module a un attribut unique, Nom, qui spécifie le nom du module au format <Module Name="Module1">.

Notez que si vous modifiez le nom du module (ou sa propriété Nom du dossier), vous devez mettre à jour manuellement le nom dans l’élément Module.

Si vous spécifiez un sous-répertoire pour le ou les fichiers de l’élément Module, Windows SharePoint Services (WSS) crée automatiquement une structure de répertoires correspondante.
Fichier L’élément Fichier a deux paramètres, Chemin d'accès et Url.

- Chemin d’accès : nom et emplacement du fichier dans la solution SharePoint. Son format est le suivant : Path="Module1\Sample.txt".

- URL : emplacement où le fichier sera déployé sur le serveur SharePoint. Son format est le suivant : Url="Module1/Sample.txt".

- Type : attribut facultatif qui a deux paramètres : GhostableInLibrary et Ghostable. Son format est le suivant : Type="GhostableInLibrary". La spécification de GhostableInLibrary signifie que le fichier sera ajouté à une bibliothèque de documents dans SharePoint avec un élément de liste pour accompagner le fichier lorsqu’il est ajouté à la bibliothèque. La spécification de Ghostable entraîne l’ajout du fichier à SharePoint en dehors de la bibliothèque de documents.

Chaque fichier que vous souhaitez déployer nécessite une entrée d’élément <File> distincte dans Elements.xml.

Voir aussi