Como: Adicionar uma propriedade para uma extensão de Item de projeto do SharePoint

Artigo
08/01/2011

Você pode usar uma extensão de item de projeto para adicionar uma propriedade para qualquer item de projeto do SharePoint já está instalado em Visual Studio. A propriedade aparece na Propriedades janela quando o item de projeto é selecionado na Solution Explorer.

Os seguintes passos consideram que você já tenha criado uma extensão de item de projeto. Para obter mais informações, consulte Como: Criar uma extensão de Item de projeto do SharePoint.

Para adicionar uma propriedade para uma extensão de item de projeto

Defina uma classe com uma propriedade pública que representa a propriedade que você está adicionando um tipo de item de projeto. Se você quiser adicionar várias propriedades para um tipo de item de projeto, você pode definir todas as propriedades na mesma classe ou classes diferentes.
No Initialize método de seu ISharePointProjectItemTypeExtension implementação, a alça a ProjectItemPropertiesRequested evento da projectItemType parâmetro.
No manipulador de eventos para o ProjectItemPropertiesRequested evento, adicione uma instância de sua classe de propriedades para o PropertySources a coleção do parâmetro de argumentos de evento.

Exemplo

O exemplo de código a seguir demonstra como adicionar uma propriedade denominada A propriedade de exemplo para o item de projeto do receptor de eventos.

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);
                }
            }
        }
    }
}

Noções básicas sobre o código.

Para garantir que a mesma instância da CustomProperties classe é usada toda vez que o ProjectItemPropertiesRequested evento ocorrer, o exemplo de código adiciona o objeto de propriedades para o Annotations a propriedade de tempo de item, o primeiro projeto esse evento ocorre. O código recupera esse objeto sempre que esse evento ocorrer novamente. Para obter mais informações sobre como usar o Annotations propriedade para associar dados com itens de projeto, consulte A associação de dados personalizados com extensões de ferramentas do SharePoint.

Para manter as alterações ao valor da propriedade, o set acessador para ExampleProperty salva o novo valor para o ExtensionData propriedade da ISharePointProjectItem objeto a propriedade está associada. Para obter mais informações sobre como usar o ExtensionData propriedade para persistir dados com itens de projeto, consulte Salvar dados em extensões do sistema de projeto do SharePoint.

Especificando o comportamento de propriedades personalizadas

Você pode definir como uma propriedade personalizada é exibida e o comportamento de Propriedades janela aplicando atributos da System.ComponentModel espaço para nome para a definição da propriedade. Os seguintes atributos são úteis para muitos cenários:

DisplayNameAttribute: Especifica o nome da propriedade que consta do Propriedades janela.
DescriptionAttribute: Especifica a seqüência de caracteres de descrição que aparece na parte inferior da Propriedades janela quando a propriedade for selecionada.
DefaultValueAttribute: Especifica o valor padrão da propriedade.
TypeConverterAttribute: Especifica uma conversão personalizada entre a seqüência de caracteres que é exibida na Propriedades janela e um valor de propriedade de cadeia de caracteres não.
EditorAttribute: Especifica um editor personalizado para usar para modificar a propriedade.

Compilando o código

Estes exemplos exigem um projeto de biblioteca de classe com referências aos assemblies seguintes:

Microsoft.VisualStudio.SharePoint
System.ComponentModel.Composition

Implantação da extensão

Para implantar a extensão, criar um Visual Studio pacote de extensão (VSIX) para o assembly e outros arquivos que você deseja distribuir com extensão. Para obter mais informações, consulte Implantar extensões para as ferramentas do SharePoint em Visual Studio.