연습: 서버 탐색기를 확장하여 웹 파트 표시
Visual Studio 사용할 수 있는 SharePoint 연결 노드를 서버 탐색기 구성 SharePoint 사이트에서 볼 수.그러나 서버 탐색기 일부 구성 요소는 기본적으로 표시 되지 않습니다.이 연습에서는 사용자를 확장할 것 서버 탐색기 SharePoint 사이트 웹 파트 갤러리에 표시 되도록 연결 합니다.
이 연습에서는 다음 작업을 수행합니다.
다음과 같은 방법으로 서버 탐색기를 확장하는 Visual Studio 확장 만들기
확장명 추가 된 웹 파트 갤러리 노드 아래에서 각 SharePoint 사이트 노드의 서버 탐색기.새 노드에는 사이트에서 웹 파트 갤러리의 각 웹 파트를 나타내는 자식 노드가 포함됩니다.
확장 웹 파트 인스턴스를 나타내는 노드의 새 형식을 정의 합니다.새 노드 형식은 새 웹 파트 갤러리 노드 아래에 있는 자식 노드의 기반이 됩니다.새 웹 파트 노드 형식이 나타내는 웹 파트에 대한 정보가 속성 창에 표시됩니다.노드 형식에는 웹 파트와 관련 된 다른 작업을 수행 하는 데 시작 점으로 사용할 수 있는 사용자 지정 바로 가기 메뉴 항목을 포함 되어 있습니다.
두 개의 사용자 지정 SharePoint 명령을 만들기는 확장 어셈블리 호출 합니다.SharePoint 명령을 확장 어셈블리에 대 한 SharePoint 서버 개체 모델의 Api를 사용 하 여 호출할 수 있는 메서드입니다.이 연습에서는 개발 컴퓨터의 로컬 SharePoint 사이트로부터 웹 파트 정보를 검색하는 명령을 만듭니다.자세한 내용은 SharePoint 개체 모델 호출을 참조하십시오.
확장을 배포하기 위한 VSIX(Visual Studio Extension) 패키지 빌드
확장 디버깅 및 테스트
[!참고]
해당 서버 개체 모델 대신 Sharepoint에 대 한 클라이언트 개체 모델을 사용 하는이 연습에서 대체 버전을 참조 하십시오. 연습: 서버 탐색기 확장의 SharePoint 클라이언트 개체 모델 호출.
사전 요구 사항
이 연습을 완료하려면 개발 컴퓨터에 다음 구성 요소가 필요합니다.
지원 되는 버전의 Windows, SharePoint 및 Visual Studio.자세한 내용은 SharePoint 솔루션 개발 요구 사항을 참조하십시오.
Visual Studio SDK입니다.이 연습에서는 SDK의 VSIX 프로젝트 템플릿을 사용하여 프로젝트 항목을 배포하기 위한 VSIX 패키지를 만듭니다.자세한 내용은 Visual Studio에서 SharePoint 도구 확장을 참조하십시오.
다음 개념을 알고 있으면 연습을 완료하는 데 도움이 되지만 반드시 필요하지는 않습니다.
Sharepoint에 대 한 서버 개체 모델을 사용 합니다.자세한 내용은 Using the SharePoint Foundation Server-Side Object Model을 참조하십시오.
SharePoint 솔루션의 웹 파트.자세한 내용은 Web Parts Overview를 참조하십시오.
프로젝트 만들기
이 연습을 완료 하려면 세 프로젝트를 만들어야 합니다.
VSIX 패키지를 만들어 확장을 배포하기 위한 VSIX 프로젝트
확장을 구현하는 클래스 라이브러리 프로젝트..NET Framework 4.5이이 프로젝트를 대상으로 해야 합니다.
사용자 지정 SharePoint 명령을 정의하는 클래스 라이브러리 프로젝트.이 프로젝트는 .NET Framework 3.5를 대상으로 해야 합니다.
먼저 프로젝트를 만들어 연습을 시작합니다.
VSIX 프로젝트를 만들려면
Visual Studio를 시작합니다.
메뉴 모음에서 파일, 새로 만들기, 프로젝트를 선택합니다.
에 새 프로젝트 대화 상자에서 확장은 C# 또는 Visual Basic 노드를 다음 선택은 확장성 노드.
[!참고]
확장성 노드인 Visual Studio SDK를 설치한 경우에 사용할 수 있습니다.자세한 내용은 이 항목의 앞부분에 나오는 사전 요구 사항 단원을 참조하십시오.
대화 상자의 맨 위에 있는 선택 .NET Framework 4.5 .NET Framework 버전의 목록에서입니다.
선택은 VSIX 프로젝트 템플릿, 프로젝트 이름 WebPartNode, 다음 선택은 확인 단추.
Visual Studio에서 솔루션 탐색기에 WebPartNode 프로젝트를 추가합니다.
확장 프로젝트를 만들려면
솔루션 탐색기, 솔루션 노드 바로 가기 메뉴를 열고 추가, 다음 선택 새 프로젝트.
[!참고]
Visual Basic 프로젝트에서는 General, Projects and Solutions, Options Dialog Box에서 솔루션 항상 표시 확인란을 선택한 경우에만 솔루션 탐색기에 솔루션 노드가 표시됩니다.
에 새 프로젝트 대화 상자에서 확장 된 C# 노드 또는 Visual Basic 노드를 선택한 다음 선택 Windows 노드.
대화 상자의 맨 위에 있는 선택 .NET Framework 4.5 .NET Framework 버전의 목록에서입니다.
프로젝트 템플릿 목록에서 선택 클래스 라이브러리, 프로젝트의 이름을 WebPartNodeExtension, 다음 선택은 확인 단추입니다.
Visual Studio에서 솔루션에 WebPartNodeExtension 프로젝트를 추가하고 기본 Class1 코드 파일을 엽니다.
프로젝트에서 Class1 코드 파일을 삭제합니다.
SharePoint 명령 프로젝트를 만들려면
솔루션 탐색기, 솔루션 노드 바로 가기 메뉴를 열고 추가, 다음 선택 새 프로젝트.
[!참고]
Visual Basic 프로젝트에서는 General, Projects and Solutions, Options Dialog Box에서 솔루션 항상 표시 확인란을 선택한 경우에만 솔루션 탐색기에 솔루션 노드가 표시됩니다.
에 새 프로젝트 대화 상자에서 확장은 C# 노드 또는 Visual Basic 노드를 다음 선택은 Windows 노드.
대화 상자의 맨 위에 있는 선택 .NET Framework 3.5 .NET Framework 버전의 목록에서입니다.
프로젝트 템플릿 목록에서 선택 클래스 라이브러리, 프로젝트의 이름을 WebPartCommands, 다음 선택은 확인 단추입니다.
Visual Studio에서 솔루션에 WebPartCommands 프로젝트를 추가하고 기본 Class1 클래스 파일을 엽니다.
프로젝트에서 Class1 코드 파일을 삭제합니다.
프로젝트 구성
확장을 만드는 코드를 작성 하기 전에 코드 파일과 어셈블리 참조를 추가 하 고 프로젝트 설정을 구성 해야 합니다.
WebPartNodeExtension 프로젝트를 구성하려면
WebPartNodeExtension 프로젝트에 다음과 같은 이름을 가진 네 개의 코드 파일을 추가 합니다.
SiteNodeExtension
WebPartNodeTypeProvider
WebPartNodeInfo
WebPartCommandIds
바로 가기 메뉴를 열고를 WebPartNodeExtension 프로젝트를 하 고 선택 참조 추가.
에 참조 관리자 – WebPartNodeExtension 대화 상자에서 선택 된 프레임 워크 탭을 클릭 한 다음 각 다음 어셈블리에 대 한 확인란을 선택:
System.ComponentModel.Composition
System.Windows.Forms
선택은 확장명 탭 Microsoft.VisualStudio.SharePoint 어셈블리에 대 한 확인란을 선택 하 고 다음을 선택의 확인 단추.
솔루션 탐색기, 바로 가기 메뉴를 열고를 WebPartNodeExtension 프로젝트 노드 및 다음 선택 속성.
프로젝트 디자이너가 열립니다.
선택 된 응용 프로그램 탭입니다.
에 기본 네임 스페이스 상자 (C#) 또는 루트 네임 스페이스 상자 (Visual Basic)를 입력 ServerExplorer.SharePointConnections.WebPartNode.
WebPartCommands 프로젝트를 구성하려면
WebPartCommands 프로젝트에서 WebPartCommands 라는 코드 파일을 추가 합니다.
솔루션 탐색기, 바로 가기 메뉴를 열고를 WebPartCommands 프로젝트 노드를 선택 추가, 다음 선택 기존 항목.
에 있는 기존 항목 추가 대화 상자 WebPartNodeExtension 프로젝트에 대 한 코드 파일이 들어 있는 폴더를 찾습니다 및 다음 WebPartNodeInfo 및 WebPartCommandIds 코드 파일을 선택 합니다.
옆에 있는 화살표를 선택한는 추가 단추를 클릭 한 다음 선택 링크로 추가 에 표시 되는 메뉴.
Visual Studio에서 코드 파일을 WebPartCommands 프로젝트에 링크로 추가합니다.결과적으로 WebPartNodeExtension 프로젝트에 코드 파일이 있습니다 하지만 코드 파일에서 또한 WebPartCommands 프로젝트의 컴파일.
바로 가기 메뉴를 열고를 WebPartCommands 다시, 프로젝트 및 선택 참조 추가.
에 참조 관리자 – WebPartCommands 대화 상자에서 선택에서 확장 탭, 각각 다음 어셈블리에 대 한 확인란을 선택 하 고 다음을 선택의 확인 단추:
Microsoft.SharePoint
Microsoft.VisualStudio.SharePoint.Commands
솔루션 탐색기, 바로 가기 메뉴를 열고를 WebPartCommands 프로젝트를 다시 및 다음 선택 속성.
프로젝트 디자이너가 열립니다.
선택 된 응용 프로그램 탭입니다.
에 기본 네임 스페이스 상자 (C#) 또는 루트 네임 스페이스 상자 (Visual Basic)를 입력 ServerExplorer.SharePointConnections.WebPartNode.
새 노드의 아이콘 만들기
서버 탐색기 확장에 대한 두 아이콘을 만듭니다. 한 아이콘은 새 웹 파트 갤러리 노드를 나타내고, 다른 아이콘은 웹 파트 갤러리 노드 아래의 각 자식 웹 파트 노드를 나타냅니다.이 연습의 뒷부분에서는 이러한 아이콘을 노드에 연결하는 코드를 작성합니다.
노드의 아이콘을 만들려면
솔루션 탐색기, 바로 가기 메뉴를 열고를 WebPartNodeExtension 프로젝트를 하 고 선택 속성.
프로젝트 디자이너가 열립니다.
선택은 리소스 탭을 클릭 한 다음 선택은 이 프로젝트에는 기본 리소스 파일이 없습니다. 여기를 클릭 하 여 파일을 만들려면 링크입니다.
Visual Studio리소스 파일을 만들고 디자이너에서 열립니다.
디자이너의 맨 위에 있는 화살표 옆에 선택 된 리소스 추가 메뉴, 명령을 클릭 한 다음 선택 새 아이콘 추가 나타나는 메뉴에서.
에 새 리소스 추가 이름 새 아이콘 대화 상자에서 WebPartsNode, 다음 선택은 추가 단추.
새 아이콘이 이미지 편집기에서 열립니다.
디자인을 쉽게 인식할 수 있도록 16x16 버전의 아이콘 편집 합니다.
32X32 버전의 아이콘, 바로 가기 메뉴를 열고 선택 이미지 형식 삭제.
5 단계에서 두 번째 아이콘은 프로젝트 리소스에 추가 하는 8 단계를 반복 하 고이 아이콘 이름을 WebPart.
솔루션 탐색기아래에서 리소스 폴더에는 WebPartNodeExtension 프로젝트에 대 한 바로 가기 메뉴를 엽니다 WebPartsNode.ico.
에 속성 창 옆에 있는 화살표를 선택한 빌드 작업, 다음 선택 포함 리소스 나타나는 메뉴입니다.
WebPart.ico에 대해 마지막 두 단계를 반복합니다.
서버 탐색기에 웹 파트 갤러리 노드 추가
각 SharePoint 사이트 노드에 새 웹 파트 갤러리 노드를 추가하는 클래스를 만듭니다.새 코드를 추가하기 위해 클래스에서 IExplorerNodeTypeExtension 인터페이스를 구현합니다.기존 노드의 동작을 확장 하려는 경우이 인터페이스를 구현 서버 탐색기, 같은 노드에 자식 노드를 추가 합니다.
서버 탐색기에 웹 파트 갤러리 노드를 추가하려면
WebPartNodeExtension 프로젝트에 SiteNodeExtension 코드 파일을 열고 다음 코드를 붙여넣은 다음 다음.
[!참고]
때이 코드를 추가 하 여, 프로젝트 일부 컴파일 오류가 있지만 없어질 것 후 코드 이후 단계에서 추가 합니다.
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); } } } } }
웹 파트를 나타내는 노드 형식 정의
웹 파트를 나타내는 새 노드 형식을 정의하는 클래스를 만듭니다.Visual Studio 새 노드 형식을 사용 하 여 아래에서 자식 노드를 표시 하는 웹 파트 갤러리 노드.단일 웹 파트는 SharePoint 사이트의 각 자식 노드를 나타냅니다.
새 노드 형식을 정의하기 위해 클래스에서 IExplorerNodeTypeProvider 인터페이스를 구현합니다.서버 탐색기에서 새 노드 형식을 정의하려는 경우 이 인터페이스를 구현합니다.
웹 파트 노드 형식을 정의하려면
WebPartNodeExtension 프로젝트에 WebPartNodeTypeProvder 코드 파일을 열고 다음 코드를 붙여넣은 다음 다음.
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); } } }
웹 파트 데이터 클래스 정의
SharePoint 사이트의 단일 웹 파트에 대한 정보가 포함된 클래스를 정의합니다.이 연습의 뒷부분에서 각 웹 파트는 사이트에 대 한 데이터를 검색 하 고 다음이 클래스의 인스턴스에 데이터를 할당 하는 사용자 지정 SharePoint 명령을 만듭니다.
웹 파트 데이터 클래스를 정의하려면
WebPartNodeExtension 프로젝트에 WebPartNodeInfo 코드 파일을 열고 다음 코드를 붙여넣은 다음 다음.
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 명령의 ID 정의
사용자 지정 SharePoint 명령을 식별하는 여러 문자열을 정의합니다.이러한 명령은 이 연습의 뒷부분에서 구현합니다.
명령 ID를 정의하려면
WebPartNodeExtension 프로젝트에 WebPartCommandIds 코드 파일을 열고 다음 코드를 붙여넣은 다음 다음.
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 서버 개체 모델을 호출 하는 사용자 지정 명령을 만듭니다.각 명령은 SharePointCommandAttribute가 적용된 메서드입니다.
SharePoint 명령을 정의하려면
WebPartCommands 프로젝트에 WebPartCommands 코드 파일을 열고 다음 코드를 붙여넣은 다음 다음.
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); } } }
검사점
이 연습의 이전 단계를 통해 웹 파트 갤러리 노드와 SharePoint 명령을 위한 모든 코드가 프로젝트에 포함되었습니다.솔루션을 빌드하여 두 프로젝트가 오류 없이 컴파일되는지 확인합니다.
솔루션을 빌드하려면
메뉴 표시줄에서 선택 빌드, 솔루션 빌드.
주의 이 시점에서 VSIX 매니페스트 파일 작성자에 대 한 값을 포함 하지 않으므로 WebPartNode 프로젝트 빌드 오류가 있을 수 있습니다.이후 단계에서 값을 추가 하면이 오류가 사라집니다.
확장을 배포하기 위한 VSIX 패키지 만들기
확장을 배포하려면 솔루션에서 VSIX 프로젝트를 사용하여 VSIX 패키지를 만듭니다.첫째, VSIX 프로젝트에 있는 source.extension.vsixmanifest 파일을 수정 하 여 VSIX 패키지를 구성 합니다.그런 다음 솔루션을 빌드하여 VSIX 패키지를 만듭니다.
VSIX 패키지를 구성하려면
솔루션 탐색기, WebPartNode 프로젝트에서 열은 source.extension.vsixmanifest 파일이 매니페스트 편집기에서.
Source.extension.vsixmanifest 파일이 모든 VSIX 패키지를 요구 하는 extension.vsixmanifest 파일에 대 한 기반이 됩니다.이 파일에 대한 자세한 내용은 VSIX 확장 스키마 참조를 참조하십시오.
에 있는 제품명 상자에 입력 서버 탐색기에 웹 파트 갤러리 노드.
에 있는 작성자 상자에 입력 Contoso.
에 설명 상자에 입력 서버 탐색기에서의 SharePoint 연결 노드에 사용자 지정 웹 파트 갤러리 노드를 추가 합니다. 이 확장에서는 사용자 지정 SharePoint 명령을 사용하여 서버 개체 모델을 호출합니다.라고 입력합니다.
선택은 자산 편집기의 탭 다음 선택은 New 단추.
를 추가 하는 새로운 자산 대화 상자가 나타납니다.
에 있는 유형 목록에서 선택 Microsoft.VisualStudio.MefComponent.
[!참고]
이 값은 extension.vsixmanifest 파일의 MefComponent 요소에 해당합니다.이 요소는 VSIX 패키지의 확장 어셈블리 이름을 지정합니다.자세한 내용은 MEFComponent Element을 참조하십시오.
에 있는 원본 목록에서 선택 현재 솔루션의 프로젝트에.
에 프로젝트 목록에서 선택 WebPartNodeExtension 다음 선택은 확인 단추입니다.
매니페스트 편집기에서 선택 된 New 단추를 다시 클릭 합니다.
를 추가 하는 새로운 자산 대화 상자가 나타납니다.
에 있는 유형 상자에 입력 SharePoint.Commands.v4.
[!참고]
이 요소는 Visual Studio 확장에 포함할 사용자 지정 확장을 지정합니다.자세한 내용은 자산 요소 (VSX 스키마)을 참조하십시오.
에 소스 목록에서 선택 된 현재 솔루션의 프로젝트에 목록 항목.
에 프로젝트 목록에서 선택 WebPartCommands, 다음 선택은 확인 단추입니다.
메뉴 표시줄에서 선택 빌드, 솔루션 빌드, 및 다음 솔루션이 오류 없이 컴파일되는지 확인 합니다.
WebPartNode 프로젝트의 빌드 출력 폴더에 이제 WebPartNode.vsix 파일이 들어 있는지 확인 합니다.
기본적으로 빌드 출력 경로는 프로젝트 파일이 포함된 폴더 아래에 있는 ..\bin\Debug 폴더입니다.
확장 테스트
이제 새 테스트할 준비가 웹 파트 갤러리 노드에서 서버 탐색기.우선 실험 모드의 Visual Studio 인스턴스에서 확장을 디버깅합니다.그런 다음 실험 모드의 Visual Studio 인스턴스에 새 웹 파트 노드를 사용합니다.
확장 디버깅을 시작하려면
다시 Visual Studio 관리 자격 증명 및 다음 열기 WebPartNode 솔루션입니다.
WebPartNodeExtension 프로젝트에 SiteNodeExtension 코드 파일을 열고 다음 코드의 첫째 줄에 중단점을 추가 된 NodeChildrenRequested 및 CreateWebPartNodes 방법.
F5 키를 선택하여 디버깅을 시작합니다.
Visual Studio 서버 explorer\1.0에 대해 %UserProfile%\AppData\Local\Microsoft\VisualStudio\11.0Exp\Extensions\Contoso\Web 파트 갤러리 노드를 확장 하 여 확장을 설치 하 고 Visual Studio 실험 인스턴스를 시작 합니다.이 Visual Studio 인스턴스에서 프로젝트 항목을 테스트합니다.
확장을 테스트하려면
실험적 인스턴스에서 Visual Studio, 메뉴 표시줄에서 선택 보기, 서버 탐색기.
테스트 하는 데 사용 하려는 SharePoint 사이트 아래 나타나지 않으면 다음 단계를 수행은 SharePoint 연결 노드에서 서버 탐색기.
서버 탐색기, 바로 가기 메뉴를 열고 SharePoint 연결, 다음 선택 연결 추가.
에 있는 SharePoint 연결 추가 대화 상자에서 적용할 연결, 및 다음 선택 하려면 SharePoint 사이트에 대 한 URL을 입력의 확인 단추.
개발 컴퓨터에서 SharePoint 사이트를 지정 하려면 입력 https://localhost.
사이트의 URL을 표시 하 고 사이트 연결 노드를 확장 한 다음 자식 사이트 노드를 확장 합니다 (예를 들어, 팀 사이트).
확인 코드의 다른 인스턴스에서 Visual Studio 이전에 설정한 중단점에서 중지는 NodeChildrenRequested 메서드를 다음 프로젝트에 디버깅을 계속 하려면 f5 키를 선택 합니다.
새 노드 라는 Visual Studio 실험적 인스턴스에서 확인 웹 파트 갤러리 최상위 사이트 노드 아래에 표시 한 다음 확장 된 웹 파트 갤러리 노드.
코드 Visual Studio 인스턴스를 이전에 설정한 중단점에서 중지 하는지 확인은 CreateWebPartNodes 메서드를 다음 프로젝트에 디버깅을 계속 하려면 F5 키를 선택 합니다.
Visual Studio 실험적 인스턴스에서 연결된 된 사이트의 모든 웹 파트 나타나는지 확인은 웹 파트 갤러리 노드에서 서버 탐색기.
서버 탐색기, 웹 파트 중 하나에 대 한 바로 가기 메뉴를 엽니다 및 다음 선택 속성이.
인스턴스의 Visual Studio 디버깅 하 고, 세부 정보 웹 파트에 표시 되는지 확인은 속성이 창.
Visual Studio에서 확장 제거
확장 테스트를 마친 후 Visual Studio에서 확장을 제거합니다.
확장을 제거하려면
실험적 인스턴스에서 Visual Studio, 메뉴 표시줄에서 선택 도구, 확장 및 업데이트.
확장 및 업데이트 대화 상자가 열립니다.
확장명 목록에서 선택한 서버 탐색기에 웹 파트 갤러리 노드 확장, 다음 선택은 제거 단추입니다.
나타나는 대화 상자에서 선택 된 예 확장명을 제거 하 고 선택 확인 단추는 지금 다시 시작 단추 제거를 완료 합니다.
Visual Studio (Visual Studio WebPartNode 솔루션에 열려 있는 인스턴스 및 실험적 인스턴스)을 모두 닫습니다.
참고 항목
작업
연습: 서버 탐색기 확장의 SharePoint 클라이언트 개체 모델 호출
아이콘 또는 다른 이미지 만들기(아이콘에 대한 이미지 편집기)