Nasazení rozšíření pro SharePoint nástroje v Visual Studio

Pokud chcete nasadit SharePoint nástroje, vytvořte balíček rozšíření (VSIX), který obsahuje sestavení rozšíření a všechny další soubory, které chcete distribuovat s Visual Studio příponou. Balíček VSIX je komprimovaný soubor, který dodržuje standard OPC (Open Packaging Conventions). Balíčky VSIX mají příponu .vsix.

Po vytvoření balíčku VSIX mohou ostatní uživatelé spustit soubor .vsix a nainstalovat vaše rozšíření. Když uživatel nainstaluje vaši příponu, nainstalují se všechny soubory do složky %UserProfile%\AppData\Local\Microsoft\VisualStudio\11.0\Extensions. Pokud chcete nasadit rozšíření, můžete nahrát balíček VSIX na web Visual Studio Marketplace nebo distribuovat balíček svým zákazníkům jiným způsobem, například hostování balíčku ve sdílené síťové sdílené síti nebo jiném webu.

Další informace o vytváření balíčků VSIX a jejich nasazení na Visual Studio Marketplacenajdete v tématu Shipping Visual Studio Extensions.

Balíček VSIX můžete vytvořit pomocí šablony Project VSIX v Visual Studio, nebo můžete vytvořit balíček VSIX ručně.

Použití projektů VSIX k vytváření balíčků VSIX

K vytváření balíčků VS SharePoint IX pro Project nástroje můžete použít šablonu VSIX Visual Studio SDK. Použití projektu VSIX přináší několik výhod než ruční vytvoření balíčku VSIX:

  • Visual Studio automaticky vygeneruje balíček VSIX při sestavování projektu. Úlohy, jako je přidání souborů nasazení do balíčku a vytvoření souboru [Content_Types].xml pro balíček, se provádí za vás.

  • Projekt VSIX můžete nakonfigurovat tak, aby zahrnoval výstup sestavení projektu rozšíření a další soubory, jako jsou šablony projektů a šablony položek, do balíčku VSIX.

Další informace o použití projektu VSIX najdete v tématu Šablona Project VSIX.

Uspořádání projektů

Ve výchozím nastavení projekty VSIX generují pouze balíčky VSIX, nikoli sestavení. Proto obvykle neimplementujte rozšíření SharePoint nástroje v projektu VSIX. Obvykle pracujete s alespoň dvěma projekty:

  • Projekt VSIX.

  • Projekt knihovny tříd, který implementuje vaše rozšíření.

Můžete také pracovat s dalšími projekty pro určité typy rozšíření:

  • Projekt knihovny tříd, který implementuje SharePoint příkazů, které vaše rozšíření používá. Návod, který tento scénář demonstruje, najdete v tématu Návod: Rozšíření Průzkumník serveru zobrazení webových částí.

  • Šablona položky nebo Project, který vytvoří šablonu položky nebo šablonu projektu, pokud vaše rozšíření definuje nový typ SharePoint položky projektu. Návod, který tento scénář ukazuje, najdete v části Návod: Vytvoření vlastní položky projektu akce pomocí šablony položky, část 1.

  • Projekt knihovny tříd, který implementuje vlastního průvodce pro šablonu položky nebo šablonu projektu, pokud vaše rozšíření obsahuje šablonu. Návod, který tento scénář demonstruje, najdete v části Návod: Vytvoření vlastní položky projektu akce pomocí šablony položky, Část 2.

Pokud zahrnete všechny projekty do stejného řešení Visual Studio, můžete upravit soubor source.extension.vsixmanifest v projektu VSIX tak, aby zahrnoval výstup sestavení projektů knihovny tříd.

Úprava manifestu VSIX

V projektu VSIX musíte upravit soubor source.extension.vsixmanifest tak, aby zahrnoval položky pro všechny položky, které chcete do rozšíření zahrnout. Když otevřete soubor source.extension.vsixmanifest z místní nabídky, soubor se zobrazí v návrháři, který poskytuje uživatelské rozhraní pro úpravy xml v souboru. Další informace najdete v tématu Návrhář manifestu VSIX.

Do souboru source.extension.vsixmanifest musíte přidat položky pro následující položky:

  • Sestavení rozšíření.

  • Sestavení, které implementuje všechny SharePoint, které používá vaše rozšíření.

  • Všechny šablony projektů nebo šablony položek, které jsou přidružené k vašemu rozšíření.

  • Vlastní průvodce pro šablonu, která je přidružená k vašemu rozšíření.

Následující postupy popisují, jak přidat položky do souboru .vsixmanifest pro každou z těchto položek.

Zahrnutí sestavení rozšíření

  1. V projektu VSIX otevřete místní nabídku pro soubor source.extension.vsixmanifest a pak zvolte Otevřít.

    Soubor se otevře v návrháři.

  2. Na kartě Assety v editoru zvolte tlačítko Nový.

    Otevře se dialogové okno Přidat nový prostředek.

  3. V seznamu Typ zvolte Microsoft.VisualStudio.MefComponent.

  4. V seznamu Zdroj proveďte jeden z následujících kroků:

    • Pokud je sestavení rozšíření sestaveno z projektu, který je ve stejném řešení jako projekt VSIX, zvolte Projekt v aktuálním řešení. V Project seznamu vyberte název projektu.

    • Pokud je sestavení rozšíření zahrnuto jako soubor v projektu, zvolte Soubor v systému souborů. V seznamu Cesta zadejte úplnou cestu k souboru sestavení rozšíření nebo pomocí tlačítka Procházet vyhledejte a zvolte soubor sestavení.

  5. Zvolte tlačítko OK.

Zahrnutí sestavení SharePoint příkazu

  1. V projektu VSIX otevřete místní nabídku pro soubor source.extension.vsixmanifest a pak zvolte tlačítko Otevřít.

    Soubor se otevře v návrháři.

  2. V části Editoru Assets (Prostředky) zvolte tlačítko New (Nový).

    Otevře se dialogové okno Přidat nový prostředek.

  3. Do pole Typ zadejte SharePoint. Commands.v4.

  4. V seznamu Zdroj proveďte jeden z následujících kroků:

    • Pokud je sestavení příkazu sestaveno z projektu, který je ve stejném řešení jako projekt VSIX, zvolte Projekt v aktuálním řešení. V Project seznamu vyberte název projektu.

    • Pokud je sestavení příkazu zahrnuto jako soubor v projektu, zvolte Soubor v systému souborů. V seznamu Cesta zadejte úplnou cestu k souboru sestavení rozšíření nebo pomocí tlačítka Procházet vyhledejte a zvolte soubor sestavení.

  5. Zvolte tlačítko OK.

Zahrnutí šablony, kterou vytvoříte

  1. V projektu VSIX otevřete místní nabídku pro soubor source.extension.vsixmanifest a pak zvolte tlačítko Otevřít.

    Soubor se otevře v návrháři.

  2. V části Editoru Assets (Prostředky) zvolte tlačítko New (Nový).

    Otevře se dialogové okno Přidat nový prostředek.

  3. V seznamu Typ zvolte Microsoft.VisualStudio.ProjectTemplate nebo Microsoft.VisualStudio.ItemTemplate.

  4. V seznamu Zdroj zvolte Projekt v aktuálním řešení.

  5. V Project vyberte název projektu a pak zvolte tlačítko OK.

  6. V Průzkumník řešení otevřete místní nabídku pro projekt šablony Project nebo šablony položky a pak zvolte Uvolnit Project.

  7. Znovu otevřete místní nabídku pro uzel projektu a pak zvolte Upravit Název_projektu_šablony .csproj nebo Upravit název_projektu_vaší_šablony .vbproj.

  8. V souboru VSTemplate projektu vyhledejte následující prvek.

    <VSTemplate Include="YourTemplateName.vstemplate">
    
  9. Nahraďte tento element následujícím kódem XML.

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

    Element určuje další složky v cestě, pod kterou je šablona projektu OutputSubPath vytvořena při sestavování projektu. Složky uvedené tady zajišťují, že šablona položky bude dostupná jenom v případě, že zákazníci otevřou dialogové okno Přidat nový Project, rozbalí uzel SharePoint a pak zvolí uzel 2010.

  10. Uložte soubor a zavřete ho.

  11. V Průzkumník řešení otevřete místní nabídku pro projekt šablona šablony Project nebo šablony položky a pak zvolte Znovu načíst Project.

Zahrnutí šablony, kterou vytvoříte ručně

  1. V projektu VSIX přidejte do projektu novou složku, která bude obsahovat šablonu.

  2. V této nové složce vytvořte následující podsložky a pak přidejte soubor šablony (.zip) do složky ID národního prostředí.

    YourTemplateFolder

    SharePoint

    SharePoint14

    ID národního prostředí

    YourTemplateName –.zip

    Pokud máte například šablonu položky s názvem ContosoCustomAction.zip, která podporuje národní prostředí angličtiny (USA), může být úplná cestaItemTemplates\SharePoint\SharePoint14\1033\ContosoCustomAction.zip.

  3. V Průzkumník řešení vyberte soubor šablony (YourTemplateName.zip).

  4. V okně Vlastnosti nastavte vlastnost Akce sestavení na Obsah.

  5. Otevřete místní nabídku pro soubor source.extension.vsixmanifest a pak zvolte Otevřít.

    Soubor se otevře v návrháři.

  6. V části Editoru Assets (Prostředky) zvolte tlačítko New (Nový).

    Otevře se dialogové okno Přidat nový prostředek.

  7. V seznamu Typ zvolte Microsoft.VisualStudio.ItemTemplate nebo Microsoft.VisualStudio.ProjectTemplate.

  8. V seznamu Zdroj zvolte Soubor v systému souborů.

  9. V poli cesta zadejte úplnou cestu k sestavení (například ItemTemplates\SharePoint\SharePoint14\1033\ContosoCustomAction.zip, nebo použijte tlačítko Procházet pro vyhledání a výběr sestavení a pak klikněte na tlačítko OK .

Zahrnutí průvodce pro šablonu projektu nebo šablonu položky

  1. V projektu VSIX otevřete místní nabídku pro soubor source. extension. vsixmanifest a pak zvolte možnost otevřít.

    Soubor se otevře v návrháři.

  2. V části assets v Editoru klikněte na tlačítko Nový .

    Otevře se dialogové okno Přidat nový prostředek .

  3. V seznamu typ vyberte možnost Microsoft. VisualStudio. Assembly.

  4. V seznamu zdroj proveďte jeden z následujících kroků:

    • Pokud je sestavení průvodce sestaveno z projektu, který je ve stejném řešení jako projekt VSIX, vyberte projekt v aktuálním řešení. v seznamu Project vyberte název projektu.

    • Pokud je sestavení průvodce zahrnuto jako soubor v projektu, vyberte soubor v systému souborů. Do pole cesta zadejte úplnou cestu k souboru sestavení nebo použijte tlačítko Procházet a vyhledejte a vyberte sestavení.

  5. Klikněte na tlačítko OK .

v následující tabulce jsou uvedeny návody, které ukazují, jak použít projekt VSIX k nasazení různých typů rozšíření SharePoint nástrojů.

Typ rozšíření Související návody
Rozšíření, které obsahuje pouze sestavení rozšíření návod: rozšiřování typu položky projektu SharePoint

návod: vytvoření rozšíření SharePoint Project

návod: volání do objektového modelu klienta SharePoint v rozšíření Průzkumník serveru
rozšíření, které zahrnuje příkazy SharePoint návod: vytvoření vlastního kroku nasazení pro projekty SharePoint

Návod: roztažení Průzkumník serveru pro zobrazení webových částí

Návod: vytvoření položky projektu sloupce webu pomocí šablony projektu, část 2
rozšíření, které obsahuje šablonu Visual Studio Návod: Vytvoření vlastní položky projektu akce pomocí šablony položky, část 1

Návod: vytvoření položky projektu sloupce webu pomocí šablony projektu, část 1
Rozšíření, které obsahuje Průvodce šablonou Návod: Vytvoření vlastní položky projektu akce pomocí šablony položky, část 2

Návod: vytvoření položky projektu sloupce webu pomocí šablony projektu, část 2

Vytvořit balíčky VSIX ručně

pokud chcete balíček VSIX pro rozšíření SharePointch nástrojů vytvořit ručně, proveďte následující kroky:

  1. Vytvořte soubor Extension. vsixmanifest a soubor .xml [Content_Types] v nové složce. Další informace naleznete v tématu anatomie balíčku VSIX.

  2. v průzkumníku Windows klikněte pravým tlačítkem na složku, která obsahuje dva soubory XML, klikněte na odeslat do a pak klikněte na komprimovaná složka (zip). Přejmenujte výsledný .zip soubor na filename. vsix, kde filename je název redistribuovatelného souboru, který nainstaluje balíček.

  3. Přidejte sestavení rozšíření do balíčku VSIX. pokud vaše rozšíření obsahuje příkaz SharePoint, přidejte také sestavení, které implementuje příkaz SharePoint, do balíčku VSIX.

  4. Upravte soubor Extension. vsixmanifest:

    • Do Microsoft.VisualStudio.MefComponent prvku přidejte element Assets a pak nastavte hodnotu nového prvku na relativní cestu sestavení, které implementuje vaše rozšíření v balíčku VSIX. Další informace naleznete v tématu MefComponent element (VSX Schema).

    • pokud vaše rozšíření obsahuje příkaz SharePoint, který volá do objektového modelu serveru pro SharePoint, přidejte Microsoft.VisualStudio.Assembly element pod Assets element. nastavte hodnotu nového prvku na relativní cestu sestavení, které implementuje příkaz SharePoint v balíčku VSIX. Další informace naleznete v tématu Asset – element (schéma VSX).

    • Pokud vaše rozšíření obsahuje šablonu projektu nebo šablonu položky, přidejte ProjectTemplate prvek nebo do ItemTemplate Assets prvku. Nastavte hodnotu nového prvku na relativní cestu ke složce, která obsahuje šablonu v balíčku VSIX. Další informace naleznete v tématu ProjectTemplate Element (VSX Schema) a ItemTemplate Element (schéma VSX).

    • Pokud vaše rozšíření obsahuje vlastního průvodce pro šablonu projektu nebo šablonu položky, přidejte Assembly prvek pod Assets element. Nastavte hodnotu nového prvku na relativní cestu sestavení v balíčku VSIX a pak nastavte AssemblyName atribut na úplný název sestavení (včetně verze, jazykové verze a tokenu veřejného klíče). Další informace naleznete v tématu dependency element (VSX Schema).

Příklad

následující příklad ukazuje obsah souboru extension. vsixmanifest pro rozšíření SharePoint tools. Rozšíření je implementováno v sestavení s názvem Contoso.ProjectExtension.dll. přípona obsahuje sestavení příkaz SharePoint, které má název Contoso.ExtensionCommands.dll a šablonu položky ve složce s názvem itemtemplates v balíčku VSIX. V tomto příkladu se předpokládá, že obě sestavení jsou ve stejné složce jako soubor Extension. vsixmanifest v balíčku VSIX.

<PackageManifest Version="2.0.0" xmlns="http://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>

Viz také