Wdrażanie rozszerzeń dla narzędzia programu SharePoint w programie Visual Studio

Aby wdrożyć rozszerzenie narzędzia programu SharePoint, należy utworzyć Visual Studio pakiet rozszerzenia (VSIX), który zawiera zestaw rozszerzeń i innych plików, które chcesz dystrybuować z rozszerzeniem.Pakiet VSIX jest skompresowany plik, który następuje standardowe konwencje opakowania Open (OPC).Pakiety VSIX mają rozszerzenie .vsix.

Po utworzeniu pakiet VSIX, innych użytkowników można uruchomić plik .vsix, aby zainstalować rozszerzenie.Gdy użytkownik instaluje rozszerzenia, wszystkie pliki są instalowane w folderze %UserProfile%\AppData\Local\Microsoft\VisualStudio\11.0\Extensions.Aby wdrożyć rozszerzenia, możesz przesłać pakiet VSIX do Galerii Visual Studio witryny sieci Web, lub można rozpowszechnić go do klientów przez inne środki, takie jak hosting pakiet na dysku sieciowym lub innej witryny sieci Web.

Aby uzyskać więcej informacji dotyczących tworzenia pakietów VSIX i wdrażania ich do Galerii Visual Studio, zobacz VSIX wdrażania.

Pakiet VSIX można utworzyć za pomocą Projektu VSIX szablonu w programie Visual Studio, lub można ręcznie utworzyć pakiet VSIX.

Tworzenie pakietów VSIX przy użyciu projektów VSIX

Można użyć Projektu VSIX szablonu dostarczanego przez Visual Studio SDK do tworzenia pakietów, VSIX dla rozszerzenia narzędzia do obsługi programu SharePoint.Za pomocą projektu VSIX zapewnia większe korzyści niż ręczne tworzenie pakiet VSIX:

• Podczas budowania projektu programu Visual Studio automatycznie generuje pakiet VSIX.Zadania, takie jak dodawanie plików wdrażania pakietu i tworzenia pliku XML [Content_Types] pakiet są wykonane.

• Można skonfigurować projekt VSIX, aby dołączyć dane wyjściowe kompilacji projektu rozszerzenie i inne pliki, takie jak szablony projektu i szablony elementów w pakiecie VSIX.

Aby uzyskać więcej informacji o programie VSIX project, zobacz Szablon projektu VSIX.

Organizowanie projektów

Domyślnie VSIX projekty generują tylko VSIX pakietów, nie zestawów.W związku z tym należy zwykle nie należy implementować rozszerzenie narzędzia programu SharePoint w projekcie VSIX.Ogólnie pracy z co najmniej dwa projekty:

• Projekt VSIX.

• Projektu biblioteki klas, który implementuje rozszerzenie.

Możesz także pracować z dodatkowe projekty dla niektórych typów rozszerzeń:

• Projektu biblioteki klas, który implementuje wszystkie polecenia programu SharePoint, które są używane przez rozszerzenie.Instruktaż, który pokazuje, w tym scenariuszu, zobacz Instruktaż: Rozszerzanie Server Explorer do wyświetlania składników Web Part.

• Projekt element szablon lub szablon projektu, który tworzy element szablon lub szablon projektu, jeśli rozszerzenie definiuje nowy typ elementu projektu programu SharePoint.Instruktaż, który pokazuje, w tym scenariuszu, zobacz Instruktaż: Tworzenie elementu projektu działania niestandardowe z szablonu elementu, część 1.

• Projektu biblioteki klas, który implementuje niestandardowe kreatora dla elementu szablon lub szablon projektu, jeśli rozszerzenie zawiera szablon.Instruktaż, który pokazuje, w tym scenariuszu, zobacz Instruktaż: Tworzenie elementu projektu działania niestandardowe z szablonu elementu, część 2.

Jeśli wszystkie projekty w tym samym rozwiązanie Visual Studio, można zmodyfikować plik source.extension.vsixmanifest w projekcie VSIX, aby dołączyć dane wyjściowe budować projektach biblioteki klas.

Edycja manifestu VSIX

Należy zmodyfikować plik source.extension.vsixmanifest w projekcie VSIX ma obejmować zapisy dla wszystkich elementów, które mają zostać uwzględnione w Twojego rozszerzenia.Po otwarciu pliku source.extension.vsixmanifest z menu skrótów, plik pojawia się w projektancie, który udostępnia interfejs do edycji XML w pliku.Aby uzyskać więcej informacji, zobacz Projektant manifestu VSIX.

Należy dodać wpisy do pliku source.extension.vsixmanifest dla następujących elementów:

• Zestaw rozszerzeń.

• Zestaw, który implementuje wszystkie polecenia programu SharePoint, które są używane przez rozszerzenie.

• Szablony projektu lub szablony elementów, które są skojarzone z rozszerzeniem.

• Niestandardowe Kreatora szablonu, który jest skojarzony z rozszerzeniem.

W poniższych procedurach opisano sposób dodawania wpisy w pliku .vsixmanifest dla każdego z tych elementów.

Aby dołączyć rozszerzenie zestawu

1. W projekcie VSIX, otwórz menu skrótów dla pliku source.extension.vsixmanifest, a następnie wybierz Otwórz.

   Plik zostanie otwarty w Projektancie

2. Na aktywów kartę Edytor, należy wybrać Nowa przycisk.

   Dodać nowego środka zostanie otwarte okno dialogowe.

3. W typu listy, wybierz opcję Microsoft.VisualStudio.MefComponent.

4. W źródło listy, wykonaj jedną z następujących czynności:

   • Montaż rozszerzenie jest zbudowany z projektu, który jest w tym samym roztworze jako projekt VSIX, wybierz opcję A projektu w bieżącym rozwiązaniem.W Projekt listy, wybierz nazwę projektu.

   • Montaż rozszerzenie jest włączony jako plik projektu, wybierz opcję plików na system plików.W ścieżka listy, wprowadź pełną ścieżkę do pliku zestawu rozszerzenie lub użyć ludzie przycisk, aby zlokalizować i wybrać plik zestawu.

5. Wybierz przycisk OK.

Aby dołączyć zestawu poleceń programu SharePoint

1. W projekcie VSIX, otwórz menu skrótów dla pliku source.extension.vsixmanifest, a następnie wybierz Otwórz przycisk.

   Plik zostanie otwarty w projektancie.

2. W aktywów sekcji edytora, należy wybrać Nowa przycisk.

   Dodać nowego środka zostanie otwarte okno dialogowe.

3. W typu wprowadź SharePoint.Commands.v4.

4. W źródło listy, wykonaj jedną z następujących czynności:

   • Jeśli zestaw poleceń jest zbudowany z projektu, który jest w tym samym roztworze jako projekt VSIX, wybierz A projektu w bieżącym rozwiązaniem.W Projekt listy, wybierz nazwę projektu.

   • Zestaw poleceń jest włączony jako plik projektu, wybierz opcję plików na system plików.W ścieżka listy, wprowadź pełną ścieżkę do pliku zestawu rozszerzenie lub użyć ludzie przycisk, aby zlokalizować i wybrać plik zestawu.

5. Wybierz przycisk OK.

Aby dołączyć szablon, który użytkownik tworzy

1. W projekcie VSIX, otwórz menu skrótów dla pliku source.extension.vsixmanifest, a następnie wybierz Otwórz przycisk.

   Plik zostanie otwarty w projektancie.

2. W aktywów sekcji edytora, należy wybrać Nowa przycisk.

   Dodać nowego środka zostanie otwarte okno dialogowe.

3. W typu listy, wybierz opcję Microsoft.VisualStudio.ProjectTemplate lub Microsoft.VisualStudio.ItemTemplate.

4. W źródło listy, wybierz opcję projektu w bieżącym rozwiązaniem.

5. W Projekt listy, wybierz nazwę projektu, a następnie wybierz OK przycisk.

6. W Solution Explorer, aby otworzyć menu skrótów dla projektu szablonu projektu lub szablonu elementu, a następnie wybierz Unload projektu.

7. Ponownie otwórz menu skrótów dla węzła projektu, a następnie wybierz edytowaćYourTemplateProjectName**.csproj** lub edytowaćYourTemplateProjectName**.vbproj**.

8. Zlokalizuj następujące VSTemplate elementu w pliku projektu.

   <VSTemplate Include="YourTemplateName.vstemplate">
   

9. Ten element należy zastąpić następujący kod XML.

   <VSTemplate Include="YourTemplateName.vstemplate">
     <OutputSubPath>SharePoint\SharePoint14</OutputSubPath>
   </VSTemplate>
   

   OutputSubPath Element określa dodatkowe foldery w ścieżce, pod którym szablon projektu jest tworzony podczas tworzenia projektu.Foldery określone tutaj zapewnienia szablon elementu będą dostępne tylko wtedy, gdy klienci Otwórz Dodać nowy projekt okno dialogowe rozwiń SharePoint węzła, a następnie wybierz 2010 węzła.

10. Zapisz i zamknij plik.

11. W Solution Explorer, aby otworzyć menu skrótów dla projektu szablonu projektu lub szablonu elementu, a następnie wybierz Projektu Reload.

Aby dołączyć szablon, który można tworzyć ręcznie

1. W projekcie VSIX dodać nowy folder do projektu zawiera szablon.

2. W tym nowym folderze utwórz następujące podfoldery, a następnie dodaj plik szablonu (zip) do Locale ID folder.

        YourTemplateFolder

             Program SharePoint

                  SharePoint14

                       Identyfikator ustawień regionalnych

                            YourTemplateNameZIP

   Na przykład jeśli szablon towaru o nazwie ContosoCustomAction.zip, który obsługuje ustawień regionalnych języka angielskiego (Stany Zjednoczone), pełna ścieżka może być ItemTemplates\SharePoint\SharePoint14\1033\ContosoCustomAction.zip.

3. W Solution Explorer, wybierz plik szablonu (YourTemplateName.zip).

4. W Właściwości okno, ustawić Tworzenie akcji właściwość, aby zawartości.

5. Otwórz menu skrótów dla pliku source.extension.vsixmanifest, a następnie wybierz Otwórz.

   Plik zostanie otwarty w projektancie.

6. W aktywów sekcji edytora, należy wybrać Nowa przycisk.

   Dodać nowego środka zostanie otwarte okno dialogowe.

7. W typu listy, wybierz opcję Microsoft.VisualStudio.ItemTemplate lub Microsoft.VisualStudio.ProjectTemplate.

8. W źródło listy, wybierz opcję plików na system plików.

9. W ścieżka wprowadź pełną ścieżkę do zgromadzenia (na przykład, ItemTemplates\SharePoint\SharePoint14\1033\ContosoCustomAction.zip, lub użyj ludzie przycisk, aby zlokalizować i wybrać zestaw, a następnie wybierz OK przycisk.

Aby dołączyć Kreatora szablonu projektu lub szablon towaru

1. W projekcie VSIX, otwórz menu skrótów dla pliku source.extension.vsixmanifest, a następnie wybierz Otwórz.

   Plik zostanie otwarty w projektancie.

2. W aktywów sekcji edytora, należy wybrać Nowa przycisk.

   Dodać nowego środka zostanie otwarte okno dialogowe.

3. W typu listy, wybierz opcję Microsoft.VisualStudio.Assembly.

4. W źródło listy, wykonaj jedną z następujących czynności:

   • Jeśli Kreator zestawu jest zbudowany z projektu, który jest w tym samym roztworze jako projekt VSIX, wybierz A projektu w bieżącym rozwiązaniem.W Projekt listy, wybierz nazwę projektu.

   • Jeśli Kreator zestawu jest włączony jako plik projektu, wybierz plików na system plików.W ścieżka w polu, wprowadź pełną ścieżkę do pliku zestawu lub użyć ludzie przycisk, aby zlokalizować i wybrać z zestawu.

5. Wybierz przycisk OK.

Instruktaże pokrewne

Poniższa lista zawiera opisy, które wskazują, jak używać projektu VSIX wdrażania różnych typów rozszerzeń narzędzia programu SharePoint.

Typ rozszerzenia	Instruktaże pokrewne
Rozszerzenie, które zawiera tylko zestaw rozszerzeń	Instruktaż: Rozszerzenie typu element projektu programu SharePoint Instruktaż: Tworzenie rozszerzenie projektu programu SharePoint Instruktaż: Wywołanie do modelu obiektu klienta programu SharePoint w rozszerzeniu Eksploratora serwera
Rozszerzenie, które zawiera polecenia programu SharePoint	Instruktaż: Tworzenie kroku wdrożenia niestandardowe dla projektów programu SharePoint Instruktaż: Rozszerzanie Server Explorer do wyświetlania składników Web Part Instruktaż: Tworzenie elementu projektu kolumny witryny z szablonu projektu, część 2
Rozszerzenie, które zawiera szablon programu Visual Studio	Instruktaż: Tworzenie elementu projektu działania niestandardowe z szablonu elementu, część 1 Instruktaż: Tworzenie elementu projektu kolumny witryny z szablonu projektu, część 1
Rozszerzenie, które obejmuje Kreatora szablonów	Instruktaż: Tworzenie elementu projektu działania niestandardowe z szablonu elementu, część 2 Instruktaż: Tworzenie elementu projektu kolumny witryny z szablonu projektu, część 2

Ręczne tworzenie pakietów VSIX

Jeśli chcesz ręcznie utworzyć pakiet VSIX dla rozszerzenia narzędzi programu SharePoint, wykonaj następujące czynności:

1. Utwórz plik extension.vsixmanifest, .xml [Content_Types] i pliku VSIX pakietu (plik .vsix).Aby uzyskać więcej informacji, zobacz Anatomia pakietu VSIX i Jak: ręcznie pakietu rozszerzenia (VSIX wdrażania).

2. Dodaj swoje rozszerzenie zestawu do pakiet VSIX.Jeśli rozszerzenie zawiera polecenia programu SharePoint, należy również dodać zestawu, który implementuje polecenia programu SharePoint w pakiecie VSIX.

3. Zmodyfikuj plik extension.vsixmanifest:

   • Dodaj Microsoft.VisualStudio.MefComponent element pod Assets element, a następnie ustawić wartość nowego elementu do ścieżki względnej zestawu, który implementuje rozszerzenie w pakiecie VSIX.Aby uzyskać więcej informacji, zobacz MefComponent Element.

   • Jeśli rozszerzenie zawiera polecenia programu SharePoint, który wzywa do modelu obiektu serwera dla programu SharePoint, należy dodać Microsoft.VisualStudio.Assembly element pod Assets element.Ustaw wartość nowy element względną ścieżkę do zestawu, który implementuje polecenia programu SharePoint w pakiecie VSIX.Aby uzyskać więcej informacji, zobacz Element aktywów (schemat VSX).

   • Jeśli rozszerzenie zawiera szablon projektu lub szablonu elementu, należy dodać ProjectTemplate lub ItemTemplate element pod Assets element.Ustaw wartość nowy element względną ścieżkę do folderu, który zawiera szablon w pakiecie VSIX.Aby uzyskać więcej informacji, zobacz ProjectTemplate Element i ItemTemplate Element.

   • Jeśli rozszerzenie zawiera Kreatora niestandardowy szablon projektu lub szablonu elementu, należy dodać Assembly element pod Assets element.Ustaw wartość nowego elementu do ścieżki względnej zgromadzenia w pakiecie VSIX, a następnie ustaw AssemblyName atrybut nazwy pełnego zestawu (w tym wersji, kultury i tokenu klucza publicznego).Aby uzyskać więcej informacji, zobacz Zależność Element (schemat VSX).

Przykład

Poniższy przykład pokazuje zawartość pliku extension.vsixmanifest dla rozszerzenia narzędzi programu SharePoint.Rozszerzenie jest zaimplementowana w zestawie o nazwie Contoso.ProjectExtension.dll.Rozszerzenie zawiera zestaw poleceń programu SharePoint, o nazwie Contoso.ExtensionCommands.dll i szablon towaru w folderze o nazwie ItemTemplates w pakiecie VSIX.W tym przykładzie założono, że oba zestawy są w tym samym folderze co plik extension.vsixmanifest w pakiecie VSIX.

<PackageManifest Version=”2.0.0” xmlns=”https://schemas.microsoft.com/developer/vsx-schema/2011”>
  <Metadata>
    <Identity Id="CustomActionProjectItem.Microsoft.b99efe4d-cef3-4afd-b9af-034ca0c52743" Version="1.0" Language="en-US" Publisher="Microsoft" />
    <DisplayName>CustomActionProjectItem</DisplayName>
    <Description>Empty VSIX Project.</Description>
  </Metadata>
  <Installation>
    <InstallationTarget Id="Microsoft.VisualStudio.Pro" Version="11.0" />
  </Installation>
  <Dependencies>
    <Dependency Id="Microsoft.Framework.NDP" DisplayName="Microsoft .NET Framework" Version="4.5" />
  </Dependencies>
  <Assets>
    <Asset Type="Microsoft.VisualStudio.ItemTemplate" Path="ItemTemplates" />
    <Asset Type="Microsoft.VisualStudio.MefComponent" Path="ProjectItemDefinition.dll" />
  </Assets>
</PackageManifest>

Zobacz też

Koncepcje

Rozszerzenia systemu projektu programu SharePoint

Wywołanie do modeli obiektów programu SharePoint

Debugowanie rozszerzeń dla narzędzia programu SharePoint w programie Visual Studio

Inne zasoby

Rozszerzanie węzła połączenia programu SharePoint w programie Server Explorer