Procédure pas à pas : création d'un élément de projet d'action personnalisé avec un modèle d'élément, partie 1

Article
08/10/2011

Vous pouvez étendre le système de projet SharePoint dans Visual Studio 2010 en créant vos propres types d'élément de projet. Au cours de cette procédure, vous aurez l'occasion de créer un élément de projet prévu pour être inséré dans un projet SharePoint dans le but de créer une action personnalisée sur un site SharePoint. L'action personnalisée ajoute un élément de menu au menu Actions du site du site SharePoint.

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

Création d'une extension Visual Studio qui définit un nouveau type d'élément de projet SharePoint pour une action personnalisée. Le nouveau type d'élément de projet implémente plusieurs fonctionnalités personnalisées :
- Menu contextuel très pratique pour commencer à définir des tâches supplémentaires ayant trait à l'élément de projet (affichage d'un concepteur pour l'action personnalisée dans Visual Studio, par exemple).
- Code exécuté lorsqu'un développeur modifie certaines propriétés de l'élément de projet et le projet dans lequel il figure.
- Une icône personnalisée qui s'affiche en regard de l'élément de projet dans l'Explorateur de solutions.
Création d'un modèle d'élément Visual Studio pour l'élément de projet.
Génération d'un package VSIX (Visual Studio Extension) pour déployer le modèle d'élément de projet et l'assembly d'extension.
Débogage et test de l'élément de projet.

Il s'agit d'une procédure pas à pas autonome. Après avoir exécuté cette procédure pas à pas, vous pouvez améliorer l'élément de projet en ajoutant un Assistant au modèle d'élément. Pour plus d'informations, consultez Procédure pas à pas : création d'un élément de projet d'action personnalisé avec un modèle d'élément, partie 2.

Notes

Vous pouvez télécharger une instance qui contient les projets remplis, de code et d'autres fichiers pour cette procédure pas à pas de l'emplacement suivant : https://go.microsoft.com/fwlink/?LinkId=191369.

Composants requis

Vous avez besoin des composants suivants sur l'ordinateur de développement pour terminer cette procédure pas à pas :

Éditions de Microsoft Windows, SharePoint et Visual Studio prises en charge. Pour plus d'informations, consultez Configuration requise pour développer des solutions SharePoint.
Kit de développement logiciel (SDK) Visual Studio 2010. Cette procédure pas à pas utilise le modèle Projet VSIX du Kit de développement logiciel (SDK) pour créer un package VSIX afin de déployer l'élément de projet. Pour plus d'informations, consultez Extension des outils SharePoint dans Visual Studio.

Une connaissance des concepts suivants est utile, mais pas obligatoire, pour effectuer cette procédure pas à pas :

Actions personnalisées dans SharePoint. Pour plus d'informations, consultez Action personnalisée.
Modèles d'élément dans Visual Studio. Pour plus d'informations, consultez Introduction aux modèles Visual Studio.

Création du projet

Pour exécuter cette procédure pas à pas, vous devez créer trois projets :

Un projet VSIX. Ce projet crée le package VSIX permettant de déployer l'élément de projet SharePoint.
Un projet de modèle d'élément. Ce projet crée un modèle d'élément qui permet d'ajouter l'élément de projet SharePoint à un projet SharePoint.
Un projet de bibliothèque de classes. Ce projet implémente une extension Visual Studio qui définit le comportement de l'élément de projet SharePoint.

Démarrez la procédure pas à pas en créant les projets.

Pour créer le projet VSIX

Démarrez Visual Studio.
Dans le menu Fichier, pointez sur Nouveau, puis cliquez sur Projet.
Dans la zone de liste déroulante située en haut de la boîte de dialogue Nouveau projet, vérifiez que .NET Framework 4 est sélectionné.
Dans la boîte de dialogue Nouveau projet, développez les nœuds Visual C# ou Visual Basic, puis cliquez sur le nœud Extensibilité.

Notes

Le nœud Extensibilité est disponible uniquement si vous installez le Kit de développement Visual Studio 2010 SDK. Pour plus d'informations, reportez-vous à la section traitant des conditions requises ci-dessus.
Cliquez sur le modèle Projet VSIX.
Dans la zone Nom, tapez ÉlémentProjetActionPersonnalisée.
Cliquez sur OK.

Visual Studio ajoute le projet ÉlémentProjetActionPersonnalisée à l'Explorateur de solutions.

Pour créer le projet de modèle d'élément

Cliquez avec le bouton droit sur le nœud de la solution dans l'Explorateur de solutions, cliquez sur Ajouter, puis sur Nouveau projet.

Notes

Dans les projets Visual Basic, le nœud de la solution s'affiche dans l'Explorateur de solutions à condition d'avoir activé la case à cocher Toujours afficher la solution dans la Général, Projets et solutions, boîte de dialogue Options.
Dans la zone de liste déroulante située en haut de la boîte de dialogue Nouveau projet, vérifiez que .NET Framework 4 est sélectionné.
Dans la boîte de dialogue Nouveau projet, développez les nœuds Visual C# ou Visual Basic, puis cliquez sur le nœud Extensibilité.
Dans la liste des modèles de projet, sélectionnez Modèle d'élément C# ou Modèle d'élément Visual Basic.
Dans la zone Nom, tapez ItemTemplate.
Cliquez sur OK.

Visual Studio ajoute le projet ItemTemplate à la solution.

Pour créer le projet d'extension

Cliquez avec le bouton droit sur le nœud de la solution dans l'Explorateur de solutions, cliquez sur Ajouter, puis sur Nouveau projet.
Dans la zone de liste déroulante située en haut de la boîte de dialogue Nouveau projet, vérifiez que .NET Framework 4 est sélectionné.
Dans la boîte de dialogue Nouveau projet, développez le nœud Visual C# ou Visual Basic, puis cliquez sur le nœud Fenêtres.
Sélectionnez le modèle de projet Bibliothèque de classes.
Dans la zone Nom, tapez ProjectItemDefinition.
Cliquez sur OK.

Visual Studio ajoute le projet ProjectItemDefinition à la solution et ouvre le fichier de code Class1 par défaut.
Supprimez le fichier de code Class1 du projet.

Configuration du projet d'extension

Avant d'écrire le code pour définir le type d'élément de projet SharePoint, vous devez ajouter des fichiers de code et des références d'assembly au projet d'extension.

Pour configurer le projet

Dans le projet ProjectItemDefinition, ajoutez les fichiers de code portant le nom CustomAction.
Dans le menu Projet, cliquez sur Ajouter une référence.
Sous l'onglet .NET, appuyez sur CTRL et cliquez sur les assemblys suivants, puis cliquez sur OK.
- Microsoft.VisualStudio.SharePoint
- System.ComponentModel.Composition
- System.Windows.Forms

Définition du nouveau type d'élément de projet SharePoint

Créez une classe qui implémente l'interface ISharePointProjectItemTypeProvider pour définir le comportement du nouveau type d'élément de projet. Implémentez cette interface chaque fois que vous souhaitez définir un nouveau type d'élément de projet.

Pour définir le nouveau type d'élément de projet SharePoint

Dans le projet ProjectItemDefinition, ouvrez le fichier de code CustomAction.

Remplacez le code de ce fichier par le code suivant.

Imports System
Imports System.Diagnostics
Imports System.ComponentModel
Imports System.ComponentModel.Composition
Imports Microsoft.VisualStudio.SharePoint

Namespace Contoso.SharePointProjectItems.CustomAction

    ' Export attribute: Enables Visual Studio to discover and load this extension.
    ' SharePointProjectItemType attribute: Specifies the ID for this new project item type. This string must 
    '     match the value of the Type attribute of the ProjectItem element in the .spdata file for 
    '     the project item.
    ' SharePointProjectItemIcon attribute: Specifies the icon to display with this project item in Solution Explorer.
    ' CustomActionProjectItemTypeProvider class: Defines a new type of project item that can be used to create a custom 
    '     action on a SharePoint site.
    <Export(GetType(ISharePointProjectItemTypeProvider))> _
    <SharePointProjectItemType("Contoso.CustomAction")> _
    <SharePointProjectItemIcon("ProjectItemDefinition.CustomAction_SolutionExplorer.ico")> _
    Partial Friend Class CustomActionProjectItemTypeProvider
        Implements ISharePointProjectItemTypeProvider

        Private WithEvents projectItemTypeDefinition As ISharePointProjectItemTypeDefinition

        ' Configures the behavior of the project item type.
        Private Sub InitializeType(ByVal projectItemTypeDefinition As ISharePointProjectItemTypeDefinition) _
            Implements ISharePointProjectItemTypeProvider.InitializeType

            projectItemTypeDefinition.Name = "CustomAction"
            projectItemTypeDefinition.SupportedDeploymentScopes = _
                SupportedDeploymentScopes.Site Or SupportedDeploymentScopes.Web
            projectItemTypeDefinition.SupportedTrustLevels = SupportedTrustLevels.All
            Me.projectItemTypeDefinition = projectItemTypeDefinition
        End Sub

        Private Const DesignerMenuItemText As String = "View Custom Action Designer"

        Private Sub ProjectItemMenuItemsRequested(ByVal Sender As Object, _
            ByVal e As SharePointProjectItemMenuItemsRequestedEventArgs) _
            Handles projectItemTypeDefinition.ProjectItemMenuItemsRequested

            Dim viewDesignerMenuItem As IMenuItem = e.ViewMenuItems.Add(DesignerMenuItemText)
            AddHandler viewDesignerMenuItem.Click, AddressOf MenuItemClick
        End Sub

        Private Sub MenuItemClick(ByVal Sender As Object, ByVal e As MenuItemEventArgs)
            Dim projectItem As ISharePointProjectItem = CType(e.Owner, ISharePointProjectItem)
            Dim message As String = String.Format("You clicked the menu on the {0} item. " & _
                "You could perform some related task here, such as displaying a designer " & _
                "for the custom action.", projectItem.Name)
            System.Windows.Forms.MessageBox.Show(message, "Contoso Custom Action")
        End Sub

        Private Sub ProjectItemNameChanged(ByVal Sender As Object, ByVal e As NameChangedEventArgs) _
            Handles projectItemTypeDefinition.ProjectItemNameChanged
            Dim projectItem As ISharePointProjectItem = CType(Sender, ISharePointProjectItem)
            Dim message As String = String.Format("The name of the {0} item changed to: {1}", _
                e.OldName, projectItem.Name)
            projectItem.Project.ProjectService.Logger.WriteLine(message, LogCategory.Message)
        End Sub
    End Class
End Namespace

using System;
using System.Diagnostics;
using System.ComponentModel;
using System.ComponentModel.Composition;
using Microsoft.VisualStudio.SharePoint;

namespace Contoso.SharePointProjectItems.CustomAction
{
    // Enables Visual Studio to discover and load this extension.
    [Export(typeof(ISharePointProjectItemTypeProvider))]

    // Specifies the ID for this new project item type. This string must match the value of the 
    // Type attribute of the ProjectItem element in the .spdata file for the project item.
    [SharePointProjectItemType("Contoso.CustomAction")]

    // Specifies the icon to display with this project item in Solution Explorer.
    [SharePointProjectItemIcon("ProjectItemDefinition.CustomAction_SolutionExplorer.ico")]

    // Defines a new type of project item that can be used to create a custom action on a SharePoint site.
    internal partial class CustomActionProjectItemTypeProvider : ISharePointProjectItemTypeProvider
    {
        // Implements IProjectItemTypeProvider.InitializeType. Configures the behavior of the project item type.
        public void InitializeType(ISharePointProjectItemTypeDefinition projectItemTypeDefinition)
        {
            projectItemTypeDefinition.Name = "CustomAction";
            projectItemTypeDefinition.SupportedDeploymentScopes =
                SupportedDeploymentScopes.Site | SupportedDeploymentScopes.Web;
            projectItemTypeDefinition.SupportedTrustLevels = SupportedTrustLevels.All;

            projectItemTypeDefinition.ProjectItemNameChanged += ProjectItemNameChanged;
            projectItemTypeDefinition.ProjectItemMenuItemsRequested += ProjectItemMenuItemsRequested;
        }

        private const string designerMenuItemText = "View Custom Action Designer";

        private void ProjectItemMenuItemsRequested(object sender, SharePointProjectItemMenuItemsRequestedEventArgs e)
        {
            e.ViewMenuItems.Add(designerMenuItemText).Click += MenuItemClick;
        }

        private void MenuItemClick(object sender, MenuItemEventArgs e)
        {
            ISharePointProjectItem projectItem = (ISharePointProjectItem)e.Owner;
            string message = String.Format("You clicked the menu on the {0} item. " +
                "You could perform some related task here, such as displaying a designer " +
                "for the custom action.", projectItem.Name);
            System.Windows.Forms.MessageBox.Show(message, "Contoso Custom Action");
        }

        private void ProjectItemNameChanged(object sender, NameChangedEventArgs e)
        {
            ISharePointProjectItem projectItem = (ISharePointProjectItem)sender;
            string message = String.Format("The name of the {0} item changed to: {1}",
                e.OldName, projectItem.Name);
            projectItem.Project.ProjectService.Logger.WriteLine(message, LogCategory.Message);
        }
    }
}

Création d'une icône pour l'élément de projet dans l'Explorateur de solutions

Lorsque vous créez un élément de projet SharePoint personnalisé, vous pouvez associer une image (icône ou fichier bitmap) à l'élément de projet. Cette image s'affiche en regard de l'élément de projet dans l'Explorateur de solutions.

Dans la procédure suivante, vous aurez l'occasion de créer une icône pour l'élément de projet et d'incorporer l'icône dans l'assembly d'extension. Cette icône est référencée par l'attribut SharePointProjectItemIconAttribute de la classe CustomActionProjectItemTypeProvider que vous avez créée précédemment.

Pour créer une icône personnalisée pour l'élément de projet

Cliquez avec le bouton droit sur le projet ProjectItemDefinition dans l'Explorateur de solutions.
Dans le menu contextuel, pointez sur Ajouter, puis cliquez sur Nouvel élément.
Dans la liste d'éléments de projet, cliquez sur Fichier icône.

Notes

Dans les projets Visual Basic, vous devez cliquer sur le nœud Général pour afficher l'élément Fichier icône.
Tapez CustomAction_SolutionExplorer.ico en guise de nouveau nom d'icône et cliquez sur Ajouter.

La nouvelle icône s'ouvre dans l'Éditeur d'images.
Modifiez la version 16x16 du fichier icône de manière à reconnaître son design, puis enregistrez le fichier icône.
Dans l'Explorateur de solutions, cliquez sur CustomAction_SolutionExplorer.ico.
Dans la fenêtre Propriétés, cliquez sur la liste déroulante en regard de la propriété Action de génération, puis cliquez sur Ressource incorporée.

Point de contrôle

À ce stade de la procédure, l'intégralité du code de l'élément de projet fait désormais partie du projet. Générez le projet afin de garantir sa compilation sans erreur.

Pour générer votre projet

Dans le menu Générer, sélectionnez Générer la solution.

Création d'un modèle d'élément Visual Studio

Pour donner à d'autres développeurs la possibilité d'utiliser votre élément de projet, vous devez créer un modèle de projet ou un modèle d'élément. Les développeurs utilisent ces modèles dans Visual Studio pour créer une instance de votre élément de projet en élaborant un nouveau projet ou en ajoutant un élément à un projet existant. Pour cette procédure pas à pas, utilisez le projet ItemTemplate pour configurer votre élément de projet.

Pour créer le modèle d'élément

Supprimez le fichier de code Class1 du projet ItemTemplate.
Dans le projet ItemTemplate, ouvrez le fichier ItemTemplate.vstemplate.

Remplacez le contenu du fichier par le code XML ci-dessous, puis enregistrez et fermez le fichier.

Notes

Le code XML ci-dessous correspond à un modèle d'élément Visual C#. Si vous créez un modèle d'élément Visual Basic, remplacez la valeur de l'élément ProjectType par VisualBasic.

<VSTemplate Version="2.0.0" xmlns="https://schemas.microsoft.com/developer/vstemplate/2005" Type="Item">
  <TemplateData>
    <DefaultName>CustomAction</DefaultName>
    <Name>Custom Action</Name>
    <Description>SharePoint Custom Action by Contoso</Description>
    <ProjectType>CSharp</ProjectType>
    <SortOrder>1000</SortOrder>
    <Icon>ItemTemplate.ico</Icon>
    <ProvideDefaultName>true</ProvideDefaultName>
  </TemplateData>
  <TemplateContent>
    <ProjectItem ReplaceParameters="true" TargetFileName="$fileinputname$\Elements.xml">Elements.xml</ProjectItem>
    <ProjectItem ReplaceParameters="true" TargetFileName="$fileinputname$\SharePointProjectItem.spdata">CustomAction.spdata</ProjectItem>
  </TemplateContent>
</VSTemplate>

Ce fichier définit le contenu et le comportement du modèle d'élément. Pour en savoir plus sur le contenu de ce fichier, consultez Référence du schéma de modèle Visual Studio.

Dans l'Explorateur de solutions, cliquez avec le bouton droit sur le projet ItemTemplate, puis cliquez sur Ajouter et sur Nouvel élément.
Dans la boîte de dialogue Ajouter un nouvel élément, sélectionnez Fichier texte, tapez CustomAction.spdata dans le champ Nom, puis cliquez sur Ajouter.
Ajoutez le code XML suivant au fichier CustomAction.spdata, puis enregistrez et fermez le fichier.
```
<?xml version="1.0" encoding="utf-8"?>
<ProjectItem Type="Contoso.CustomAction" DefaultFile="Elements.xml" 
 xmlns="https://schemas.microsoft.com/VisualStudio/2010/SharePointTools/SharePointProjectItemModel">
  <Files>
    <ProjectItemFile Source="Elements.xml" Target="$fileinputname$\" Type="ElementManifest" />
  </Files>
</ProjectItem>
```
Ce fichier contient des informations relatives aux fichiers contenus dans l'élément de projet. La chaîne affectée à l'attribut Type de l'élément ProjectItem doit être identique à celle transmise au SharePointProjectItemTypeAttribute de la définition d'élément de projet (classe CustomActionProjectItemTypeProvider que vous avez créée précédemment dans cette procédure). Pour plus d'informations sur le contenu des fichiers .spdata, consultez Référence du schéma d'élément de projet SharePoint.
Dans l'Explorateur de solutions, cliquez avec le bouton droit sur le projet ItemTemplate, puis cliquez sur Ajouter et sur Nouvel élément.
Dans la boîte de dialogue Ajouter un nouvel élément, sélectionnez Fichier XML, tapez Elements.xml dans le champ Nom, puis cliquez sur Ajouter.
Remplacez le contenu du fichier Elements.xml par le code XML suivant, puis enregistrez et fermez le fichier.
```
<?xml version="1.0" encoding="utf-8" ?>
<Elements Id="$guid8$" xmlns="https://schemas.microsoft.com/sharepoint/">
  <CustomAction Id="Replace this with a GUID or some other unique string"
                GroupId="SiteActions"
                Location="Microsoft.SharePoint.StandardMenu"
                Sequence="1000"
                Title="Replace this with your title"
                Description="Replace this with your description" >
    <UrlAction Url="~site/Lists/Tasks/AllItems.aspx"/>
  </CustomAction>
</Elements>
```
Ce fichier définit une action personnalisée par défaut qui crée un élément de menu dans le menu Actions du site du site SharePoint. Lorsqu'un utilisateur clique sur l'élément de menu, l'URL spécifiée dans l'élément UrlAction s'ouvre dans le navigateur Web. Pour plus d'informations sur les éléments XML que vous pouvez utiliser pour définir une action personnalisée, consultez Définitions d'actions personnalisées.
Vous pouvez éventuellement ouvrir le fichier ItemTemplate.ico et le modifier de façon à ce que sa conception soit reconnaissable. Cette icône s'affichera en regard de l'élément de projet dans la boîte de dialogue Ajouter un nouvel élément.
Dans l'Explorateur de solutions, cliquez avec le bouton droit sur le projet ItemTemplate, puis cliquez sur Décharger le projet.
Cliquez de nouveau avec le bouton droit sur le projet ItemTemplate, puis cliquez sur Modifier ItemTemplate.csproj ou Modifier ItemTemplate.vbproj.
Localisez l'élément VSTemplate suivant dans le fichier projet.
```
<VSTemplate Include="ItemTemplate.vstemplate">
```
Remplacez cet élément VSTemplate par le code XML suivant :
```
<VSTemplate Include="ItemTemplate.vstemplate">
  <OutputSubPath>SharePoint\SharePoint14</OutputSubPath>
</VSTemplate>
```
L'élément OutputSubPath spécifie des dossiers supplémentaires dans le chemin d'accès où le modèle d'élément est créé lorsque vous générez le projet. Les dossiers spécifiés ici garantissent que le modèle d'élément sera disponible uniquement lorsque les clients cliquent sur le nœud 2010 sous le nœud SharePoint dans la boîte de dialogue Ajouter un nouvel élément.
Enregistrez et fermez le fichier.
Dans l'Explorateur de solutions, cliquez avec le bouton droit sur le projet ItemTemplate, puis cliquez sur Recharger le projet.

Création d'un package VSIX pour déployer l'élément de projet

Pour déployer l'extension, utilisez le projet VSIX inclus dans votre solution pour créer un package VSIX. En premier lieu, configurez le package VSIX en modifiant le fichier source.extension.vsixmanifest qui est inclus dans le projet VSIX. Ensuite, créez le package VSIX en générant la solution.

Pour configurer et créer le package VSIX

Dans l'Explorateur de solutions, double-cliquez sur le fichier source.extension.vsixmanifest dans le projet ÉlémentProjetActionPersonnalisée.

Visual Studio ouvre le fichier dans l'éditeur de manifeste. Le fichier source.extension.vsixmanifest est la base du fichier extension.vsixmanifest requis par tous les packages VSIX. Pour plus d'informations sur ce fichier, consultez VSIX Extension Schema Reference.
Dans la zone Nom du produit, tapez Élément de projet d'action personnalisée.
Dans la zone Auteur, tapez Contoso.
Dans la zone Description, tapez Élément de projet SharePoint qui représente une action personnalisée.
Dans la section Contenu de l'éditeur, cliquez sur le bouton Ajouter du contenu.
Dans la boîte de dialogue Ajouter du contenu, dans la zone de liste Sélectionner un type de contenu, sélectionnez Modèle d'élément.

Notes

Cette valeur correspond à l'élément ItemTemplate dans le fichier extension.vsixmanifest. Cet élément identifie le sous-dossier du package VSIX qui contient le modèle d'élément de projet. Pour plus d'informations, consultez ItemTemplate Element (VSX Schema).
Sous Sélectionner une source, cliquez sur la case d'option Projet et sélectionnez ItemTemplate dans la zone de liste située en regard de cette case.
Cliquez sur OK.
Dans l'éditeur de manifeste, cliquez à nouveau sur le bouton Ajouter du contenu.
Dans la boîte de dialogue Ajouter du contenu, dans la zone de liste Sélectionner un type de contenu, sélectionnez Composant MEF.

Notes

Cette valeur correspond à l'élément MefComponent dans le fichier extension.vsixmanifest. Cet élément spécifie le nom d'un assembly d'extension dans le package VSIX. Pour plus d'informations, consultez MEFComponent Element (VSX Schema).
Sous Sélectionner une source, cliquez sur la case d'option Projet et sélectionnez ProjectItemDefinition dans la zone de liste en regard de cette dernière.
Cliquez sur OK.
Dans le menu Générer, cliquez sur Générer la solution. Assurez-vous que le projet se compile sans erreurs.
Ouvrez le dossier de sortie de la génération pour le projet ÉlémentProjetActionPersonnalisée. Assurez-vous que ce dossier contient, à présent, le fichier ÉlémentProjetActionPersonnalisée.vsix.

Par défaut, le dossier de sortie de la génération est le dossier .. \bin\Debug qui figure dans le dossier contenant le projet CustomActionProjectItem.

Test de l'élément de projet

Vous êtes maintenant prêt à tester l'élément de projet. Commencez à déboguer la solution CustomActionProjectItem dans l'instance expérimentale de Visual Studio. Testez ensuite l'élément de projet Action personnalisée dans un projet SharePoint de l'instance expérimentale de Visual Studio. Enfin, générez et exécutez le projet SharePoint pour vous assurer que l'action personnalisée fonctionne comme prévu.

Pour commencer à déboguer la solution

Redémarrez Visual Studio avec les privilèges d'administrateur et ouvrez la solution ÉlémentProjetActionPersonnalisée.
Ouvrez le fichier de code CustomAction et ajoutez un point d'arrêt au niveau de la première ligne de code dans la méthode InitializeType.
Appuyez sur F5 pour démarrer le débogage.

Visual Studio installe l'extension sous %UserProfile%\AppData\Local\Microsoft\VisualStudio\10.0Exp\Extensions\Contoso\Élément de projet d'action personnalisée\1.0 et démarre une instance expérimentale de Visual Studio. Vous testerez l'élément de projet dans cette instance de Visual Studio.

Pour tester l'élément de projet dans Visual Studio

Dans l'instance expérimentale de Visual Studio, dans le menu Fichier, pointez sur Nouveau, puis cliquez sur Projet.
Développez Visual C# ou Visual Basic (selon le langage pris en charge par votre modèle d'élément), développez SharePoint, puis cliquez sur 2010.
Dans la liste des modèles de projet, cliquez sur Projet vide.
Dans la zone Nom, tapez TestActionPersonnalisée.
Cliquez sur OK.
Dans l'Assistant Personnalisation de SharePoint, saisissez l'URL du site que vous souhaitez utiliser pour le débogage, puis cliquez sur Terminer.
Dans l'Explorateur de solutions, cliquez avec le bouton droit sur le nœud de projet, pointez sur Ajouter, puis cliquez sur Nouvel élément.
Dans la boîte de dialogue Ajouter un nouvel élément, cliquez sur le nœud 2010 sous le nœud SharePoint.

Vérifiez que l'élément Action personnalisée s'affiche dans la liste des éléments de projet.
Cliquez sur Action personnalisée, puis cliquez sur Ajouter.

Visual Studio ajoute un nouvel élément nommé CustomAction1 à votre projet, puis ouvre le fichier Elements.xml dans l'éditeur.
Assurez-vous que le code dans l'autre instance de Visual Studio s'arrête au niveau du point d'arrêt que vous avez défini précédemment dans la méthode InitializeType. Appuyez sur F5 pour continuer de déboguer le projet.
Dans l'instance expérimentale de Visual Studio, dans l'Explorateur de solutions, cliquez avec le bouton droit sur le nœud CustomAction1, puis cliquez sur Afficher le Concepteur d'actions personnalisées. Assurez-vous qu'une boîte de message apparaît, puis cliquez sur OK.

Vous pouvez utiliser ce menu contextuel pour proposer des options ou des commandes supplémentaires aux développeurs (en leur permettant, par exemple, d'afficher un concepteur pour l'action personnalisée).
Dans le menu Affichage, cliquez sur Sortie.

La fenêtre Sortie s'ouvre.
Dans l'Explorateur de solutions, cliquez avec le bouton droit sur l'élément CustomAction1 et remplacez le nom par MonActionPersonnalisée.

Vous devez voir apparaître un message de confirmation dans la fenêtre Sortie. Ce message est écrit par le gestionnaire d'événements ProjectItemNameChanged que vous avez défini dans la classe CustomActionProjectItemTypeProvider. Vous pouvez gérer cet événement et d'autres événements d'élément de projet dans le but de prévoir un comportement personnalisé lorsque le développeur modifie l'élément de projet.

Pour tester l'action personnalisée dans SharePoint

Dans l'instance expérimentale de Visual Studio, ouvrez le fichier Elements.xml qui est un enfant de l'élément de projet MyCustomAction.
Apportez les modifications suivantes au fichier Elements.xml :
- Dans l'élément CustomAction, définissez l'attribut Id à un GUID ou une autre chaîne unique. Par exemple :
```
Id="cd85f6a7-af2e-44ab-885a-0c795b52121a"
```
- Dans l'élément CustomAction, définissez l'attribut Title comme suit :
```
Title="SharePoint Developer Center"
```
- Dans l'élément CustomAction, définissez l'attribut Description comme suit :
```
Description="Opens the SharePoint Developer Center Web site."
```
- Dans l'élément UrlAction, définissez l'attribut Url comme suit :
```
Url="https://msdn.microsoft.com/sharepoint/default.aspx"
```
Enregistrez le fichier Elements.xml.
Appuyez sur F5. L'action personnalisée est empaquetée et déployée sur le site SharePoint spécifié par la propriété URL de site du projet. Le navigateur Web s'ouvre à la page par défaut de ce site.

Notes

Si la boîte de dialogue Le débogage de script est désactivé est affichée, cliquez sur Oui pour continuer à déboguer le projet.
Cliquez sur le menu Actions du site. Assurez-vous que l'action personnalisée nommée Centre de développement SharePoint figure en bas de ce menu.
Cliquez sur l'élément de menu Centre de développement SharePoint. Assurez-vous que le navigateur ouvre le site Web https://msdn.microsoft.com/sharepoint/default.aspx.
Fermez le navigateur Web.

Nettoyage de l'ordinateur de développement

Une fois le test de l'élément de projet terminé, supprimez le modèle d'élément de projet de l'instance expérimentale de Visual Studio.

Pour nettoyer l'ordinateur de développement

Dans l'instance expérimentale de Visual Studio, dans le menu Outils, cliquez sur Gestionnaire d'extensions.

La boîte de dialogue Gestionnaire d'extensions s'ouvre.
Dans la liste d'extensions, cliquez sur Élément de projet d'action personnalisée, puis sur Désinstaller.
Dans la boîte de dialogue qui s'affiche, cliquez sur Oui pour confirmer que vous voulez désinstaller l'extension.
Cliquez sur Redémarrer maintenant pour terminer l'installation.
Fermez les deux instances de Visual Studio (l'instance expérimentale et l'instance de Visual Studio dans laquelle la solution ÉlémentProjetActionPersonnalisée est ouverte).

Étapes suivantes

Après avoir terminé cette procédure pas à pas, vous pouvez ajouter un Assistant au modèle d'élément. Lorsqu'un utilisateur ajoute un élément de projet Action personnalisée à un projet SharePoint, l'Assistant collecte les informations relatives à l'action personnalisée (telles que son emplacement et l'URL à atteindre lorsqu'elle fait l'objet d'un clic) et les ajoute au fichier Elements.xml dans le nouvel élément de projet. Pour plus d'informations, consultez Procédure pas à pas : création d'un élément de projet d'action personnalisé avec un modèle d'élément, partie 2.

Voir aussi

Partager via