Zabalení a nasazení vlastních rozšíření My (Visual Basic)

Článek
03/12/2024

Visual Basic nabízí snadný způsob, jak nasadit vlastní My rozšíření oboru názvů pomocí šablon sady Visual Studio. Pokud vytváříte šablonu projektu, pro kterou jsou vaše My rozšíření nedílnou součástí nového typu projektu, stačí při exportu šablony do projektu zahrnout vlastní My kód rozšíření. Další informace o exportu šablon projektů naleznete v tématu Postupy: Vytváření šablon projektů.

Pokud je vaše vlastní My přípona v jednom souboru kódu, můžete soubor exportovat jako šablonu položky, kterou uživatelé můžou přidat do libovolného typu projektu jazyka Visual Basic. Šablonu položky pak můžete přizpůsobit a povolit tak další možnosti a chování vlastního My rozšíření v projektu jazyka Visual Basic. Mezi tyto funkce patří:

Umožňuje uživatelům spravovat vlastní My rozšíření ze stránky Moje rozšíření v Návrháři projektů jazyka Visual Basic.
Automatické přidání vlastního My rozšíření při přidání odkazu na zadané sestavení do projektu.
My Skrytí šablony položky rozšíření v dialogovém okně Přidat položku tak, aby nebyla zahrnuta do seznamu položek projektu.

Toto téma popisuje, jak zabalit vlastní My rozšíření jako skrytou šablonu položky, kterou lze spravovat ze stránky Moje rozšíření návrháře projektu jazyka Visual Basic. Vlastní My rozšíření lze také přidat automaticky při přidání odkazu na zadané sestavení do projektu.

Vytvoření rozšíření Oboru názvů My

Prvním krokem při vytváření balíčku pro nasazení pro vlastní My rozšíření je vytvoření rozšíření jako jediného souboru kódu. Podrobnosti a pokyny k vytvoření vlastního My rozšíření najdete v tématu Rozšíření oboru názvů v jazyce Visual Basic.

Export rozšíření Můj obor názvů jako šablona položky

Jakmile budete mít soubor kódu, který obsahuje My příponu oboru názvů, můžete soubor kódu exportovat jako šablonu položky sady Visual Studio. Pokyny k exportu souboru jako šablony položky sady Visual Studio najdete v tématu Postupy: Vytvoření šablon položek.

Poznámka:

Pokud má My vaše rozšíření oboru názvů závislost na konkrétním sestavení, můžete šablonu položky přizpůsobit tak, aby při přidání odkazu na toto sestavení automaticky nainstalovala My rozšíření oboru názvů. V důsledku toho budete chtít tento odkaz na sestavení vyloučit při exportu souboru kódu jako šablony položky sady Visual Studio.

Přizpůsobení šablony položky

Šablonu položky můžete povolit tak, aby byla spravována ze stránky Moje rozšíření návrháře projektů jazyka Visual Basic. Můžete také povolit automatické přidání šablony položky při přidání odkazu na zadané sestavení do projektu. Pokud chcete tato přizpůsobení povolit, přidáte do šablony nový soubor, který se nazývá CustomData file, a pak do souboru .vstemplate přidáte nový element do XML.

Přidání souboru CustomData

CustomData soubor je textový soubor, který má příponu názvu souboru . CustomData (název souboru může být nastaven na libovolnou hodnotu smysluplnou pro vaši šablonu) a která obsahuje XML. Xml v souboru CustomData dává visual basicu pokyn, aby zahrnoval vaše My rozšíření, když uživatelé používají stránku Moje rozšíření návrháře projektu jazyka Visual Basic. Volitelně můžete přidat <AssemblyFullName> atribut do xml souboru CustomData. To dává jazyku Visual Basic pokyn, aby při přidání odkazu na konkrétní sestavení do projektu automaticky nainstaloval vlastní My rozšíření. K vytvoření souboru CustomData můžete použít libovolný textový editor nebo editor XML a pak ho přidat do komprimované složky šablony položky (soubor .zip).

Například následující XML ukazuje obsah souboru CustomData, který přidá položku šablony do složky Moje rozšíření projektu jazyka Visual Basic, když se do projektu přidá odkaz na sestavení Microsoft.VisualBasic.PowerPacks.Vs.dll.

<VBMyExtensionTemplate
    ID="Microsoft.VisualBasic.Samples.MyExtensions.MyPrinterInfo"
    Version="1.0.0.0"
    AssemblyFullName="Microsoft.VisualBasic.PowerPacks.vs"
/>

Soubor CustomData obsahuje <VBMyExtensionTemplate> prvek, který má atributy uvedené v následující tabulce.

Atribut	Popis
`ID`	Požadováno. Jedinečný identifikátor rozšíření. Pokud už rozšíření s tímto ID bylo přidáno do projektu, nezobrazí se uživateli výzva k jeho opětovnému přidání.
`Version`	Povinný: Číslo verze šablony položky.
`AssemblyFullName`	Nepovinné. Název sestavení. Při přidání odkazu na toto sestavení do projektu se uživateli zobrazí výzva k přidání `My` rozšíření z této šablony položky.

Přidání elementu <CustomDataSignature> do souboru .vstemplate

Chcete-li identifikovat šablonu položky sady Visual Studio jako příponu My oboru názvů, musíte také upravit soubor .vstemplate pro šablonu položky. Do elementu <CustomDataSignature><TemplateData> je nutné přidat prvek. Prvek <CustomDataSignature> musí obsahovat text Microsoft.VisualBasic.MyExtension, jak je znázorněno v následujícím příkladu.

<CustomDataSignature>Microsoft.VisualBasic.MyExtension</CustomDataSignature>

Soubory v komprimované složce (.zip soubor) nelze upravovat přímo. Musíte zkopírovat soubor .vstemplate z komprimované složky, upravit ho a pak nahradit soubor .vstemplate v komprimované složce aktualizovanou kopií.

Následující příklad ukazuje obsah souboru .vstemplate, který má přidaný <CustomDataSignature> prvek.

<VSTemplate Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vstemplate/2005" Type="Item">
  <TemplateData>
    <DefaultName>MyCustomExtensionModule.vb</DefaultName>
    <Name>MyPrinterInfo</Name>
    <Description>Custom My Extensions Item Template</Description>
    <ProjectType>VisualBasic</ProjectType>
    <SortOrder>10</SortOrder>
    <Icon>__TemplateIcon.ico</Icon>
    <CustomDataSignature      >Microsoft.VisualBasic.MyExtension</CustomDataSignature>
  </TemplateData>
  <TemplateContent>
    <References />
    <ProjectItem SubType="Code"
                 TargetFileName="$fileinputname$.vb"
                 ReplaceParameters="true"
     >MyCustomExtensionModule.vb</ProjectItem>
  </TemplateContent>
</VSTemplate>

Instalace šablony

Pokud chcete šablonu nainstalovat, můžete komprimovanou složku (.zip soubor) zkopírovat do složky šablon položek jazyka Visual Basic. Ve výchozím nastavení se šablony položek uživatelů nacházejí ve složce %USERPROFILE%\Documents\Visual Studio <Version>\Templates\ItemTemplates\Visual Basic. Případně můžete šablonu publikovat jako soubor Instalační program pro Visual Studio (.vsi).

Sdílet prostřednictvím