Aangepaste Mijn-extensies verpakken en implementeren (Visual Basic)

Artikel
03/12/2024

Visual Basic biedt een eenvoudige manier om uw aangepaste My naamruimteextensies te implementeren met behulp van Visual Studio-sjablonen. Als u een projectsjabloon maakt waarvoor uw My extensies een integraal onderdeel zijn van het nieuwe projecttype, kunt u uw aangepaste My extensiecode gewoon toevoegen aan het project wanneer u de sjabloon exporteert. Zie Projectsjablonen maken voor meer informatie over het exporteren van projectsjablonen.

Als uw aangepaste My extensie zich in één codebestand bevindt, kunt u het bestand exporteren als een itemsjabloon die gebruikers kunnen toevoegen aan elk type Visual Basic-project. Vervolgens kunt u de itemsjabloon aanpassen om extra mogelijkheden en gedrag voor uw aangepaste My extensie in te schakelen in een Visual Basic-project. Deze mogelijkheden zijn onder andere:

Gebruikers toestaan uw aangepaste My extensie te beheren vanaf de pagina Mijn extensies van Visual Basic Project Designer.
Automatisch uw aangepaste My extensie toevoegen wanneer een verwijzing naar een opgegeven assembly wordt toegevoegd aan een project.
Het verbergen van de sjabloon voor het My extensie-item in het dialoogvenster Item toevoegen, zodat deze niet is opgenomen in de lijst met projectitems.

In dit onderwerp wordt beschreven hoe u een aangepaste My extensie inpakt als een sjabloon voor verborgen items die kan worden beheerd via de pagina Mijn extensies van Visual Basic Project Designer. De aangepaste My extensie kan ook automatisch worden toegevoegd wanneer een verwijzing naar een opgegeven assembly wordt toegevoegd aan een project.

Een mijn naamruimte-extensie maken

De eerste stap bij het maken van een implementatiepakket voor een aangepaste My extensie is het maken van de extensie als één codebestand. Zie Mijn naamruimte uitbreiden in Visual Basic voor meer informatie en richtlijnen over het maken van een aangepaste My extensie.

Een mijn naamruimte-extensie exporteren als een itemsjabloon

Nadat u een codebestand hebt met de extensie voor de My naamruimte, kunt u het codebestand exporteren als een Visual Studio-itemsjabloon. Zie Artikelsjablonen maken voor instructies voor het exporteren van een bestand als een Visual Studio-itemsjabloon.

Notitie

Als uw My naamruimte-extensie afhankelijk is van een bepaalde assembly, kunt u de itemsjabloon aanpassen om uw My naamruimteextensie automatisch te installeren wanneer er een verwijzing naar die assembly wordt toegevoegd. Als gevolg hiervan wilt u die assembly-verwijzing uitsluiten wanneer u het codebestand exporteert als een Visual Studio-itemsjabloon.

De itemsjabloon aanpassen

U kunt inschakelen dat de itemsjabloon wordt beheerd via de pagina Mijn extensies van Visual Basic Project Designer. U kunt ook inschakelen dat de itemsjabloon automatisch wordt toegevoegd wanneer een verwijzing naar een opgegeven assembly wordt toegevoegd aan een project. Als u deze aanpassingen wilt inschakelen, voegt u een nieuw bestand, het Bestand CustomData, toe aan uw sjabloon en voegt u vervolgens een nieuw element toe aan de XML in uw Vstemplate-bestand.

Het CustomData-bestand toevoegen

Het CustomData-bestand is een tekstbestand met een bestandsnaamextensie van . CustomData (de bestandsnaam kan worden ingesteld op elke waarde die zinvol is voor uw sjabloon) en die XML bevat. De XML in het CustomData-bestand geeft Visual Basic opdracht om uw My extensie op te nemen wanneer gebruikers de pagina Mijn extensies van Visual Basic Project Designer gebruiken. U kunt desgewenst het kenmerk toevoegen aan het <AssemblyFullName> XML-bestand van uw CustomData-bestand. Hierdoor wordt Visual Basic geïnstrueerd om uw aangepaste My extensie automatisch te installeren wanneer een verwijzing naar een bepaalde assembly wordt toegevoegd aan het project. U kunt elke teksteditor of XML-editor gebruiken om het CustomData-bestand te maken en het vervolgens toe te voegen aan de gecomprimeerde map van de itemsjabloon (.zip bestand).

In de volgende XML ziet u bijvoorbeeld de inhoud van een CustomData-bestand waarmee het sjabloonitem wordt toegevoegd aan de map Mijn extensies van een Visual Basic-project wanneer een verwijzing naar de Microsoft.VisualBasic.PowerPacks.Vs.dll assembly wordt toegevoegd aan het project.

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

Het CustomData-bestand bevat een <VBMyExtensionTemplate> element met kenmerken zoals vermeld in de volgende tabel.

Kenmerk	Beschrijving
`ID`	Vereist. Een unieke id voor de extensie. Als de extensie met deze id al aan het project is toegevoegd, wordt de gebruiker niet gevraagd deze opnieuw toe te voegen.
`Version`	Vereist. Een versienummer voor de itemsjabloon.
`AssemblyFullName`	Optioneel. Een assemblynaam. Wanneer een verwijzing naar deze assembly wordt toegevoegd aan het project, wordt de gebruiker gevraagd de `My` extensie toe te voegen vanuit deze itemsjabloon.

<Het element CustomDataSignature> toevoegen aan het .vstemplate-bestand

Als u uw Visual Studio-itemsjabloon wilt identificeren als een My naamruimteextensie, moet u ook het .vstemplate-bestand voor uw itemsjabloon wijzigen. U moet een <CustomDataSignature> element toevoegen aan het <TemplateData> element. Het <CustomDataSignature> element moet de tekst Microsoft.VisualBasic.MyExtensionbevatten, zoals wordt weergegeven in het volgende voorbeeld.

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

U kunt bestanden in een gecomprimeerde map (.zip bestand) niet rechtstreeks wijzigen. U moet het .vstemplate-bestand uit de gecomprimeerde map kopiëren, wijzigen en het .vstemplate-bestand in de gecomprimeerde map vervangen door de bijgewerkte kopie.

In het volgende voorbeeld ziet u de inhoud van een .vstemplate-bestand waaraan het <CustomDataSignature> element is toegevoegd.

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

De sjabloon installeren

Als u de sjabloon wilt installeren, kunt u de gecomprimeerde map (.zip bestand) kopiëren naar de map Sjablonen voor Visual Basic-items. Standaard bevinden gebruikersitemsjablonen zich in %USERPROFILE%\Documents\Visual Studio <Version>\Templates\ItemTemplates\Visual Basic. U kunt de sjabloon ook publiceren als een Visual Studio Installer-bestand (.vsi).

Delen via