Procédure pas à pas : création d'un champ personnalisé, d'un type de contenu, d'une définition de liste et d'une instance de liste

Article
08/10/2011

La procédure suivante montre comment créer, dans SharePoint, un champ personnalisé appelé Nom du patient, ainsi qu'un type de contenu qui utilise ce champ. Vous apprendrez également comment ajouter une définition de liste au projet (ainsi qu'une instance de liste basée sur la définition de liste) qui tire parti du nouveau type de contenu et du nouveau champ.

Cette procédure pas à pas présente les tâches suivantes :

Création et personnalisation d'un champ.
Création et personnalisation d'un type de contenu qui utilise le champ.
Création et personnalisation d'une définition de liste.
Création et personnalisation d'une instance de liste de la définition de liste.
Visualisation du nouveau champ dans le type de contenu et l'instance de liste.

Notes

Il est possible que votre ordinateur affiche des noms ou des emplacements différents pour certains des éléments d'interface utilisateur de Visual Studio dans les instructions suivantes. L'édition de Visual Studio dont vous disposez et les paramètres que vous utilisez déterminent ces éléments. Pour plus d'informations, consultez Paramètres Visual Studio.

Composants requis

Pour exécuter cette procédure pas à pas, vous devez disposer des composants suivants :

Éditions de Microsoft Windows et SharePoint prises en charge. Pour plus d'informations, consultez Configuration requise pour développer des solutions SharePoint.
Visual Studio 2010.

Création d'un élément de champ personnalisé

Commencez par créer un élément de champ personnalisé sous la forme d'un projet SharePoint dans Visual Studio et appelez-le Patient Name.

Pour créer un élément de champ personnalisé

Dans le menu Fichier, pointez sur Nouveau, puis cliquez sur Nouveau projet pour ouvrir la boîte de dialogue Nouveau projet.
Développez le nœud SharePoint sous Visual C# ou Visual Basic, puis cliquez sur 2010.
Cliquez sur Projet SharePoint vide dans le volet Modèles, remplacez le nom du projet par CustomField1, puis cliquez sur OK.

L'Assistant Personnalisation de SharePoint s'affiche. Comme aucun modèle n'a été prévu pour les éléments de champ personnalisé, nous nous baserons ici sur le modèle Projet vide.
Dans la page Spécifier le site et le niveau de sécurité pour le débogage, entrez l'URL du site de serveur SharePoint auquel vous souhaitez ajouter le nouvel élément de champ personnalisé ou utilisez l'emplacement par défaut (http://<system name>/).).
Dans la section Quel est le niveau de confiance de cette solution SharePoint ?, utilisez la valeur par défaut de Déployer en tant que solution bac à sable (sandbox).

Pour plus d'informations sur les solutions bac à sable (sandbox) et les solutions de batterie, consultez Considérations sur les solutions bac à sable (sandbox).
Cliquez sur Terminer. Le projet doit s'afficher dans l'Explorateur de solutions.
Ajoutez élément de projet Élément vide au projet. Pour ce faire, cliquez sur le nœud de projet du champ (CustomField1) dans l'Explorateur de solutions, puis cliquez sur Ajouter un nouvel élément dans le menu Projet.
Développez le nœud SharePoint sous Visual C# ou Visual Basic, puis cliquez sur 2010.
Dans le volet Modèles, sélectionnez Élément vide, conservez le nom par défaut EmptyElement1, puis cliquez sur Ajouter.
Dans le fichier Elements.xml sous EmptyElement1, insérez ce qui suit après la balise <Elements> :
```
<Field ID="{5744d18c-305e-4632-8bd1-09d134f4830d}" 
    Type="Note" 
    Name="PatientName" 
    DisplayName="Patient Name" 
    Group="A Custom Group">
</Field>
```
Vous venez d'ajouter un champ nommé Patient Name.

Important

Lorsque vous ajoutez un champ personnalisé, vous devez spécifier les attributs ID, Type, Name, DisplayName et Group pour que le champ s'affiche correctement dans SharePoint. La saisie semi-automatique des instructions indique à tort que vous avez besoin uniquement des trois premiers de ces attributs alors que tous les cinq sont requis.
Appuyez sur F5 pour exécuter le projet et le déployer sur SharePoint.

Si un message s'affiche pour vous avertir que le débogage de script est désactivé, cliquez sur Oui pour continuer le débogage.
Si c'est la première fois que vous déboguez une application Web dans Visual Studio, un message vous demande si vous souhaitez modifier le fichier de configuration Web pour activer le débogage. Répondez Oui.
En haut de la page Web SharePoint, cliquez sur le bouton Actions du site, puis cliquez sur Paramètres du site.
Sous la section Galeries de la page Paramètres du site, cliquez sur le lien Colonnes de site.
À la page Galerie des colonnes de sites, faites défiler l'écran vers le bas jusqu'à l'en-tête Colonnes personnalisées et remarquez la présence du nouvel élément de champ Patient Name.
Fermez le navigateur.

Création d'un type de contenu personnalisé

Vous allez maintenez produire un type de contenu basé sur la liste Contacts SharePoint en tirant parti du nouveau champ créé lors de la procédure précédente.

Pour créer un type de contenu personnalisé

Ajoutez un type de contenu au projet. Pour ce faire, cliquez sur le nœud de projet dans l'Explorateur de solutions, puis cliquez sur Ajoutez un nouvel élément dans le menu Projet.
Développez le nœud SharePoint sous Visual C# ou Visual Basic, puis cliquez sur 2010.
Dans le volet Modèles, sélectionnez Type de contenu et utilisez le nom par défaut, ContentType1.
Dans l'Assistant Personnalisation de SharePoint, sélectionnez le type de contenu Contact qui vous servira de modèle, puis cliquez sur Terminer.

Il suffit, à présent, d'éditer le fichier Elements.xml du type de contenu que vous venez d'ouvrir.
Dans la section <FieldRefs> du fichier Elements.xml, copiez et collez ce qui suit :
```
<FieldRef ID="{5744d18c-305e-4632-8bd1-09d134f4830d}" 
    Name="PatientName" 
    DisplayName="Patient Name" 
    Required="TRUE"/>
```
L'ID FieldRef utilisé ici fait référence à l'ID de champ défini pour le champ personnalisé.
Appuyez sur F5 pour exécuter et déployer le projet.
En haut de la page Web SharePoint, cliquez sur le bouton Actions du site, puis cliquez sur Paramètres du site.
Dans la section Galeries de la page Paramètres du site, cliquez sur le lien Types de contenu de site.
Vérifiez si la page Galerie des types de contenu de site contient bien le type de contenu récemment créé, c'est-à-dire CustomField1 - ContentType1. Cliquez dessus pour afficher les champs correspondants. Dans la liste des champs de CustomField1 - ContentType1, notez la présence du champ Patient Name.
Fermez le navigateur.

Création d'une définition de liste et d'une instance de liste

Nous allons maintenant créer une définition de liste et une instance de liste qui tireront parti du nouveau type de contenu et du nouveau champ. Étant donné que la définition de liste sera basée sur le type de contenu que nous venons de créer, nous utiliserons le modèle d'élément de projet Définition de liste du type de contenu.

Pour créer une définition de liste et une instance de liste

Ajoutez une définition de liste au projet. Pour ce faire, cliquez sur le nœud de projet dans l'Explorateur de solutions, puis cliquez sur Ajoutez un nouvel élément dans le menu Projet.
Développez le nœud SharePoint sous Visual C# ou Visual Basic, puis cliquez sur 2010.
Dans le volet Modèles, sélectionnez Définition de liste du type de contenu et utilisez le nom proposé par défaut (ListDefinition1).
Dans la zone Quel est le nom complet de la définition de liste, conservez la valeur par défaut, CustomField1 - ListDefinition1.
Dans la liste Quel type de contenu voulez-vous utiliser pour la définition de liste, utilisez la valeur par défaut (et uniquement celle-ci), CustomField1 - ContentType1.

Cela permet de créer une définition de liste personnalisable basée sur la liste Contacts modifiée.
Sélectionnez la case Ajouter une instance de liste pour cette définition de liste pour ajouter un élément de projet d'instance de liste au projet. L'instance de liste constituera une instance de la nouvelle définition de liste.
Cliquez sur Terminer. La définition de liste doit être visible dans l'Explorateur de solutions.

Personnalisation de la définition de liste

Pour finir, vous allez personnaliser la définition de liste en y ajoutant un nouveau champ (Nom du patient).

Important

La valeur de l'attribut Name dans le fichier Elements.xml de la définition de liste doit correspondre au nom du dossier de l'élément de projet de définition de liste. Dans le cas contraire, vous obtiendrez une erreur au moment de l'exécution du projet. Pour être certain que l'attribut Name correspond au nom du dossier, il convient d'utiliser le paramètre de remplacement (ou le jeton) $ProjectItemName$. Lors de l'empaquetage et du déploiement du projet SharePoint, ce jeton sera converti en nom de dossier réel de la définition de liste. Si vous utilisez une valeur autre que le jeton pour l'attribut Name, votre application risque de ne pas fonctionner correctement. Pour plus d'informations, consultez Paramètres remplaçables.

Pour ajouter un champ à la définition de liste

Dans l'Explorateur de solutions, double-cliquez sur Schema.xml sous ListDefinition1 pour l'afficher.

Schema.xml définit l'ensemble des champs et des autres éléments de la définition de liste, comme le nom et l'adresse. Vous remarquerez sous l'élément <Fields> en haut du fichier que la définition de champ suivante a été ajoutée par le type de contenu :
```
<FieldRef ID="{5744d18c-305e-4632-8bd1-09d134f4830d}" 
    Name="PatientName" 
    DisplayName="Patient Name" 
    Required="TRUE" />
```
Appuyez sur F5 pour exécuter et déployer le projet.
Dans la section Listes de la barre de lancement rapide SharePoint, cliquez sur le lien CustomField1 - ListInstance1.

Il s'agit de l'instance de liste pour la nouvelle définition de liste. Notez que le nouveau champ Patient Name n'est pas encore considéré comme une colonne dans l'instance de liste.
Cliquez sur Liste dans l'onglet de menu Outils de liste en haut de la page, puis sur le bouton Modifier l'affichage sur la barre du ruban.
Dans la liste des noms de colonnes disponibles, sélectionnez Patient Name, puis cliquez sur OK. Remarquez que le champ Nom du patient figure, à présent, dans l'instance de liste.