共用方式為

逐步解說：擴充伺服器總管以顯示 Web 組件

  • 發行項

在 Visual Studio 2010 中，您可以使用 [伺服器總管] 的 [SharePoint 連接] 節點檢視 SharePoint 網站上的元件。 不過，其中有些不是 [伺服器總管] 預設顯示的元件。 在本逐步解說中，您將擴充 [伺服器總管]，以顯示每個連接的 SharePoint 網站上的 Web 組件庫。

本逐步解說將示範下列工作：

  • 建立 Visual Studio 擴充功能，該擴充功能會透過下列方式擴充 [伺服器總管]：

    • 在 [伺服器總管] 中的每個 SharePoint 網站節點下方加入新的 [Web 組件庫] 節點。 這個新節點包含的子節點代表網站上 Web 組件庫中的每一個 Web 組件。

    • 定義代表 Web 組件執行個體的新節點類型。 這個新節點類型是新的 [Web 組件庫] 節點底下子節點的基礎。 新的 Web 組件節點類型會在 [屬性] 視窗中，顯示所代表 Web 組件的相關資訊。 此外，此節點類型還會包括自訂捷徑功能表項目，可用來做為執行其他 Web 組件相關工作的起點。

  • 建立兩個由擴充組件呼叫的自訂「SharePoint 命令」(SharePoint Command)。 SharePoint 命令是擴充組件所呼叫，以在 SharePoint 伺服器物件模型中使用 API 的方法。 在本逐步解說中，您將會建立命令，在開發電腦上擷取本機 SharePoint 網站中的 Web 組件資訊。 如需詳細資訊，請參閱呼叫 SharePoint 物件模型。

  • 建置 Visual Studio Extension (VSIX) Package 以部署擴充功能。

  • 偵錯和測試擴充功能。

注意事項注意事項

本逐步解說還有另一個版本，這個版本會使用 SharePoint 用戶端物件模型 (而非伺服器物件模型)，請參閱逐步解說：在伺服器總管擴充功能中呼叫 SharePoint 用戶端物件模型。

必要條件

開發電腦上需要下列元件才能完成此逐步解說：

了解下列概念有助於完成此逐步解說 (但非必要)：

建立專案

若要完成這個逐步解說，您必須建立三個專案：

  • VSIX 專案，用於建立 VSIX 套件以部署擴充功能。

  • 類別庫專案，可實作擴充功能。 這個專案必須以 .NET Framework 4 為目標。

  • 類別庫專案，可定義自訂 SharePoint 命令。 這個專案必須以 .NET Framework 3.5 為目標。

從建立這些專案開始進行此逐步解說。

若要建立 VSIX 專案

  1. 啟動 Visual Studio。

  2. 在 [檔案] 功能表上，指向 [新增]，然後按一下 [專案]。

  3. 在 [新增專案] 對話方塊中，展開 [Visual C#] 或 [Visual Basic] 節點，然後選取 [擴充性] 節點。

    注意事項注意事項

    [擴充性] 節點只有在安裝 Visual Studio 2010 SDK 時才可使用。 如需詳細資訊，請參閱上方的＜必要條件＞一節。

  4. 在對話方塊上方的下拉式方塊中，選取 [.NET Framework 4]。

  5. 選取 [VSIX 專案] 範本。

  6. 在 [名稱] 方塊中，輸入 WebPartNode。

  7. 按一下 [確定]。

    Visual Studio 會將 [WebPartNode] 專案加入至 [方案總管]。

若要建立擴充功能專案

  1. 在 [方案總管] 中，以滑鼠右鍵按一下方案節點，按一下 [加入]，再按一下 [新增專案]。

    注意事項注意事項

    在 Visual Basic 專案中，方案節點只有在已選取選項對話方塊、專案和方案、一般中的 [永遠顯示方案] 核取方塊時，才會出現在 [方案總管] 中。

  2. 在 [新專案] 對話方塊中展開 [Visual C#] 或 [Visual Basic] 節點，然後按一下 [Windows]。

  3. 在對話方塊上方的下拉式方塊中，選取 [.NET Framework 4]。

  4. 選取 [類別庫] 專案範本。

  5. 在 [名稱] 方塊中，輸入 WebPartNodeExtension。

  6. 按一下 [確定]。

    Visual Studio 會將 [WebPartNodeExtension] 專案加入至方案，然後開啟預設的 Class1 程式碼檔。

  7. 從專案刪除 Class1 程式碼檔。

若要建立 SharePoint 命令專案

  1. 在 [方案總管] 中，以滑鼠右鍵按一下方案節點，按一下 [加入]，再按一下 [新增專案]。

    注意事項注意事項

    在 Visual Basic 專案中，方案節點只有在已選取選項對話方塊、專案和方案、一般中的 [永遠顯示方案] 核取方塊時，才會出現在 [方案總管] 中。

  2. 在 [新專案] 對話方塊中展開 [Visual C#] 或 [Visual Basic] 節點，然後按一下 [Windows]。

  3. 在對話方塊上方的下拉式方塊中，選取 [.NET Framework 3.5]。

  4. 選取 [類別庫] 專案範本。

  5. 在 [名稱] 方塊中，輸入 WebPartCommands。

  6. 按一下 [確定]。

    Visual Studio 會將 [WebPartCommands] 專案加入至方案，然後開啟預設的 Class1 程式碼檔。

  7. 從專案刪除 Class1 程式碼檔。

設定專案

在您撰寫程式碼建立擴充功能之前，必須先加入程式碼檔和組件參考，並且設定專案設定。

若要設定 WebPartNodeExtension 專案

  1. 在 WebPartNodeExtension 專案中加入名稱如下的四個程式碼檔：

    • SiteNodeExtension

    • WebPartNodeTypeProvider

    • WebPartNodeInfo

    • WebPartCommandIds

  2. 在 [專案] 功能表上，按一下 [加入參考]。

  3. 在 [.NET] 索引標籤上，按 CTRL，然後選取下列組件，再按一下 [確定]：

    • Microsoft.VisualStudio.SharePoint

    • System.ComponentModel.Composition

    • System.Windows.Forms

  4. 在 [方案總管] 中，以滑鼠右鍵按一下 [WebPartNodeExtension] 專案節點，然後選取 [屬性]。

    [專案設計工具] 隨即開啟。

  5. 按一下 [應用程式] 索引標籤。

  6. 在 [預設命名空間] 方塊 (C#) 或 [根命名空間] 方塊 (Visual Basic) 中，輸入 ServerExplorer.SharePointConnections.WebPartNode。

若要設定 WebPartCommands 專案

  1. 在 [WebPartCommands] 專案中，加入名為 WebPartCommands 的程式碼檔。

  2. 在 [方案總管] 中，選取 [WebPartCommands] 專案節點。

  3. 在 [專案] 功能表中選取 [加入現有項目]。

  4. 在 [加入現有項目] 對話方塊中，瀏覽至包含 WebPartNodeExtension 專案程式碼檔的資料夾。

  5. 選取 [WebPartNodeInfo] 和 [WebPartCommandIds] 程式碼檔。

  6. 按一下 [加入] 按鈕的下拉式功能表，然後選取 [加入做為連結]。

    Visual Studio 會將程式碼檔加入至 WebPartCommands 專案做為連結。 這表示，程式碼檔位於 WebPartNode 專案中，但是檔案中的程式碼也會在 WebPartNodeExtension 專案中編譯。

  7. 在 [專案] 功能表上，按一下 [加入參考]。

  8. 在 [.NET] 索引標籤上，按 CTRL，然後選取下列組件，再按一下 [確定]：

    • Microsoft.SharePoint

    • Microsoft.VisualStudio.SharePoint.Commands

  9. 在 [方案總管] 中，以滑鼠右鍵按一下 [WebPartCommands] 專案節點，然後選取 [屬性]。

    [專案設計工具] 隨即開啟。

  10. 按一下 [應用程式] 索引標籤。

  11. 在 [預設命名空間] 方塊 (C#) 或 [根命名空間] 方塊 (Visual Basic) 中，輸入 ServerExplorer.SharePointConnections.WebPartNode。

建立新節點的圖示

為 [伺服器總管] 擴充功能建立兩個圖示：一個圖示用於新的 [Web 組件庫] 節點，另一個圖示用於 [Web 組件庫] 節點底下的每個 Web 組件子節點。 稍後在本逐步解說中，您將寫入讓這些圖示與節點產生關聯的程式碼。

若要建立節點的圖示

  1. 在 [方案總管] 中，以滑鼠右鍵按一下 [WebPartNodeExtension] 專案節點，然後選取 [屬性]。

  2. 在 [專案] 功能表上，選取 [WebPartNodeExtension 屬性]。

    [專案設計工具] 隨即開啟。

  3. 按一下 [資源] 索引標籤。

  4. 按一下 [這個檔案未包含預設的資源檔。請按這裡建立資源檔。]

    Visual Studio 會建立資源檔並在設計工具中將它開啟。

  5. 在設計工具頂端，按一下 [加入] 按鈕上的下拉箭號，然後按一下 [加入新圖示]。

  6. 輸入 WebPartsNode 做為新圖示的名稱，然後按一下 [加入]。

    新圖示隨即開啟於 [影像編輯器] 中。

  7. 編輯 16x16 版的圖示，以便能夠輕鬆辨識其設計。

  8. 選取 32x32 版的圖示。

  9. 選取 [影像] 功能表上的 [刪除影像類型]。

  10. 重複步驟 5 到 9，將另一個圖示加入至專案資源。 將此圖示命名為 WebPart。

  11. 在 [方案總管] 中 [WebPartNodeExtension] 專案的 [資源] 資料夾底下，選取 WebPartsNode.ico。

  12. 在 [屬性] 視窗中，按一下 [建置動作] 旁的下拉式清單，然後選取 [內嵌資源]。

  13. 針對 WebPart.ico 重複最後兩個步驟。

將 Web 組件庫節點加入至伺服器總管

建立一個將新的 [Web 組件庫] 節點加入至每個 SharePoint 網站節點的類別。 為了加入新節點，此類別會實作 IExplorerNodeTypeExtension 介面。 在您要擴充 [伺服器總管] 中現有節點的行為時實作此介面，例如將新的子節點加入至節點。

若要將 Web 組件庫節點加入至伺服器總管

  1. 在 WebPartNodeExtension 專案中，按兩下 SiteNodeExtension 程式碼檔。

  2. 將下列程式碼貼到這個檔案。

    注意事項注意事項

    加入這段程式碼後，專案會出現一些編譯錯誤。 在後續步驟中加入程式碼時，這些錯誤將不存在。

    		 
    Imports System.Collections.Generic
Imports System.ComponentModel.Composition
Imports Microsoft.VisualStudio.SharePoint.Explorer

Namespace ServerExplorer.SharePointConnections.WebPartNode

    ' Export attribute: Enables Visual Studio to discover and load this extension.
    ' ExplorerNodeType attribute:  Indicates that this class extends SharePoint site nodes in Server Explorer.
    ' WebPartNodeTypeProvider class: Represents an extension of SharePoint site nodes in Server Explorer.
    <Export(GetType(IExplorerNodeTypeExtension))> _
    <ExplorerNodeType(ExplorerNodeTypes.SiteNode)> _
    Friend Class SiteNodeExtension
        Implements IExplorerNodeTypeExtension

        Private Sub Initialize(ByVal nodeType As IExplorerNodeType) _
            Implements IExplorerNodeTypeExtension.Initialize

            ' The NodeChildrenRequested event is raised when the user expands the
            ' SharePoint site node in Server Explorer.
            AddHandler nodeType.NodeChildrenRequested, AddressOf NodeChildrenRequested
        End Sub

        ' Creates the new Web Part Gallery node with the specified icon.
        Private Sub NodeChildrenRequested(ByVal Sender As Object, ByVal e As ExplorerNodeEventArgs)

            ' The CreateWebPartNodes argument is a delegate that Visual Studio calls 
            ' to create the child nodes under the Web Part Gallery node.
            e.Node.ChildNodes.AddFolder("Web Part Gallery", My.Resources.WebPartsNode.ToBitmap(), _
                AddressOf CreateWebPartNodes)
        End Sub

        ' Creates all of the individual Web Part nodes under the new Web Part Gallery node.
        Private Sub CreateWebPartNodes(ByVal parentNode As IExplorerNode)

            ' Call the custom SharePoint command to get items from the Web Part gallery.
            Dim webParts = parentNode.Context.SharePointConnection.ExecuteCommand(Of WebPartNodeInfo())( _
                WebPartCommandIds.GetWebParts)
            If webParts IsNot Nothing Then
                For Each webPart As WebPartNodeInfo In webParts

                    ' Create a new annotation object to store the current Web Part item with the new node.
                    Dim annotations = New Dictionary(Of Object, Object)()
                    annotations.Add(GetType(WebPartNodeInfo), webPart)

                    ' Create the new node for the current Web Part item.
                    parentNode.ChildNodes.Add(WebPartNodeTypeProvider.WebPartNodeTypeId, _
                        webPart.Name, annotations)
                Next
            End If
        End Sub

    End Class
End Namespace

    using System.Collections.Generic;
using System.ComponentModel.Composition;
using Microsoft.VisualStudio.SharePoint.Explorer;

namespace ServerExplorer.SharePointConnections.WebPartNode
{
    // Enables Visual Studio to discover and load this extension.
    [Export(typeof(IExplorerNodeTypeExtension))]        

    // Indicates that this class extends SharePoint site nodes in Server Explorer.
    [ExplorerNodeType(ExplorerNodeTypes.SiteNode)]

    // Represents an extension of SharePoint site nodes in Server Explorer.
    internal class SiteNodeExtension : IExplorerNodeTypeExtension
    {
        public void Initialize(IExplorerNodeType nodeType)
        {
            // The NodeChildrenRequested event is raised when the user expands the
            // SharePoint site node in Server Explorer.
            nodeType.NodeChildrenRequested += NodeChildrenRequested;
        }

        // Creates the new Web Part Gallery node with the specified icon.
        private void NodeChildrenRequested(object sender, ExplorerNodeEventArgs e)
        {
            // The CreateWebPartNodes argument is a delegate that Visual Studio calls 
            // to create the child nodes under the Web Part Gallery node.
            e.Node.ChildNodes.AddFolder("Web Part Gallery",
                Properties.Resources.WebPartsNode.ToBitmap(), CreateWebPartNodes);
        }

        // Creates all of the individual Web Part nodes under the new Web Part Gallery node.
        private void CreateWebPartNodes(IExplorerNode parentNode)
        {
            // Call the custom SharePoint command to get items from the Web Part gallery.
            var webParts = parentNode.Context.SharePointConnection.ExecuteCommand<WebPartNodeInfo[]>(
                WebPartCommandIds.GetWebParts);

            if (webParts != null)
            {
                foreach (WebPartNodeInfo webPart in webParts)
                {
                    // Create a new annotation object to store the current Web Part item with the new node.
                    var annotations = new Dictionary<object, object>() 
                    { 
                        { typeof(WebPartNodeInfo), webPart } 
                    };

                    // Create the new node for the current Web Part item.
                    parentNode.ChildNodes.Add(WebPartNodeTypeProvider.WebPartNodeTypeId,
                        webPart.Name, annotations);
                }
            }
        }
    }
}

定義代表 Web 組件的節點類型

建立類別，該類別會定義代表 Web 組件的新節點類型。 Visual Studio 會使用這個新節點類型顯示 [Web 組件庫] 節點底下的子節點。 這些子節點每一個都代表 SharePoint 網站上的單一 Web 組件。

為了定義新的節點類型，此類別會實作 IExplorerNodeTypeProvider 介面。 在您要於 [伺服器總管] 中定義新的節點類型時實作此介面。

若要定義 Web 組件節點類型

  1. 在 WebPartNodeExtension 專案中，按兩下 WebPartNodeTypeProvder 程式碼檔。

  2. 將下列程式碼貼到這個檔案。

    Imports System
Imports System.Collections.Generic
Imports System.Windows.Forms
Imports System.ComponentModel.Composition
Imports Microsoft.VisualStudio.SharePoint
Imports Microsoft.VisualStudio.SharePoint.Explorer

Namespace ServerExplorer.SharePointConnections.WebPartNode

    ' Export attribute: Enables Visual Studio to discover and load this extension.
    ' ExplorerNodeType attribute: Specifies the ID for this new node type.
    ' WebPartNodeTypeProvider class: Defines a new node type that represents a Web Part on a SharePoint site.
    <Export(GetType(IExplorerNodeTypeProvider))> _
    <ExplorerNodeType(WebPartNodeTypeProvider.WebPartNodeTypeId)> _
    Friend Class WebPartNodeTypeProvider
        Implements IExplorerNodeTypeProvider

        Friend Const WebPartNodeTypeId As String = "Contoso.WebPart"

        Private Sub InitializeType(ByVal typeDefinition As IExplorerNodeTypeDefinition) _
            Implements IExplorerNodeTypeProvider.InitializeType

            typeDefinition.DefaultIcon = My.Resources.WebPart.ToBitmap()
            typeDefinition.IsAlwaysLeaf = True
            AddHandler typeDefinition.NodePropertiesRequested, AddressOf NodePropertiesRequested
        End Sub

        ' Retrieves properties that are displayed in the Properties window when
        ' a Web Part node is selected.
        Private Sub NodePropertiesRequested(ByVal Sernder As Object, _
            ByVal e As ExplorerNodePropertiesRequestedEventArgs)

            Dim nodeInfo = e.Node.Annotations.GetValue(Of WebPartNodeInfo)()

            ' Call the custom SharePoint command to get the Web Part properties.
            Dim properties As Dictionary(Of String, String) = _
                e.Node.Context.SharePointConnection.ExecuteCommand( _
                Of WebPartNodeInfo, Dictionary(Of String, String))(
                WebPartCommandIds.GetWebPartProperties, nodeInfo)
            Dim propertySource As Object = e.Node.Context.CreatePropertySourceObject(properties)
            e.PropertySources.Add(propertySource)
        End Sub

    End Class
End Namespace

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

namespace ServerExplorer.SharePointConnections.WebPartNode
{
    // Enables Visual Studio to discover and load this extension.
    [Export(typeof(IExplorerNodeTypeProvider))]

    // Specifies the ID for this new node type.
    [ExplorerNodeType(WebPartNodeTypeProvider.WebPartNodeTypeId)]

    // Defines a new node type that represents a Web Part on a SharePoint site.
    internal class WebPartNodeTypeProvider : IExplorerNodeTypeProvider
    {
        internal const string WebPartNodeTypeId = "Contoso.WebPart";

        public void InitializeType(IExplorerNodeTypeDefinition typeDefinition)
        {
            typeDefinition.DefaultIcon = Properties.Resources.WebPart.ToBitmap();
            typeDefinition.IsAlwaysLeaf = true;
            typeDefinition.NodePropertiesRequested += NodePropertiesRequested;
        }

        // Retrieves properties that are displayed in the Properties window when
        // a Web Part node is selected.
        private void NodePropertiesRequested(object sender,
            ExplorerNodePropertiesRequestedEventArgs e)
        {
            var webPartNodeInfo = e.Node.Annotations.GetValue<WebPartNodeInfo>();

            // Call the custom SharePoint command to get the Web Part properties.
            Dictionary<string, string> properties =
                e.Node.Context.SharePointConnection.ExecuteCommand<
                WebPartNodeInfo, Dictionary<string, string>>(
                WebPartCommandIds.GetWebPartProperties, webPartNodeInfo);

            object propertySource = e.Node.Context.CreatePropertySourceObject(properties);
            e.PropertySources.Add(propertySource);
        }
    }
}

定義 Web 組件資料類別

定義包含 SharePoint 網站上單一 Web 組件相關資料的類別。 稍後您將在本逐步解說中建立自訂 SharePoint 命令，以擷取網站上每個 Web 組件的資料，然後將資料指派至此類別的執行個體。

若要定義 Web 組件資料類別

  1. 在 WebPartNodeExtension 專案中，按兩下 WebPartNodeInfo 程式碼檔。

  2. 將下列程式碼貼到這個檔案。

    Imports System

Namespace ServerExplorer.SharePointConnections.WebPartNode

    ' Contains basic data about a single Web Part on the SharePoint site. This class is 
    ' serializable so that instances of it can be sent between the WebPartNode and 
    ' WebPartCommands assemblies.
    <Serializable()> _
    Public Class WebPartNodeInfo

        Private siteIdValue As Guid
        Public Property SiteId As Guid
            Get
                Return siteIdValue
            End Get
            Set(ByVal value As Guid)
                siteIdValue = value
            End Set
        End Property

        Private idValue As Integer
        Public Property Id As Integer
            Get
                Return idValue
            End Get
            Set(ByVal value As Integer)
                idValue = value
            End Set
        End Property

        Private uniqueIdValue As Guid
        Public Property UniqueId As Guid
            Get
                Return uniqueIdValue
            End Get
            Set(ByVal value As Guid)
                uniqueIdValue = value
            End Set
        End Property

        Private nameValue As String
        Public Property Name As String
            Get
                Return nameValue
            End Get
            Set(ByVal value As String)
                nameValue = value
            End Set
        End Property

        Private imageUrlValue As String
        Public Property ImageUrl As String
            Get
                Return imageUrlValue
            End Get
            Set(ByVal value As String)
                imageUrlValue = value
            End Set
        End Property

    End Class
End Namespace

    using System;

namespace ServerExplorer.SharePointConnections.WebPartNode
{
    // Contains basic data about a single Web Part on the SharePoint site. This class is 
    // serializable so that instances of it can be sent between the WebPartNode and 
    // WebPartCommands assemblies.
    [Serializable]
    public class WebPartNodeInfo
    {
        public Guid SiteId { get; set; }
        public int Id { get; set; }
        public Guid UniqueId { get; set; }
        public string Name { get; set; }
        public string ImageUrl { get; set; }
    }
}

定義 SharePoint 命令的識別碼

定義數個指定自訂 SharePoint 命令的字串。 稍後您將在本逐步解說中實作這些命令。

若要定義命令識別碼

  1. 在 WebPartNodeExtension 專案中，按兩下 WebPartCommandIds 程式碼檔。

  2. 將下列程式碼貼到這個檔案。

    Namespace ServerExplorer.SharePointConnections.WebPartNode

    Public Class WebPartCommandIds
        Public Const GetWebParts As String = "WebPart.GetWebParts"
        Public Const GetWebPartProperties As String = "WebPart.GetProperties"
    End Class

End Namespace

    namespace ServerExplorer.SharePointConnections.WebPartNode
{
    public static class WebPartCommandIds
    {
        public const string GetWebParts = "WebPart.GetWebParts";
        public const string GetWebPartProperties = "WebPart.GetProperties";
    }
}

建立自訂 SharePoint 命令

建立呼叫 SharePoint 伺服器物件模型的自訂命令，以擷取 SharePoint 網站上 Web 組件的相關資料。 每個命令都是已套用 SharePointCommandAttribute 的方法。

若要定義 SharePoint 命令

  1. 在 [WebPartCommands] 專案中，按兩下 WebPartCommands 程式碼檔。

  2. 將下列程式碼貼到這個檔案。

    Imports System.Collections.Generic
Imports Microsoft.SharePoint
Imports Microsoft.VisualStudio.SharePoint.Commands

Namespace ServerExplorer.SharePointConnections.WebPartNode

    Friend Class WebPartsCommands

        ' Gets data for each Web Part on the SharePoint site, and returns an array of 
        ' serializable objects that contain the data.
        <SharePointCommand(WebPartCommandIds.GetWebParts)> _
        Private Shared Function GetWebParts(ByVal context As ISharePointCommandContext) As WebPartNodeInfo()

            Dim nodeInfos = New List(Of WebPartNodeInfo)()
            Dim webParts As SPListItemCollection = context.Site.GetCatalog( _
                SPListTemplateType.WebPartCatalog).Items

            For Each webPart As SPListItem In webParts
                Dim nodeInfo As WebPartNodeInfo = New WebPartNodeInfo()
                With nodeInfo
                    .Id = webPart.ID
                    .SiteId = webPart.ParentList.ParentWeb.ID
                    .Name = webPart.Title
                    .UniqueId = webPart.UniqueId
                    .ImageUrl = webPart.ParentList.ImageUrl
                End With
                nodeInfos.Add(nodeInfo)
            Next
            Return nodeInfos.ToArray()
        End Function

        ' Gets additional property data for a specific Web Part.
        <SharePointCommand(WebPartCommandIds.GetWebPartProperties)> _
        Private Shared Function GetWebPartProperties(ByVal context As ISharePointCommandContext, _
            ByVal webPartNodeInfo As WebPartNodeInfo) As Dictionary(Of String, String)

            Dim webParts As SPList = context.Site.GetCatalog(SPListTemplateType.WebPartCatalog)
            Dim webPart As SPListItem = webParts.Items(webPartNodeInfo.UniqueId)
            Return SharePointCommandServices.GetProperties(webPart)
        End Function
    End Class
End Namespace

    using System.Collections.Generic;
using Microsoft.SharePoint;
using Microsoft.VisualStudio.SharePoint.Commands;

namespace ServerExplorer.SharePointConnections.WebPartNode
{
    internal class WebPartsCommands
    {
        // Gets data for each Web Part on the SharePoint site, and returns an array of 
        // serializable objects that contain the data.
        [SharePointCommand(WebPartCommandIds.GetWebParts)]
        private static WebPartNodeInfo[] GetWebParts(ISharePointCommandContext context)
        {
            var nodeInfos = new List<WebPartNodeInfo>();
            SPListItemCollection webParts = context.Site.GetCatalog(
                SPListTemplateType.WebPartCatalog).Items;

            foreach (SPListItem webPart in webParts)
            {
                WebPartNodeInfo nodeInfo = new WebPartNodeInfo
                {
                    Id = webPart.ID,
                    SiteId = webPart.ParentList.ParentWeb.ID,
                    Name = webPart.Title,
                    UniqueId = webPart.UniqueId,
                    ImageUrl = webPart.ParentList.ImageUrl
                };
                nodeInfos.Add(nodeInfo);
            }

            return nodeInfos.ToArray();
        }

        // Gets additional property data for a specific Web Part.
        [SharePointCommand(WebPartCommandIds.GetWebPartProperties)]
        private static Dictionary<string, string> GetWebPartProperties(ISharePointCommandContext context, 
            WebPartNodeInfo nodeInfo)
        {
            SPList webParts = context.Site.GetCatalog(SPListTemplateType.WebPartCatalog);
            SPListItem webPart = webParts.Items[nodeInfo.UniqueId];

            return SharePointCommandServices.GetProperties(webPart);
        }
    }
}

檢查點

進行到逐步解說中的這個步驟時，[Web 組件庫] 節點的所有程式碼和 SharePoint 命令都會位於專案中。 建置解決方案，以確定這兩個專案在編譯時未發生任何錯誤。

若要建置方案

  • 在 [建置] 功能表上，選取 [建置方案]。

建立 VSIX 套件以部署擴充功能

若要部署擴充功能，請在您的方案中使用 VSIX 專案，以建立 VSIX 套件。 首先，修改 VSIX 專案包含的 source.extension.vsixmanifest 檔案，來設定 VSIX 套件。 接著，建置方案來建立 VSIX 套件。

若要設定 VSIX 套件

  1. 在 [方案總管] 中，按兩下 [WebPartNode] 專案底下的 source.extension.vsixmanifest 檔案。

    Visual Studio 會在資訊清單編輯器中開啟檔案。 source.extension.vsixmanifest 檔案是所有 VSIX 套件所需要 extension.vsixmanifest 檔案的基準。 如需這個檔案的詳細資訊，請參閱VSIX Extension Schema Reference。

  2. 在 [產品名稱] 方塊中，輸入伺服器總管的 Web 組件庫節點。

  3. 在 [作者] 方塊中，輸入 Contoso。

  4. 在 [描述] 方塊中，輸入將自訂 Web 組件庫節點加入至伺服器總管中的 SharePoint 連接節點。此擴充使用自訂 SharePoint 命令呼叫伺服器物件模型。

  5. 在編輯器的 [內容] 區段中，按一下 [加入內容] 按鈕。

  6. 在 [加入內容] 對話方塊的 [選取內容類型] 清單方塊中，選取 [MEF 元件]。

    注意事項注意事項

    這個值對應於 extension.vsixmanifest 檔案中的 MefComponent 項目。 這個項目指定 VSIX 套件中的擴充組件名稱。 如需詳細資訊，請參閱 MEFComponent Element (VSX Schema)。

  7. 按一下 [選取來源] 底下的 [專案] 選項按鈕，並選取其旁邊清單方塊中的 [WebPartNodeExtension]。

  8. 按一下 [確定]。

  9. 在資訊清單編輯器中，再按一下 [加入內容] 按鈕。

  10. 在 [加入內容] 對話方塊的 [選取內容類型] 清單方塊中，選取 [自訂延伸類型]。

    注意事項注意事項

    這個值對應於 extension.vsixmanifest 檔案中的 CustomExtension 項目。 此項目會指定要加入 Visual Studio 擴充功能的自訂擴充功能。 如需詳細資訊，請參閱 CustomExtension Element (VSX Schema)。

  11. 在 [類型] 文字方塊中，輸入 SharePoint.Commands.v4。

    注意事項注意事項

    這個值對應於 extension.vsixmanifest 檔案中的 CustomExtension 項目的 Type 屬性。 包含自訂 SharePoint 命令的所有自訂擴充組件都需要 Sharepoint.Commands.v4 這個值。

  12. 按一下 [選取來源] 底下的 [專案] 選項按鈕，並選取其旁邊清單方塊中的 [WebPartCommands]。

  13. 按一下 [確定]。

  14. 在 [建置] 功能表上，按一下 [建置方案]。 請確定方案編譯作業未發生錯誤。

  15. 開啟 WebPartNode 專案的建置輸出資料夾。 確定此資料夾現在包含 WebPartNode.vsix 檔。

    根據預設，建置輸出資料夾為 .. \bin\Debug 資料夾，其位於專案檔案包含的資料夾下。

測試擴充功能

現在您可以測試 [伺服器總管] 中新的 [Web 組件庫] 節點。 首先，在 Visual Studio 的實驗執行個體中開始偵錯擴充功能。 接著在 Visual Studio 的實驗執行個體中使用新的 [Web 組件] 節點。

若要啟動對擴充功能的偵錯

  1. 使用系統管理員權限重新啟動 Visual Studio，並且開啟 WebPartNode 專案。

  2. 在 WebPartNodeExtension 專案中，開啟 SiteNodeExtension 程式碼檔，然後將中斷點加入至 NodeChildrenRequested 和 CreateWebPartNodes 方法內的第一行程式碼中。

  3. 按 F5 鍵啟動偵錯作業。

    Visual Studio 會將擴充功能安裝至 %UserProfile%\AppData\Local\Microsoft\VisualStudio\10.0Exp\Extensions\Contoso\Web Part Gallery Node Extension for Server Explorer\1.0，並啟動 Visual Studio 的實驗執行個體。 您將會在 Visual Studio 的這個執行個體中測試專案項目。

若要測試擴充功能

  1. 在 Visual Studio 的實驗執行個體中，按一下 [檢視] 功能表上的 [伺服器總管]。

  2. 確認要用來進行測試的 SharePoint 網站出現在 [伺服器總管] 中的 [SharePoint 連接] 節點底下。 如果網站未列出，請執行下列步驟：

    1. 以滑鼠右鍵按一下 [SharePoint 連接]，然後按一下 [加入連接]。

    2. 在 [加入 SharePoint 連接] 對話方塊中，輸入要連接的 SharePoint 網站 URL。 若要指定開發電腦上的 SharePoint 網站，請輸入 https://localhost。

    3. 按一下 [確定]。

  3. 展開網站連接節點 (即顯示網站之 URL 的節點)，然後展開子網站節點 (例如 [Team 網站])。

  4. 確認另一個 Visual Studio 執行個體中的程式碼在您之前於 NodeChildrenRequested 方法中設定的中斷點停止。 按 F5 繼續偵錯專案。

  5. 在 Visual Studio 的實驗執行個體中，確認名為 [Web 組件庫] 的新節點出現在最上層網站節點底下。 展開 [Web 組件庫] 節點。

  6. 確認另一個 Visual Studio 執行個體中的程式碼在您之前於 CreateWebPartNodes 方法中設定的中斷點停止。 按 F5 繼續偵錯專案。

  7. 在 Visual Studio 的實驗執行個體中，確認所連接網站上的所有 Web 組件都出現在 [伺服器總管] 中的 [Web 組件庫] 節點底下。

  8. 以滑鼠右鍵按一下其中一個 Web 組件，然後按一下 [屬性]。

  9. 在您要進行偵錯的 Visual Studio 執行個體中，確認關於 Web 組件的詳細資料出現在 [屬性] 視窗中。

從 Visual Studio 解除安裝擴充功能

完成測試擴充功能之後，解除安裝 Visual Studio 中的擴充功能。

若要解除安裝擴充功能

  1. 在 Visual Studio 的實驗執行個體中，按一下 [工具] 功能表上的 [擴充管理員]。

    [擴充管理員] 對話方塊隨即開啟。

  2. 在擴充功能清單中，選取 [伺服器總管的 Web 組件庫節點擴充功能]，然後按一下 [解除安裝]。

  3. 在所顯示的對話方塊中，按一下 [是]，確認您要解除安裝擴充功能。

  4. 按一下 [立即重新啟動] 完成解除安裝。

  5. 關閉 Visual Studio 的兩個執行個體 (Visual Studio 的實驗執行個體，以及其中有開啟 WebPartNode 專案的執行個體)。

請參閱

工作

逐步解說：在伺服器總管擴充功能中呼叫 SharePoint 用戶端物件模型

建立新的點陣圖或其他影像

參考

影像編輯器

其他資源

在伺服器總管中擴充 SharePoint 連線節點