Gewusst wie: Erweitern eines SharePoint-Knotens im Server-Explorer

Artikel
08/10/2011

Sie können benutzerdefinierte Knoten im Server-Explorer unter dem Knoten SharePoint-Verbindungen erweitern. Dies ist beim Hinzufügen von neuen untergeordneten Knoten, Kontextmenüelementen oder Eigenschaften zu einem vorhandenen Knoten hilfreich. Weitere Informationen erhalten Sie unter Erweitern des SharePoint-Verbindungsknotens im Server-Explorer.

So erweitern Sie einen SharePoint-Knoten im Server-Explorer

Erstellen Sie ein Klassenbibliotheksprojekt.
Fügen Sie Verweise auf die folgenden Assemblys hinzu:
- Microsoft.VisualStudio.SharePoint
- Microsoft.VisualStudio.SharePoint.Explorer.Extensions
- System.ComponentModel.Composition
Erstellen Sie eine Klasse, die die IExplorerNodeTypeExtension-Schnittstelle implementiert.
Fügen Sie der Klasse das System.ComponentModel.Composition.ExportAttribute-Attribut hinzu. Anhand dieses Attributs kann Visual Studio Ihre IExplorerNodeTypeExtension-Implementierung erkennen und laden. Übergeben Sie den IExplorerNodeTypeExtension-Typ an den Attributkonstruktor.
Fügen Sie der Klasse das ExplorerNodeTypeAttribute-Attribut hinzu. Dieses Attribut gibt den Zeichenfolgenbezeichner für den Knotentyp an, den Sie erweitern möchten.

Übergeben Sie einen der folgenden Enumerationswerte an den Attributkonstruktor, um einen integrierten, von Visual Studio bereitgestellten Knotentyp anzugeben:
- ExplorerNodeTypes: Geben Sie mithilfe dieser Werte Website-Verbindungsknoten (die Knoten, von denen Website-URLs angezeigt werden), Websiteknoten oder alle anderen übergeordneten Knoten im Server-Explorer an.
- ExtensionNodeTypes: Verwenden Sie diese Werte, um einen der integrierten Knoten anzugeben, die auf einer SharePoint-Website eine einzelne Komponente darstellen, z. B. ein Knoten, der eine Liste, ein Feld oder einen Inhaltstyp darstellt.
Verwenden Sie in der Implementierung der IExplorerNodeTypeExtension.Initialize-Methode Member des nodeType-Parameters, um dem Knoten Funktionen hinzuzufügen. Dieser Parameter ist ein IExplorerNodeType-Objekt, das Zugriff auf die in der IExplorerNodeEvents-Schnittstelle definierten Ereignisse bietet. Sie können z. B. folgende Ereignisse bearbeiten:
- IExplorerNodeEvents.NodeChildrenRequested: Bearbeiten Sie dieses Ereignis, um dem Knoten neue untergeordnete Knoten hinzuzufügen. Weitere Informationen erhalten Sie unter Gewusst wie: Hinzufügen eines benutzerdefinierten SharePoint-Knotens im Server-Explorer.
- IExplorerNodeEvents.NodeMenuItemsRequested: Bearbeiten Sie dieses Ereignis, um dem Knoten ein benutzerdefiniertes Kontextmenüelement hinzuzufügen.
- IExplorerNodeEvents.NodePropertiesRequested: Bearbeiten Sie dieses Ereignis, um dem Knoten benutzerdefinierte Eigenschaften hinzuzufügen. Die Eigenschaften erscheinen bei Auswahl des Knotens im Fenster Eigenschaften.

Beispiel

Im folgenden Codebeispiel wird die Erstellung zweier unterschiedlicher Typen von Knotenerweiterungen veranschaulicht:

Eine Erweiterung, die SharePoint-Websiteknoten ein Kontextmenüelement hinzufügt. Beim Klicken auf das Menüelement wird der Name des angeklickten Knotens angezeigt.
Eine Erweiterung, die jedem Knoten, der ein Feld mit dem Namen Text darstellt, eine benutzerdefinierte Eigenschaft mit dem Namen ContosoExampleProperty hinzufügt.

Imports System.ComponentModel
Imports System.ComponentModel.Composition
Imports System.Windows.Forms
Imports Microsoft.VisualStudio.SharePoint
Imports Microsoft.VisualStudio.SharePoint.Explorer
Imports Microsoft.VisualStudio.SharePoint.Explorer.Extensions

Namespace Contoso.ServerExplorerExtension
    <Export(GetType(IExplorerNodeTypeExtension))> _
    <ExplorerNodeType(ExplorerNodeTypes.SiteNode)> _
    Friend Class SiteNodeExtensionWithContextMenu
        Implements IExplorerNodeTypeExtension

        Private Sub Initialize(ByVal nodeType As IExplorerNodeType) _
            Implements IExplorerNodeTypeExtension.Initialize
            AddHandler nodeType.NodeMenuItemsRequested, AddressOf NodeMenuItemsRequested
        End Sub

        Private Sub NodeMenuItemsRequested(ByVal Sender As Object, ByVal e As ExplorerNodeMenuItemsRequestedEventArgs)
            Dim menuItem = e.MenuItems.Add("Display Message")
            AddHandler menuItem.Click, AddressOf MenuItemClick
        End Sub

        Private Sub MenuItemClick(ByVal Sender As Object, ByVal e As MenuItemEventArgs)
            Dim node As IExplorerNode = CType(e.Owner, IExplorerNode)
            MessageBox.Show(String.Format("Clicked the menu item for the '{0}' node.", node.Text))
        End Sub
    End Class

    <Export(GetType(IExplorerNodeTypeExtension))> _
    <ExplorerNodeType(ExtensionNodeTypes.FieldNode)> _
    Friend Class FieldNodeExtensionWithProperty
        Implements IExplorerNodeTypeExtension

        Private Sub Initialize(ByVal nodeType As IExplorerNodeType) _
            Implements IExplorerNodeTypeExtension.Initialize
            AddHandler nodeType.NodePropertiesRequested, AddressOf NodePropertiesRequested
        End Sub

        Private Sub NodePropertiesRequested(ByVal Sender As Object, ByVal e As ExplorerNodePropertiesRequestedEventArgs)
            Dim propertyObject As ExampleProperty = Nothing

            ' Only add the property to "Body" fields.
            If e.Node.Text = "Body" Then
                ' If the properties object already exists for this node, get it from the node's annotations.
                If False = e.Node.Annotations.TryGetValue(propertyObject) Then
                    ' Otherwise, create a new properties object and add it to the annotations.
                    propertyObject = New ExampleProperty(e.Node)
                    e.Node.Annotations.Add(propertyObject)
                End If
                e.PropertySources.Add(propertyObject)
            End If
        End Sub
    End Class

    Friend Class ExampleProperty

        Private node As IExplorerNode
        Private Const propertyId As String = "Contoso.CustomActionTestProperty"
        Private Const propertyDefaultValue As String = "This is a test value."

        Friend Sub New(ByVal node As IExplorerNode)
            Me.node = node
        End Sub

        ' Gets or sets a simple string property. 
        <DisplayName("ContosoExampleProperty")> _
        <DescriptionAttribute("This is an example property for field nodes.")> _
        <DefaultValue(propertyDefaultValue)> _
        Public Property TestProperty As String
            Get
                Dim propertyValue As String = Nothing

                ' Get the current property value if it already exists; otherwise, return a default value.
                If False = node.Annotations.TryGetValue(propertyId, 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 Annotations property of the node. 
                    ' Data in the Annotations property does not persist when Visual Studio exits.
                    node.Annotations(propertyId) = value
                Else
                    ' Do not save the default value.
                    node.Annotations.Values.Remove(propertyId)
                End If
            End Set
        End Property
    End Class
End Namespace

using System.ComponentModel;
using System.ComponentModel.Composition;
using System.Windows.Forms;
using Microsoft.VisualStudio.SharePoint;
using Microsoft.VisualStudio.SharePoint.Explorer;
using Microsoft.VisualStudio.SharePoint.Explorer.Extensions;

namespace Contoso.ServerExplorerExtension
{
    [Export(typeof(IExplorerNodeTypeExtension))]
    [ExplorerNodeType(ExplorerNodeTypes.SiteNode)]
    internal class SiteNodeExtensionWithContextMenu : IExplorerNodeTypeExtension
    {
        public void Initialize(IExplorerNodeType nodeType)
        {
            nodeType.NodeMenuItemsRequested += nodeType_NodeMenuItemsRequested;
        }

        void nodeType_NodeMenuItemsRequested(object sender, ExplorerNodeMenuItemsRequestedEventArgs e)
        {
            IMenuItem menuItem = e.MenuItems.Add("Display Message");
            menuItem.Click += menuItem_Click;
        }

        void menuItem_Click(object sender, MenuItemEventArgs e)
        {
            IExplorerNode node = (IExplorerNode)e.Owner;
            MessageBox.Show(string.Format("Clicked the menu item for the '{0}' node.", node.Text));
        }
    }

    [Export(typeof(IExplorerNodeTypeExtension))]
    [ExplorerNodeType(ExtensionNodeTypes.FieldNode)]
    internal class FieldNodeExtensionWithProperty : IExplorerNodeTypeExtension
    {
        public void Initialize(IExplorerNodeType nodeType)
        {
            nodeType.NodePropertiesRequested += nodeType_NodePropertiesRequested;
        }

        void nodeType_NodePropertiesRequested(object sender, ExplorerNodePropertiesRequestedEventArgs e)
        {
            // Only add the property to "Body" fields.
            if (e.Node.Text == "Body")
            {
                ExampleProperty propertyObject;

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

                e.PropertySources.Add(propertyObject);
            }
        }
    }

    internal class ExampleProperty
    {
        private IExplorerNode node;
        private const string propertyId = "Contoso.ExampleProperty";
        private const string propertyDefaultValue = "This is an example property.";

        internal ExampleProperty(IExplorerNode node)
        {
            this.node = node;
        }

        // Gets or sets a simple string property. 
        [DisplayName("ContosoExampleProperty")]
        [DescriptionAttribute("This is an example property for field nodes.")]
        [DefaultValue(propertyDefaultValue)]
        public string TestProperty
        {
            get
            {
                string propertyValue;

                // Get the current property value if it already exists; otherwise, return a default value.
                if (!node.Annotations.TryGetValue(propertyId, out propertyValue))
                {
                    propertyValue = propertyDefaultValue;
                }
                return propertyValue;
            }
            set
            {
                if (value != propertyDefaultValue)
                {
                    // Store the property value in the Annotations property of the node. 
                    // Data in the Annotations property does not persist when Visual Studio exits.
                    node.Annotations[propertyId] = value;
                }
                else
                {
                    // Do not save the default value.
                    node.Annotations.Remove(propertyId);
                }
            }
        }
    }

}

Diese Erweiterung fügt Knoten eine bearbeitbare Zeichenfolgeneigenschaft hinzu. Sie können auch benutzerdefinierte Eigenschaften erstellen, die schreibgeschützte Daten auf dem SharePoint-Server anzeigen. Ein Beispiel, das die Vorgehensweise veranschaulicht, finden Sie unter Exemplarische Vorgehensweise: Erweitern des Server-Explorers für die Anzeige von Webparts.

Kompilieren des Codes

Für dieses Beispiel sind Verweise auf die folgenden Assemblys erforderlich:

Microsoft.VisualStudio.SharePoint
Microsoft.VisualStudio.SharePoint.Explorer.Extensions
System.ComponentModel.Composition
System.Windows.Forms

Bereitstellen der Erweiterung

Um die Server-Explorer-Erweiterung bereitzustellen, erstellen Sie ein Visual Studio-Erweiterungspaket (VSIX) für die Assembly und alle weiteren Dateien, die Sie mit der Erweiterung verteilen möchten. Weitere Informationen finden Sie unter Bereitstellen von Erweiterungen für die SharePoint-Tools in Visual Studio.