Erste Schritte mit der VSIX-Projektvorlage

  • Artikel

Sie können die VSIX-Projektvorlage verwenden, um eine Erweiterung zu erstellen oder eine vorhandene Erweiterung für die Bereitstellung zu verpacken. Die VSIX-Projektvorlage enthält sowohl Visual Basic- als auch Visual C#-Versionen und wird als Teil des Visual Studio SDK installiert.

Die VSIX-Projektvorlage besteht lediglich aus einer source.extension.vsixmanifest Datei, die Informationen über die Erweiterung und die darin enthaltenen Ressourcen enthält.

Um die VSIX-Projektvorlage zu finden, müssen Sie das Visual Studio SDK installieren. Weitere Informationen finden Sie unter Visual Studio SDK.

Bereitstellen einer benutzerdefinierten Projektvorlage mithilfe der VSIX-Projektvorlage

Die folgenden Schritte zeigen, wie Sie das VSIX-Projekt verwenden, um eine Projektvorlage zu packen, die Sie für andere Entwickler freigeben oder in den Visual Studio-Katalog hochladen können.

  1. Erstellen Sie eine Projektvorlage.

    1. Öffnen Sie das Projekt, aus dem eine Vorlage erstellt werden soll. Dieses Projekt kann ein beliebiger Projekttyp sein.

    2. Klicken Sie im Menü Projekt auf Vorlage exportieren. Führen Sie die Schritte des Assistenten aus.

      Eine .zip Datei wird in %USERPROFILE%\My Documents\Visual Studio {version}\My Exported Templates\.

  2. Erstellen Sie ein leeres VSIX-Projekt.

    Wählen Sie Datei>Neu>Projekt aus. Geben Sie im Suchfeld "vsix" ein, und wählen Sie entweder die C# - oder Visual Basic-Version von VSIX Project aus.

  3. Fügen Sie dem Projekt die .zip Datei hinzu. Legen Sie die Eigenschaft "Copy to Output Directory " auf Copy Always.

  4. Doppelklicken Sie in Projektmappen-Explorer auf die Datei "source.extension.vsixmanifest", um sie im VSIX-Manifest-Designer zu öffnen, und nehmen Sie dann die folgenden Änderungen vor:

    • Legen Sie das Feld " Produktname " auf "Meine Projektvorlage" fest.

    • Legen Sie das Feld " Produkt-ID " auf "MyProjectTemplate - 1" fest.

    • Legen Sie das Feld "Autor" auf "Fabrikam" fest.

    • Legen Sie das Feld "Beschreibung" auf "Meine Projektvorlage" fest.

    • Fügen Sie im Abschnitt "Assets " einen Microsoft.VisualStudio.ProjectTemplate-Typ hinzu, und legen Sie den Pfad auf den Namen der .zip Datei fest.

  5. Speichere und schließe die Datei source.extension.vsixmanifest.

  6. Erstellen Sie das Projekt.

  7. Doppelklicken Sie im Ausgabeverzeichnis auf die .vsix Datei.

  8. Ein Meldungsfeld für VSIX Installer wird angezeigt. Folgen Sie den Anweisungen zum Installieren der Erweiterung.

  9. Schließen Sie Visual Studio, und öffnen Sie es anschließend erneut.

  10. Wählen Sie "Erweiterungen verwalten" (im Menü "Erweiterungen") und dann die Kategorie "Vorlagen" aus. Eine der verfügbaren Erweiterungen sollte "Meine Projektvorlage" sein.

  11. Die neue Projektvorlage wird im Dialogfeld "Neues Projekt " an derselben Stelle wie die ursprüngliche Projektvorlage angezeigt. Wenn Sie beispielsweise eine Vorlage namens VB-Konsole aus einer Visual Basic-Konsolenanwendung erstellt haben, wird die VB-Konsole im selben Bereich wie die Visual Basic-Konsolenanwendungsvorlage angezeigt.

So geben Sie den Speicherort der Vorlage im Dialogfeld "Neues Projekt" an

  1. Vorlagenordner befinden sich in den {Visual Studio Installation Path}\Common7\IDE\ProjectTemplates Verzeichnissen und {Visual Studio Installation Path}\Common7\IDE\ItemTemplates Verzeichnissen. Die Namen der Abschnitte der obersten Ebene im Dialogfeld "Neues Projekt " stimmen nicht exakt mit den Namen der Vorlagenordner überein. Verwenden Sie dabei den Namen des Vorlagenordners.

    Ändern Sie die .vsix Dateierweiterung in .zip, und öffnen Sie dann die Datei.

  2. Erstellen Sie einen neuen Ordner mit demselben Namen wie der Abschnitt des Dialogfelds "Neues Projekt ", in dem die Vorlage angezeigt werden soll.

  3. Wenn die Vorlage in einem Unterabschnitt angezeigt werden soll, erstellen Sie einen Unterordner mit demselben Namen.

  4. Verschieben Sie die Vorlagendatei .zip in den neuen Ordner.

  5. Ändern Sie die .zip Erweiterung in .vsix.

  6. Öffnen Sie das VSIX-Manifest.

  7. Aktualisieren Sie im VSIX-Manifest den Objektpfad der Vorlage so, dass sie auf den Stamm der Verzeichnisstruktur verweist, die die Vorlagendatei enthält. Wenn sich die Vorlage beispielsweise befindet \CSharp\Windows, sollte der Verweis auf \CSharp.