Paketera och distribuera anpassade Mina tillägg (Visual Basic)

Artikel
06/08/2023

Visual Basic är ett enkelt sätt för dig att distribuera dina anpassade My namnområdestillägg med hjälp av Visual Studio-mallar. Om du skapar en projektmall som dina My tillägg är en integrerad del av den nya projekttypen för, kan du bara inkludera din anpassade My tilläggskod med projektet när du exporterar mallen. Mer information om hur du exporterar projektmallar finns i Så här skapar du projektmallar.

Om ditt anpassade My tillägg finns i en enda kodfil kan du exportera filen som en objektmall som användarna kan lägga till i valfri typ av Visual Basic-projekt. Du kan sedan anpassa objektmallen för att aktivera ytterligare funktioner och beteenden för ditt anpassade My tillägg i ett Visual Basic-projekt. Dessa funktioner omfattar följande:

Tillåter användare att hantera ditt anpassade My tillägg från sidan Mina tillägg i Visual Basic Project Designer.
Lägg automatiskt till ditt anpassade My tillägg när en referens till en angiven sammansättning läggs till i ett projekt.
Dölj mallen My för tilläggsobjekt i dialogrutan Lägg till objekt så att den inte tas med i listan över projektobjekt.

I det här avsnittet beskrivs hur du paketerar ett anpassat My tillägg som en dold objektmall som kan hanteras från sidan Mina tillägg i Visual Basic Project Designer. Det anpassade My tillägget kan också läggas till automatiskt när en referens till en angiven sammansättning läggs till i ett projekt.

Skapa ett tillägg för Mitt namnområde

Det första steget i att skapa ett distributionspaket för ett anpassat My tillägg är att skapa tillägget som en enda kodfil. Mer information och vägledning om hur du skapar ett anpassat My tillägg finns i Utöka mitt namnområde i Visual Basic.

Exportera ett mitt namnområdestillägg som en objektmall

När du har en kodfil som innehåller ditt My namnområdestillägg kan du exportera kodfilen som en Visual Studio-objektmall. Anvisningar om hur du exporterar en fil som en Visual Studio-objektmall finns i Så här skapar du objektmallar.

Kommentar

Om namnområdestillägget My har ett beroende av en viss sammansättning kan du anpassa objektmallen så att namnområdestillägget My installeras automatiskt när en referens till sammansättningen läggs till. Därför vill du exkludera sammansättningsreferensen när du exporterar kodfilen som en Visual Studio-objektmall.

Anpassa objektmallen

Du kan aktivera att objektmallen hanteras från sidan Mina tillägg i Visual Basic Project Designer. Du kan också aktivera att objektmallen läggs till automatiskt när en referens till en angiven sammansättning läggs till i ett projekt. Om du vill aktivera de här anpassningarna lägger du till en ny fil, kallad CustomData-filen, i mallen och lägger sedan till ett nytt element i XML-filen i .vstemplate-filen.

Lägg till CustomData-filen

CustomData-filen är en textfil som har filnamnstillägget . CustomData (filnamnet kan anges till valfritt värde som är meningsfullt för mallen) och som innehåller XML. XML-koden i CustomData-filen instruerar Visual Basic att inkludera ditt My tillägg när användarna använder sidan Mina tillägg i Visual Basic Project Designer. Du kan också lägga till <AssemblyFullName> attributet i din CustomData-fil-XML. Detta instruerar Visual Basic att automatiskt installera ditt anpassade My tillägg när en referens till en viss sammansättning läggs till i projektet. Du kan använda valfri textredigerare eller XML-redigerare för att skapa CustomData-filen och sedan lägga till den i objektmallens komprimerade mapp (.zip fil).

Följande XML visar till exempel innehållet i en CustomData-fil som lägger till mallobjektet i mappen Mina tillägg i ett Visual Basic-projekt när en referens till Microsoft.VisualBasic.PowerPacks.Vs.dll sammansättning läggs till i projektet.

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

CustomData-filen innehåller ett <VBMyExtensionTemplate> element som har attribut enligt listan i följande tabell.

Attribut	beskrivning
`ID`	Obligatoriskt. En unik identifierare för tillägget. Om tillägget som har det här ID:t redan har lagts till i projektet uppmanas användaren inte att lägga till det igen.
`Version`	Obligatoriska. Ett versionsnummer för objektmallen.
`AssemblyFullName`	Valfritt. Ett sammansättningsnamn. När en referens till den här sammansättningen läggs till i projektet uppmanas användaren att lägga `My` till tillägget från den här objektmallen.

Lägg till elementet <CustomDataSignature> i .vstemplate-filen

Om du vill identifiera Visual Studio-objektmallen som ett My namnområdestillägg måste du också ändra .vstemplate-filen för objektmallen. Du måste lägga till ett <CustomDataSignature> element i elementet <TemplateData> . Elementet <CustomDataSignature> måste innehålla texten Microsoft.VisualBasic.MyExtension, enligt följande exempel.

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

Du kan inte ändra filer i en komprimerad mapp (.zip fil) direkt. Du måste kopiera .vstemplate-filen från den komprimerade mappen, ändra den och sedan ersätta .vstemplate-filen i den komprimerade mappen med den uppdaterade kopian.

I följande exempel visas innehållet i en .vstemplate-fil där elementet har lagts <CustomDataSignature> till.

<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>

Installera mallen

Om du vill installera mallen kan du kopiera den komprimerade mappen (.zip fil) till mappen Visual Basic-objektmallar. Som standard finns mallar för användarobjekt i %USERPROFILE%\Documents\Visual Studio <Version>\Templates\ItemTemplates\Visual Basic. Du kan också publicera mallen som en Visual Studio Installer-fil (.vsi).

Dela via