Comment : ajouter une propriété à une extension d'élément de projet SharePoint

Article
02/19/2013

Vous pouvez utiliser une extension d'élément de projet pour ajouter une propriété à un élément de projet SharePoint déjà installé dans Visual Studio.La propriété apparaît dans la fenêtre Propriétés dès lors que l'élément de projet est sélectionné dans l'Explorateur de solutions.

Les étapes suivantes supposent que vous avez déjà créé une extension d'élément de projet.Pour plus d'informations, consultez Comment : créer une extension d'élément de projet SharePoint.

Comment : ajouter une propriété à une extension d'élément de projet

Définissez une classe avec une propriété publique représentant la propriété que vous ajoutez à un type d'élément de projet.Pour ajouter plusieurs propriétés à un type d'élément de projet, vous pouvez définir toutes les propriétés dans la même classe ou dans des classes différentes.
Dans la méthode Initialize de votre implémentation ISharePointProjectItemTypeExtension, gérez l'événement ProjectItemPropertiesRequested du paramètre projectItemType.
Dans le gestionnaire d'événements de l'événement ProjectItemPropertiesRequested, ajoutez une instance de votre classe de propriétés à la collection PropertySources du paramètre d'arguments d'événement.

Exemple

L'exemple de code suivant montre comment ajouter une propriété nommée Example Property (Exemple de propriété) à l'élément de projet Récepteur d'événements.

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

Namespace Contoso.Examples.ProjectItemExtensionWithProperty

    <Export(GetType(ISharePointProjectItemTypeExtension))> _
    <SharePointProjectItemType("Microsoft.VisualStudio.SharePoint.EventHandler")> _
    Friend Class ExampleProjectItemExtensionWithProperty
        Implements ISharePointProjectItemTypeExtension

        Private Sub Initialize(ByVal projectItemType As ISharePointProjectItemType) _
            Implements ISharePointProjectItemTypeExtension.Initialize
            AddHandler projectItemType.ProjectItemPropertiesRequested, AddressOf ProjectItemPropertiesRequested
        End Sub

        Private Sub ProjectItemPropertiesRequested(ByVal Sender As Object,
            ByVal e As SharePointProjectItemPropertiesRequestedEventArgs)
            Dim propertyObject As CustomProperties = Nothing

            ' If the properties object already exists, get it from the project item's annotations.
            If False = e.ProjectItem.Annotations.TryGetValue(propertyObject) Then
                ' Otherwise, create a new properties object and add it to the annotations.
                propertyObject = New CustomProperties(e.ProjectItem)
                e.ProjectItem.Annotations.Add(propertyObject)
            End If
            e.PropertySources.Add(propertyObject)
        End Sub
    End Class

    Friend Class CustomProperties
        Private projectItem As ISharePointProjectItem

        Friend Sub New(ByVal projectItem As ISharePointProjectItem)
            Me.projectItem = projectItem
        End Sub

        Private Const TestPropertyId As String = "Contoso.ExampleProperty"
        Private Const PropertyDefaultValue As String = "This is an example property."

        <DisplayName("Example Property")> _
        <DescriptionAttribute("This is an example property for project items.")> _
        <DefaultValue(PropertyDefaultValue)> _
        Public Property ExampleProperty As String
            Get
                Dim propertyValue As String = Nothing

                ' Get the current property value if it already exists; otherwise, return a default value.
                If False = projectItem.ExtensionData.TryGetValue(TestPropertyId, propertyValue) Then
                    propertyValue = PropertyDefaultValue
                End If
                Return propertyValue
            End Get
            Set(ByVal value As String)
                If value <> PropertyDefaultValue Then
                    ' Store the property value in the ExtensionData property of the project item.
                    ' Data in the ExtensionData property persists when the project is closed.
                    projectItem.ExtensionData(TestPropertyId) = value
                Else
                    ' Do not save the default value.
                    projectItem.ExtensionData.Remove(TestPropertyId)
                End If
            End Set
        End Property
    End Class
End Namespace

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

namespace Contoso.Examples.ProjectItemExtensionWithProperty
{
    [Export(typeof(ISharePointProjectItemTypeExtension))]
    [SharePointProjectItemType("Microsoft.VisualStudio.SharePoint.EventHandler")]
    internal class ExampleProjectItemExtensionWithProperty : ISharePointProjectItemTypeExtension
    {
        public void Initialize(ISharePointProjectItemType projectItemType)
        {
            projectItemType.ProjectItemPropertiesRequested += 
                projectItemType_ProjectItemPropertiesRequested;
        }

        void projectItemType_ProjectItemPropertiesRequested(object sender, 
            SharePointProjectItemPropertiesRequestedEventArgs e)
        {
            CustomProperties propertyObject;

            // If the properties object already exists, get it from the project item's annotations.
            if (!e.ProjectItem.Annotations.TryGetValue(out propertyObject))
            {
                // Otherwise, create a new properties object and add it to the annotations.
                propertyObject = new CustomProperties(e.ProjectItem);
                e.ProjectItem.Annotations.Add(propertyObject);
            }

            e.PropertySources.Add(propertyObject);
        }
    }

    internal class CustomProperties
    {
        private ISharePointProjectItem projectItem;

        internal CustomProperties(ISharePointProjectItem projectItem)
        {
            this.projectItem = projectItem;
        }

        private const string PropertyId = "Contoso.ExampleProperty";
        private const string PropertyDefaultValue = "This is an example property.";

        [DisplayName("Example Property")]
        [DescriptionAttribute("This is an example property for project items.")]
        [DefaultValue(PropertyDefaultValue)]
        public string ExampleProperty
        {
            get
            {
                string propertyValue;

                // Get the current property value if it already exists; otherwise, return a default value.
                if (!projectItem.ExtensionData.TryGetValue(PropertyId, out propertyValue))
                {
                    propertyValue = PropertyDefaultValue;
                }
                return propertyValue;
            }
            set
            {
                if (value != PropertyDefaultValue)
                {
                    // Store the property value in the ExtensionData property of the project item. 
                    // Data in the ExtensionData property persists when the project is closed.
                    projectItem.ExtensionData[PropertyId] = value;
                }
                else
                {
                    // Do not save the default value.
                    projectItem.ExtensionData.Remove(PropertyId);
                }
            }
        }
    }
}

Fonctionnement du code

Pour garantir que la même instance de la classe CustomProperties est utilisée chaque fois que l'événement ProjectItemPropertiesRequested a lieu, l'exemple de code ajoute l'objet de propriétés dans la propriété Annotations de l'élément de projet la première fois que cet événement se produit.Le code extrait cet objet chaque fois que cet événement se produit à nouveau.Pour plus d'informations sur l'utilisation de la propriété Annotations afin d'associer les données aux éléments de projet, consultez Association de données personnalisées à des extensions d'outils SharePoint.

Pour rendre persistantes les modifications apportées à la valeur de propriété, l'accesseur set pour ExampleProperty enregistre la nouvelle valeur dans la propriété ExtensionData de l'objet ISharePointProjectItem auquel la propriété est associée.Pour plus d'informations sur l'utilisation de la propriété ExtensionData afin de rendre persistantes les données avec les éléments de projet, consultez Enregistrement des données dans les extensions du système de projet SharePoint.

Spécification du comportement des propriétés personnalisées

Vous pouvez définir la manière dont une propriété personnalisée apparaît et se comporte dans la fenêtre Propriétés en appliquant des attributs de l'espace de noms System.ComponentModel à la définition de la propriété.Les attributs suivants sont utiles dans de nombreux scénarios :

DisplayNameAttribute : spécifie le nom de la propriété qui s'affiche dans la fenêtre Propriétés.
DescriptionAttribute : spécifie la chaîne de description qui s'affiche en bas de la fenêtre Propriétés lorsque la propriété est sélectionnée.
DefaultValueAttribute : spécifie la valeur par défaut de la propriété.
TypeConverterAttribute : spécifie une conversion personnalisée entre la chaîne affichée dans la fenêtre Propriétés et une valeur de propriété non-chaîne.
EditorAttribute : spécifie un éditeur personnalisé à utiliser pour modifier la propriété.

Compilation du code

Ces exemples requièrent un projet de bibliothèque de classes avec des références aux assemblys suivants :

Microsoft.VisualStudio.SharePoint
System.ComponentModel.Composition

Déploiement de l'extension

Pour déployer l'extension, créez un package d'extension Visual Studio (VSIX) pour l'assembly et tous les autres fichiers que vous voulez distribuer avec l'extension.Pour plus d'informations, consultez Déploiement d'extensions pour les outils SharePoint dans Visual Studio.