Créer des compléments SharePoint dans Visual Studio

  • Article

Vous pouvez développer des compléments SharePoint à l’aide de nouveaux modèles pour les projets et éléments de projet de vsnv.

Modèles de projets

Lorsque vous utilisez un modèle de projet dans Visual Studio, il crée une solution qui contient les éléments de projet et les fichiers dont le type de projet a besoin. Les modèles de projet ci-après figurent dans la boîte de dialogue Nouveau projet si vous développez le nœud Office/SharePoint et que vous choisissez ensuite le nœud Compléments. Pour plus d’informations sur les modèles de projet sous le nœud Solutions SharePoint, reportez-vous à la rubrique Modèles de projet et d’élément de projet SharePoint.

Complément Office

Ce modèle crée une page web qui est hébergée au sein d’une application Office, telle qu’Excel ou Outlook. Un complément Office offre du contenu et des fonctionnalités supplémentaires dans un document ou élément Outlook.

Pour plus d’informations, consultez la section Vue d’ensemble de la plateforme des compléments Office.

Complément SharePoint

Ce modèle crée un Complément SharePoint selon les informations spécifiées dans un Assistant. Ces informations comprennent les données ci-après.

  • Nom du complément.
  • Site SharePoint local ou distant à utiliser pour le débogage de votre complément.
  • Le type de complément que vous souhaitez créer : hébergé par un fournisseur ou hébergé par SharePoint.

Pour plus d’informations, reportez-vous à la rubrique Compléments SharePoint.

Modèles d’éléments de projet

Après avoir créé une solution SharePoint, vous pouvez y ajouter les éléments de projet à l'aide des modèles ci-après qui figurent dans la boîte de dialogue Ajouter un nouvel élément sous le nœud Office/SharePoint.

Complément Office

Ajoute un complément Office à votre complément SharePoint. Vous pouvez ajouter un complément du volet Office, un complément de contenu ou un complément de messagerie.

Pour plus d’informations, consultez la section Vue d’ensemble de la plateforme des compléments Office.

Composant WebPart client (Web hôte)

Ajoute un composant WebPart client à votre Complément SharePoint. En ajoutant un composant WebPart client, vous pouvez afficher les compléments dans les pages d'un site hôte. Ce modèle contient un seul fichier Elements.xml, dont les propriétés définissent les éléments ci-après du composant WebPart client.

Nom de la propriété Description
ClientWebPart Spécifie le nom, le titre, la description et les dimensions du composant WebPart client.
Contenu Définit l’emplacement de la page qui s’affiche dans le composant WebPart client. Cet élément possède deux propriétés : Type et Src.
Type spécifie le type de composant WebPart que vous créez, comme HTML.
Src définit l’emplacement de la page qui est affichée dans le composant WebPart client.
Le modèle fait référence aux propriétés de la chaîne de requête en utilisant le modèle PropertyName, tel que Src="~addinWebUrl/Pages/ClientWebPart1.aspx?Property1=_property1_".

Pour plus d’informations, consultez la section Créer des composants de complément à installer avec votre complément SharePoint.

Type de contenu

Ajoute un type de contenu à votre Complément SharePoint qui est semblable aux types de contenu qui étaient utilisés dans les versions antérieures de SharePoint. Un type de contenu est un ensemble de métadonnées, de flux de travail et de comportement pour une catégorie d'éléments d'une liste ou d'une bibliothèque SharePoint. Par exemple, un élément correspond à un type de contenu de liste. D'autres types de contenu de liste comprennent les annonces, les contacts et les tâches, et ils héritent du type de contenu d'élément. Le type de contenu de contact contient des colonnes comme Prénom, Nom et Fonction.

Quand vous ajoutez un type de contenu à votre Complément SharePoint, vous spécifiez le type de contenu de base duquel hérite le nouveau type de contenu. Par exemple, il peut hériter d’une annonce, d’un contact, d’un document ou d’un type de contenu d’élément. Vous utilisez ensuite le concepteur Type de contenu pour configurer les colonnes du type de contenu et ses autres propriétés, comme son nom et sa description. Les valeurs que vous choisissez sont ajoutées aux éléments ContentType et FieldRef du fichier Elements.xml.

Pour plus d’informations, reportez-vous à la rubrique Bloc de construction : types de contenu SharePoint 2010.

Élément vide

Ajoute un élément de projet pour un élément vide à votre Complément SharePoint. Cet élément de projet ne contient qu'un seul fichier, Elements.xml, dans lequel vous définissez les propriétés de l'élément. En règle générale, vous utilisez un élément vide afin de définir un élément pour lequel Visual Studio ne fournit pas de modèle.

Liste

Ajoute deux éléments de projet à votre complément SharePoint : une définition de liste et une instance de la liste. Lorsque vous ajoutez une liste à votre complément, vous spécifiez quel nom lui attribuer et si elle doit être vide ou utiliser un type de liste existant. Vous pouvez également spécifier si la liste peut être personnalisée. Vous utilisez ensuite le concepteur de liste pour configurer les colonnes et les affichages de la liste, ainsi que d’autres propriétés comme son nom et sa description.

Pour plus d’informations sur les propriétés de liste, reportez-vous à la rubrique Élément ListTemplate (Modèle de liste) et Élément ListInstance (Instance de liste).

Ajoute un élément de projet qui étend l’interface utilisateur de son site hôte en ajoutant une action à un menu de listes. L’action personnalisée du menu contient un fichier Elements.xml, qui permet de définir les propriétés de l’action.

Pour plus d’informations, consultez la section Créer des actions personnalisées à déployer avec les compléments SharePoint.

Module

Ajoute un élément de projet de module à votre complément SharePoint. Les modules sont essentiellement des conteneurs que vous pouvez utiliser pour inclure d’autres fichiers lorsque vous déployez votre complément SharePoint. Pour ajouter un fichier, vous le copiez dans le projet sous le module dans Explorateur de solutions. Une référence au fichier est automatiquement ajoutée au fichier Elements.xml pour le module, et la référence spécifie le chemin d’accès et l’URL du nouveau fichier. Vous pouvez supprimer le fichier Sample.txt inclus dans le module, car il est inclus uniquement à des fins d’exemple.

Récepteur d’événements distant

Ajoute un élément de projet pour un récepteur d’événements distant à votre complément SharePoint et un projet d’application web à votre solution, si ce type de projet n’existe pas déjà. L’application web contient un service web associé au récepteur d’événements distant de votre complément SharePoint. Le service web contient un fichier de code Visual Basic ou Visual C# dont le code s’exécute quand une liste, un élément de liste ou un événement d’élément web se produit dans le complément SharePoint. Si une application web existe, elle est associée au complément SharePoint et le service web est ajouté à cette application.

Pour plus d’informations, consultez la section Gestion des événements dans les compléments SharePoint.

Action personnalisée du ruban

Ajoute un élément de projet qui étend l’interface utilisateur de son site hôte en ajoutant une action à un ruban. L’action personnalisée du ruban contient un fichier Elements.xml, qui définit les propriétés de l’action.

Pour plus d’informations, consultez la section Créer des actions personnalisées à déployer avec les compléments SharePoint.

Configuration de la recherche

Ajoute un élément de projet qui vous permet d'importer des paramètres de configuration de recherche personnalisés exportés à partir d'un site SharePoint.

Colonne de site

Ajoute un élément de projet pour une colonne de site à votre complément SharePoint. La colonne de site contient un fichier Elements.xml qui définit les propriétés Field de la colonne de site, notamment les données ci-après.

Nom de la propriété Description
ID Valeur de GUID unique pour la colonne de site.
Nom Nom unique utilisé pour faire référence à la colonne de site.
DisplayName Nom convivial qui apparaît dans l'interface utilisateur.
Type Type de données de la colonne de site, basée sur SPFieldType (booléen, de recherche ou texte, par exemple).
Requis Si la colonne est obligatoire, la propriété est définie sur True; dans le cas contraire, elle est définie sur False.
Groupe Cette propriété spécifie le nom du groupe auquel la colonne de site est affectée. La valeur par défaut de cette propriété est Colonnes de site personnalisées.

Pour plus d’informations, reportez-vous à la rubrique Bloc de construction : Colonnes et types de champs.

Flux de travail

Ajoute un élément de projet pour un flux de travail Microsoft Azure à votre complément SharePoint. Pour plus d’informations, consultez la section Flux de travail dans SharePoint.

Lorsque vous ajoutez ce type d’élément, vous spécifiez un nom pour le flux de travail et s’il s’agit d’un flux de travail de liste ou de site. Comme les noms l’indiquent, un flux de travail de liste fonctionne uniquement avec une liste, et un flux de travail de site, uniquement avec un site SharePoint. Lors de la création du flux de travail, vous spécifiez également s’il doit être automatiquement associé à des listes et des bibliothèques, et lesquelles. Pour chaque association ajoutée, un fichier est ajouté au projet de flux de travail. Un flux de travail contient les fichiers suivants.

Nom de fichier Description
Elements.xml Ce fichier spécifie la configuration du flux de travail et des fichiers qu'il contient (comme le fichier workflow.xaml et les fichiers d'association) et les propriétés de chaque fichier (comme son URL, son type et son chemin d'accès). Pour chaque fichier ajouté au projet de flux de travail, une section correspondante est ajoutée au fichier Elements.xml du flux de travail. Comme les fichiers d'association des flux de travail de liste nécessitent une liste, ils ont une référence au jeton de liste. Dans un flux de travail de site, un GUID est ajouté pour le site. Attention Étant donné que Visual Studio conserve les éléments du fichier Elements.xml, nous vous déconseillons de le modifier, sauf si vous êtes familiarisé avec l’impact des modifications.
Workflow.Xaml Ce fichier représente le concepteur du flux de travail. Dans ce fichier, vous ajoutez des actions au flux de travail et définissez leur code et leurs propriétés.
WorkflowStartAssociation Ce fichier démarre manuellement le flux de travail sur SharePoint. Il est ajouté au projet de flux de travail si vous activez la case à cocher Un utilisateur démarre manuellement le flux de travail dans l'Assistant de flux de travail.
ItemAddedAssociation Ce fichier démarre automatiquement le flux de travail s'il en existe un lorsqu'un utilisateur crée un élément dans le site ou la liste (selon le type de flux de travail). Ce fichier est ajouté au projet de flux de travail si la case à cocher Le flux de travail démarre automatiquement lorsqu'un élément est créé est activée dans l'Assistant de flux de travail.
ItemUpdatedAssociation Ce fichier démarre automatiquement le flux de travail s'il en existe un lorsqu'un utilisateur modifie un élément dans le site ou la liste (selon le type de flux de travail). Ce fichier est ajouté au projet de flux de travail si la case à cocher Le flux de travail démarre automatiquement lorsqu'un élément est modifié est activée dans l'Assistant de flux de travail.
WorkflowHistoryList Ce fichier représente le fichier qui est ajouté au projet du flux de travail si vous créez un historique pour le flux de travail dans l'Assistant de flux de travail.
WorkflowTaskList Ce fichier représente le fichier qui est ajouté au projet du flux de travail si vous créez une liste des tâches pour le flux de travail dans l'Assistant de flux de travail.

Activité personnalisée de flux de travail

Ajoute un élément de projet pour une activité personnalisée de flux de travail à votre complément SharePoint. En ajoutant une activité personnalisée de flux de travail, vous pouvez créer des actions de flux de travail supplémentaires en vue de les importer en tant qu’actions personnalisées dans SharePoint Designer. L’activité personnalisée de flux de travail contient un fichier Elements.xml, qui définit les propriétés de l’action, et un fichier .xaml pour le concepteur de flux de travail.

Pour plus d’informations, consultez la section Flux de travail dans SharePoint.

Voir aussi