Nasazování rozšíření pro nástroje služby SharePoint v aplikaci Visual Studio
Chcete-li nasadit rozšíření nástrojů SharePoint, vytvořte balíček Visual Studio rozšíření (VSIX), který obsahuje sestavení rozšíření a všechny další soubory, které chcete distribuovat s rozšířením. VSIX balíček je komprimovaný soubor, který následuje standardní OPC (Open Packaging Convention). VSIX balíčky mají příponu .vsix.
Po vytvoření balíčku VSIX mohou ostatní uživatelé spouštět soubor .vsix k instalaci rozšíření. Pokud uživatel nainstaluje vaše rozšíření, všechny soubory jsou nainstalovány do složky %UserProfile%\AppData\Local\Microsoft\VisualStudio\10.0\Extensions. Zavedení rozšíření lze uložit balíček VSIX Visual Studio Galerie webu, nebo můžete distribuovat zákazníkům jinými prostředky, jako je například hostitelem balíčku na sdílené síťové složky nebo na jiný webový server.
Další informace o vytváření balíčků VSIX a jejich zavedení Visual Studio Galerie, viz Package Deployment.
Můžete vytvořit balíček VSIX pomocí šablony Projektu VSIX v aplikaci Visual Studio nebo můžete vytvořit VSIX balíček ručně.
Použití VSIX projektů k vytvoření balíčků VSIX
Můžete použít šablonu Projekt VSIX poskytovanou Visual Studio 2010 SDK pro vytvoření balíčků VSIX pro rozšíření nástrojů SharePoint. Během vytváření balíčku VSIX ručně pomocí projektu VSIX poskytuje několik výhod:
Visual Studio automaticky generuje VSIX balíček, když sestavuje projekt. Úlohy jako například přidávání souborů nasazení balíčku a vytváření souboru [Content_Types].xml pro balíček jsou pro vás hotovy.
Můžete nakonfigurovat VSIX projekt VSIX balíčku zahrnout sestavení výstupní rozšíření projektu a další soubory, například šablony projektů a položku šablony.
Další informace o použití projektu VSIX naleznete v tématu Walkthrough: How to Publish a Visual Studio Extension.
Uspořádání vašich projektů
Standardně VSIX projekty generovat pouze VSIX balíčky sestavení není. Proto obvykle není implementaci rozšíření nástroje SharePoint v projektu VSIX. Obecně pracovat alespoň dva projekty:
Projekt VSIX.
Projekt knihovny třídy, který implementuje vaše rozšíření.
Můžete také pracovat s další projekty pro určité typy rozšíření:
Projekt knihovny třídy implementující všechny SharePoint příkazy používané rozšířením. Názorný postup ukazuje tento scénář, viz Podrobné pokyny: Rozšíření Průzkumníka serveru pro zobrazení webových částí.
Položku šablony nebo projektu projekt, pokud vaše rozšíření definuje nový typ položky projektu SharePoint vytvoří položku šablony nebo šablona projektu. Názorný postup ukazuje tento scénář, viz Podrobné pokyny: Vytvoření položky projektu vlastní akce položku šablony, část 1.
Projekt knihovny třídy, který implementuje vlastní průvodce šablonu položky nebo šablona projektu obsahuje šablony v rozšíření. Názorný postup ukazuje tento scénář, viz Podrobné pokyny: Vytvoření položky projektu vlastní akce položku šablony, část 2.
Pokud zahrnete všechny projekty ve stejném řešení sady Visual Studio, můžete upravit soubor source.extension.vsixmanifest v projektu VSIX pro zahrnutí výstupu sestavení projektů knihoven tříd.
Úpravy VSIX Manifest
Musíte upravit soubor source.extension.vsixmanifest v VSIX projektu zahrnout položky pro všechny položky, které chcete zahrnout do rozšíření. Při úpravách souboru source.extension.vsixmanifest Visual Studio otevře soubor v návrháři, který poskytuje uživatelské rozhraní pro úpravy v souboru XML. Další informace naleznete v tématu VSIX Manifest Designer.
Musíte přidat položky do souboru source.extension.vsixmanifest pro následující položky:
Sestavení rozšíření.
Sestavení, která implementuje veškeré SharePoint příkazy použité rozšířením.
Šablony aplikace project nebo položku šablony, které jsou spojeny s vaší rozšíření.
Průvodce vlastní šablony spojené s vaší rozšíření.
Následující postupy popisují způsob přidání položky do souboru .vsixmanifest pro každou z těchto položek.
Chcete-li zahrnout rozšíření sestavení
V projektu VSIX poklepejte na soubor source.extension.vsixmanifest soubor otevřít v návrháři.
V oddílu Obsah editoru klikněte na tlačítko Přidání obsahu.
V dialogovém okně Přidání obsahu v seznamu Volba typu obsahu zvolte Komponenta MEF.
Pod Vybrat zdroj, proveďte jeden z následujících kroků:
Je-li rozšíření sestavení vytvořeno z projektu, který je ve stejném řešení jako projekt VSIX, klikněte na přepínač Projekt a zvolte název projektu v seznamu vedle něho.
Pokud je sestavení rozšíření zahrnuto jako soubor ve vašem projektu, klikněte na přepínač Soubor v projektu a zvolte sestavení v seznamu vedle něho.
Je-li sestavení rozšíření v některém jiném umístění, klikněte na přepínač Soubor a potom použijte dialogové okno Zvolit soubor pro nalezení a volbu sestavení.
Klepněte na tlačítko OK.
Chcete-li zahrnout sestavení příkazu SharePoint
V projektu VSIX poklepejte na soubor source.extension.vsixmanifest soubor otevřít v návrháři.
V oddílu Obsah editoru klikněte na tlačítko Přidání obsahu.
V dialogovém okně Přidání obsahu v seznamu Zvolit typ obsahu zvolte Vlastní typ rozšíření.
V textovém poli Typ napište SharePoint.Commands.v4. Tato hodnota je požadována pro všechny sestavení, které obsahují příkazy serveru SharePoint.
Pod Vybrat zdroj, proveďte jeden z následujících kroků:
Je-li příkaz sestavení vytvořen z projektu, který je ve stejném řešení jako projekt VSIX, klikněte na přepínač Projekt a zvolte název příkazu projektu v seznamu vedle něho.
Pokud je sestavení příkazu zahrnuto jako soubor ve vašem projektu, klikněte na přepínač Soubor v projektu a zvolte sestavení v seznamu vedle něho.
Je-li sestavení příkazu v některém jiném umístění, klikněte na přepínač Soubor a potom použijte dialogové okno Zvolit soubor pro nalezení a volbu sestavení.
Klikněte na tlačítko OK.
Zahrnout šablony, kterou vytvoříte pomocí šablony projektu nebo položky Projekt Visual Studio SDK
V projektu VSIX poklepejte na soubor source.extension.vsixmanifest soubor otevřít v návrháři.
V oddílu Obsah editoru klikněte na tlačítko Přidání obsahu.
V Přidat obsah v dialogovém okně pole Vyberte typ obsahu seznamu vyberte Šablona projektu nebo Položku šablony.
Pod Vybrat zdroj, klepněte projekt rádiové tlačítko a vyberte seznamu název projektu.
Klikněte na tlačítko OK.
V Aplikaci Solution Explorer, klepněte pravým tlačítkem uzel šablony projektu nebo položky projektu a na Uvolnění projektu.
Klepněte pravým tlačítkem uzlu projektu a klepněte na tlačítko Upravit YourTemplateProjectNameCSPROJ nebo Upravit YourTemplateProjectNameVBPROJ.
Najděte následující prvek VSTemplate v souboru projektu.
<VSTemplate Include="YourTemplateName.vstemplate">
Nahraďte tento prvek VSTemplate s následujícím XML.
<VSTemplate Include="YourTemplateName.vstemplate"> <OutputSubPath>SharePoint\SharePoint14</OutputSubPath> </VSTemplate>
OutputSubPath Prvku určuje další složky v cestě, pod kterým je vytvořena šablona projektu při vytváření projektu. Složky zadané zde zajistit, že šablony zboží bude k dispozici pouze pokud na zákazníky 2010 uzlu SharePoint uzlu Přidat nový projekt dialogové okno.
Soubor uložte a zavřete.
V Aplikaci Solution Explorer, projekt šablony projektu nebo položky klepněte pravým tlačítkem myši a klepněte na tlačítko Reload Project.
Zahrnout šablony, který vytvoříte ručně
V projektu VSIX přidejte novou složku do projektu, která bude obsahovat šablonu.
V této nové složce vytvořte následující podsložky a pak přidejte soubor šablony (.zip) do složky Locale ID.
YourTemplateFolder
SharePoint
[4_3_sharepoint]
Locale ID
YourTemplateNameZIP
Máte-li například šablonu položky s názvem ContosoCustomAction.zip, která podporuje národní prostředí Angličtina (Spojené státy), úplná cesta může být ItemTemplates\SharePoint\SharePoint14\1033\ContosoCustomAction.zip.
V Průzkumníku řešení klikněte na soubor šablony (YourTemplateName.zip).
V okně Vlastnosti nastavte vlastnost Akce Sestavení na hodnotu Content.
Poklepejte na soubor source.extension.vsixmanifest soubor otevřít v návrháři.
V oddílu Obsah editoru klikněte na tlačítko Přidání obsahu.
V dialogovém okně Přidání obsahu v seznamu Zvolit typ obsahu zvolte Šablonu položky nebo Šablonu projektu.
Pod Vybrat zdroj, klepněte soubor projektu rádiové tlačítko a vyberte v rozevíracím seznamu vedle úplná cesta k šabloně. Například ItemTemplates\SharePoint\SharePoint14\1033\ContosoCustomAction.zip.
Klikněte na tlačítko OK.
Zahrnout průvodce šablonu projektu nebo šablony položky
V projektu VSIX poklepejte na soubor source.extension.vsixmanifest soubor otevřít v návrháři.
V oddílu Obsah editoru klikněte na tlačítko Přidání obsahu.
V dialogovém okně Přidat obsah v seznamu Volba typu obsahu zvolte Průvodce šablonou.
Pod Vybrat zdroj, proveďte jeden z následujících kroků:
Sestavení Průvodce je sestaven z projektu, který je ve stejné řešení jako VSIX projekt, klepněte na tlačítko projekt rádiové tlačítko a vyberte seznamu název projektu.
Sestavení Průvodce je součástí souboru projektu, klepněte na tlačítko soubor projektu rádiové tlačítko a vyberte v rozevíracím seznamu vedle sestavení.
Sestavení Průvodce je umístěn v jiné umístění, klepněte na tlačítko soubor rádiové tlačítko a potom Vybrat soubor dialogovém okně vyhledejte a vyberte sestavení.
Klikněte na tlačítko OK.
Související návody
Následující tabulka uvádí návody, které ukazují, jak nasadit různé typy rozšíření nástroje služby SharePoint pomocí VSIX projektu.
Typ rozšíření |
Související kurzy |
---|---|
Rozšíření, které obsahuje pouze sestavení rozšíření |
Podrobné pokyny: Rozšiřování typu položky projektu SharePoint Podrobné pokyny: Vytvoření přípony projektu služby SharePoint |
Rozšíření služby SharePoint příkazy |
Podrobné pokyny: Vytvoření vlastního kroku nasazení pro SharePoint projekty Podrobné pokyny: Rozšíření Průzkumníka serveru pro zobrazení webových částí Podrobné pokyny: Vytvoření položky projektu sloupec webu pomocí šablony projektu, část 2 |
Rozšíření obsahující šablonu aplikace Visual Studio |
Podrobné pokyny: Vytvoření položky projektu vlastní akce položku šablony, část 1 Podrobné pokyny: Vytvoření položky projektu sloupec webu pomocí šablony projektu, část 1 |
Rozšíření, která zahrnuje Průvodce šablonou |
Podrobné pokyny: Vytvoření položky projektu vlastní akce položku šablony, část 2 Podrobné pokyny: Vytvoření položky projektu sloupec webu pomocí šablony projektu, část 2 |
Ruční vytváření balíčků VSIX
Pokud chcete ručně vytvořit balíček VSIX pro rozšíření nástrojů aplikace SharePoint, proveďte následující kroky:
Vytvořte soubor extension.vsixmanifest, [Content_Types].xml a soubor balíčku VSIX (.vsix). Další informace naleznete v tématu Anatomy of a VSIX Package a How to: Manually Package an Extension (VSIX Deployment).
Přidejte vaše sestavení balíčku VSIX. Pokud vaše rozšíření obsahuje příkaz SharePoint, přidejte také sestavení, které implementuje příkaz SharePoint pro VSIX balíček.
Upravte soubor extension.vsixmanifest file:
Přidejte prvek Content do prvku MefComponent. Relativní cesta sestavení, která implementuje vaše rozšíření VSIX balíčku nastavte hodnotu prvku. Další informace naleznete v tématu MEFComponent Element (VSX Schema).
Pokud vaše rozšíření obsahuje příkaz SharePoint, který volá do modelu objektu serveru SharePoint, přidejte nový prvek CustomExtension pod prvek Content. Relativní cesta sestavení, která implementuje balíček VSIX SharePoint příkaz nastavit hodnotu prvku a nastavit Type na hodnotu atributu SharePoint.Commands.v4. Další informace naleznete v tématu CustomExtension Element (VSX Schema).
Pokud vaše rozšíření obsahuje šablonu projektu nebo šablonu položky, přidat nový ProjectTemplate nebo ItemTemplate element pod Content prvku. Nastavte hodnotu prvku relativní cestu složky obsahující šablonu v balíčku VSIX. Další informace naleznete v tématu ProjectTemplate Element (VSX Schema) a ItemTemplate Element (VSX Schema).
Pokud vaše rozšíření obsahuje vlastní průvodce šablonu projektu nebo šablony položky, přidat nový Assembly element pod Content prvku. Nastavte hodnotu prvku relativní cesta sestavení balíčku VSIX a nastavte AssemblyName atribut název sestavení úplné (včetně verze, kultury a token veřejného klíče). Další informace naleznete v tématu Assembly Element (VSX Schema).
Příklad
Následující příklad zobrazuje obsah souboru extension.vsixmanifest pro rozšíření nástroje služby SharePoint. Rozšíření je implementován v sestavení s názvem Contoso.ProjectExtension.dll. Rozšíření zahrnuje subsystému SharePoint s názvem Contoso.ExtensionCommands.dll a šablonu položky ve složce s názvem ItemTemplates v VSIX obalu. Tento příklad předpokládá, že jsou obě sestavení ve stejné složce jako soubor extension.vsixmanifest v balíčku VSIX.
<?xml version="1.0" encoding="utf-8"?>
<Vsix xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
Version="1.0.0" xmlns="https://schemas.microsoft.com/developer/vsx-schema/2010">
<Identifier Id="CustomActionProjectItem.Contoso.b1d75407-01bd-459d-9d04-d12e9113af49">
<Name>Custom Action Project Item</Name>
<Author>Contoso</Author>
<Version>1.0</Version>
<Description xml:space="preserve">A SharePoint project item that represents a custom action.</Description>
<Locale>1033</Locale>
<SupportedProducts>
<VisualStudio Version="10.0">
<Edition>Pro</Edition>
</VisualStudio>
</SupportedProducts>
<SupportedFrameworkRuntimeEdition MinVersion="4.0" MaxVersion="4.0" />
</Identifier>
<References />
<Content>
<MefComponent>Contoso.ProjectExtension.dll</MefComponent>
<CustomExtension Type="SharePoint.Commands.v4">Contoso.ExtensionCommands.dll</CustomExtension>
<ItemTemplate>ItemTemplates</ItemTemplate>
</Content>
</Vsix>
Viz také
Koncepty
Rozšíření systému projektů služby SharePoint
Volání do objektových modelů služby SharePoint
Další zdroje
Rozšíření uzlu připojení služby SharePoint v aplikaci Server Explorer
Ladění rozšíření pro nástroje služby SharePoint v aplikaci Visual Studio