Teilen über

Packen und Bereitstellen von benutzerdefinierten "Meine Erweiterungen" (Visual Basic)

Visual Basic bietet ihnen eine einfache Möglichkeit, Ihre benutzerdefinierten My Namespaceerweiterungen mithilfe von Visual Studio-Vorlagen bereitzustellen. Wenn Sie eine Projektvorlage erstellen, für die Ihre My Erweiterungen ein integraler Bestandteil des neuen Projekttyps sind, können Sie einfach ihren benutzerdefinierten My Erweiterungscode in das Projekt einschließen, wenn Sie die Vorlage exportieren. Weitere Informationen zum Exportieren von Projektvorlagen finden Sie unter How to: Create Project Templates.

Wenn sich die benutzerdefinierte My Erweiterung in einer einzelnen Codedatei befindet, können Sie die Datei als Elementvorlage exportieren, die Benutzer einem beliebigen Visual Basic-Projekttyp hinzufügen können. Anschließend können Sie die Elementvorlage anpassen, um zusätzliche Funktionen und Verhaltensweisen für die benutzerdefinierte My Extension in einem Visual Basic-Projekt zu aktivieren. Diese Funktionen umfassen Folgendes:

  • Benutzern das Verwalten Ihrer benutzerdefinierten My Erweiterung über die Seite "Meine Erweiterungen" im Visual Basic Project Designer ermöglichen.

  • Automatisches Hinzufügen der benutzerdefinierten My Erweiterung, wenn einem Projekt ein Verweis auf eine angegebene Assembly hinzugefügt wird.

  • Ausblenden der My Erweiterungselementvorlage im Dialogfeld " Element hinzufügen ", sodass sie nicht in der Liste der Projektelemente enthalten ist.

In diesem Thema wird erläutert, wie Sie eine benutzerdefinierte My Erweiterung als ausgeblendete Elementvorlage verpacken, die auf der Seite "Meine Erweiterungen" des Visual Basic Project Designer verwaltet werden kann. Die benutzerdefinierte My Erweiterung kann auch automatisch hinzugefügt werden, wenn einem Projekt ein Verweis auf eine angegebene Assembly hinzugefügt wird.

Erstellen einer My-Namespace-Erweiterung

Der erste Schritt beim Erstellen eines Bereitstellungspakets für eine benutzerdefinierte My Erweiterung besteht darin, die Erweiterung als einzelne Codedatei zu erstellen. Ausführliche Informationen und Anleitungen zum Erstellen einer benutzerdefinierten My Erweiterung finden Sie unter Erweitern des My Namespace in Visual Basic.

Exportieren einer My-Namespace-Erweiterung als Elementvorlage

Nachdem Sie über eine Codedatei verfügen, die die My Namespaceerweiterung enthält, können Sie die Codedatei als Visual Studio-Elementvorlage exportieren. Anweisungen zum Exportieren einer Datei als Visual Studio-Elementvorlage finden Sie unter How to: Create Item Templates.

Hinweis

Wenn Ihre My Namespaceerweiterung eine Abhängigkeit von einer bestimmten Assembly aufweist, können Sie Ihre Elementvorlage so anpassen, dass die My Namespaceerweiterung automatisch installiert wird, wenn ein Verweis auf diese Assembly hinzugefügt wird. Daher sollten Sie diesen Assemblyverweis ausschließen, wenn Sie die Codedatei als Visual Studio-Elementvorlage exportieren.

Anpassen der Elementvorlage

Sie können die Verwaltung Ihrer Elementvorlage über die Seite "Meine Erweiterungen" im Visual Basic Project Designer aktivieren. Sie können auch aktivieren, dass die Elementvorlage automatisch hinzugefügt wird, wenn einem Projekt ein Verweis auf eine angegebene Assembly hinzugefügt wird. Um diese Anpassungen zu aktivieren, fügen Sie ihrer Vorlage eine neue Datei, die als CustomData-Datei bezeichnet wird, hinzu, und fügen Sie dann der XML-Datei in der VSTEMPLATE-Datei ein neues Element hinzu.

Hinzufügen der CustomData-Datei

Die CustomData-Datei ist eine Textdatei mit der Dateinamenerweiterung von . CustomData (der Dateiname kann auf einen beliebigen Wert für Ihre Vorlage festgelegt werden) und das XML enthält. Der XML-Code in der CustomData-Datei weist Visual Basic an, Ihre My Erweiterung einzuschließen, wenn Benutzer die Seite "Meine Erweiterungen" des Visual Basic Project Designer verwenden. Sie können optional das <AssemblyFullName> Attribut zu Ihrer CustomData-Datei-XML hinzufügen. Dadurch wird Visual Basic angewiesen, die benutzerdefinierte My Erweiterung automatisch zu installieren, wenn dem Projekt ein Verweis auf eine bestimmte Assembly hinzugefügt wird. Sie können einen beliebigen Text-Editor oder XML-Editor verwenden, um die CustomData-Datei zu erstellen und sie dann dem komprimierten Ordner ihrer Elementvorlage (.zip Datei) hinzuzufügen.

Der folgende XML-Code zeigt beispielsweise den Inhalt einer CustomData-Datei, die das Vorlagenelement dem Ordner "Meine Erweiterungen" eines Visual Basic-Projekts hinzufügt, wenn dem Projekt ein Verweis auf die Microsoft.VisualBasic.PowerPacks.Vs.dll-Assembly hinzugefügt wird.

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

Die CustomData-Datei enthält ein <VBMyExtensionTemplate> Element mit Attributen, wie in der folgenden Tabelle aufgeführt.

Merkmal BESCHREIBUNG
ID Erforderlich. Ein eindeutiger Bezeichner für die Erweiterung. Wenn die Erweiterung, die diese ID enthält, bereits dem Projekt hinzugefügt wurde, wird der Benutzer nicht aufgefordert, sie erneut hinzuzufügen.
Version Erforderlich. Eine Versionsnummer für die Elementvorlage.
AssemblyFullName Wahlfrei. Ein Assemblyname. Wenn dem Projekt ein Verweis auf diese Assembly hinzugefügt wird, wird der Benutzer aufgefordert, die My Erweiterung aus dieser Elementvorlage hinzuzufügen.

Hinzufügen des <CustomDataSignature> Elements zur VSTEMPLATE-Datei

Um Ihre Visual Studio-Elementvorlage als My Namespaceerweiterung zu identifizieren, müssen Sie auch die VSTEMPLATE-Datei für Ihre Elementvorlage ändern. Sie müssen dem <CustomDataSignature> Element ein <TemplateData> Element hinzufügen. Das <CustomDataSignature> Element muss den Text Microsoft.VisualBasic.MyExtensionenthalten, wie im folgenden Beispiel gezeigt.

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

Dateien in einem komprimierten Ordner (.zip Datei) können nicht direkt geändert werden. Sie müssen die VSTEMPLATE-Datei aus dem komprimierten Ordner kopieren, ändern und dann die VSTEMPLATE-Datei im komprimierten Ordner durch Ihre aktualisierte Kopie ersetzen.

Das folgende Beispiel zeigt den Inhalt einer VSTEMPLATE-Datei, die das <CustomDataSignature> Element hinzugefügt hat.

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

Installieren der Vorlage

Um die Vorlage zu installieren, können Sie den komprimierten Ordner (.zip Datei) in den Visual Basic-Elementvorlagenordner kopieren. Standardmäßig befinden sich Benutzerelementvorlagen in %USERPROFILE%\Documents\Visual Studio <Version>\Templates\ItemTemplates\Visual Basic. Alternativ können Sie die Vorlage als Visual Studio Installer-Datei (VSI) veröffentlichen.

Siehe auch

  • Last updated on