Lernprogramm – Erstellen Ihrer ersten Erweiterung: Hallo Welt

  • Artikel

Dieses Hallo Welt-Beispiel führt Sie durch die Erstellung Ihrer ersten Erweiterung für Visual Studio. In diesem Tutorial wird gezeigt, wie Sie in Visual Studio einen neuen Befehl hinzufügen.

Im Prozess erfahren Sie, wie Sie:

In diesem Beispiel verwenden Sie Visual C#, um eine benutzerdefinierte Menüschaltfläche namens "Sagen sie Hallo Welt!" hinzuzufügen, die wie folgt aussieht:

Screenshot showing a custom menu command.

Hinweis

Dieser Artikel gilt für Visual Studio unter Windows. Informationen zu Visual Studio für Mac finden Sie unter Exemplarische Vorgehensweise: Erweitern von Visual Studio für Mac.

Voraussetzungen

Bevor Sie beginnen, stellen Sie sicher, dass Sie die Visual Studio-Erweiterungsentwicklungsworkload installiert haben, die die VSIX-Vorlage und den Beispielcode enthält.

Hinweis

Sie können eine beliebige Edition von Visual Studio (Community, Professional oder Enterprise) verwenden, um ein Visual Studio-Erweiterbarkeitsprojekt zu erstellen.

Erstellen eines Erweiterbarkeitsprojekts

  1. Klicken Sie im Menü Datei auf Neu>Projekt. Suchen Sie nach "vsix", und wählen Sie das C# VSIX-Projekt und dann " Weiter" aus.

  2. Geben Sie für Projektname „HelloWorld“ ein, und klicken Sie auf Erstellen.

Screenshot showing creating a new VSIX project.

Nun sollte das „HelloWorld“-Projekt im Projektmappen-Explorer angezeigt werden.

Hinzufügen eines benutzerdefinierten Befehls

  1. Wenn Sie die .vsixmanifest Manifestdatei auswählen, können Sie sehen, welche Optionen geändert werden können, z. B. Beschreibung, Autor und Version.

  2. Klicken Sie mit der rechten Maustaste auf das Projekt (nicht auf die Projektmappe). Klicken Sie im Kontextmenü auf Hinzufügen und dann auf Neues Element.

  3. Klicken Sie auf den Abschnitt Erweiterbarkeit und dann auf Befehl.

  4. Geben Sie unten im Feld Name einen Dateinamen wie beispielsweise Command.cs ein.

Screenshot showing creating a custom command.

Die neue Befehlsdatei wird im Projektmappen-Explorer angezeigt. Unter dem Knoten "Ressourcen " finden Sie weitere Dateien im Zusammenhang mit Ihrem Befehl. Wenn Sie beispielsweise das Bild ändern möchten, befindet sich hier die PNG-Datei.

Ändern des Quellcodes

An diesem Punkt werden der Befehls- und Schaltflächentext automatisch generiert und nicht so interessant. Sie können die VSCT- und CS-Datei ändern, wenn Sie Änderungen vornehmen möchten.

  • In der VSCT-Datei können Sie Ihre Befehle umbenennen und definieren, wo sie im Visual Studio-Befehlssystem gespeichert werden. Wenn Sie die VSCT-Datei erkunden, beachten Sie Kommentare, die erläutern, welche Abschnitte der VSCT-Codesteuerelemente.

  • In der CS-Datei können Sie Aktionen definieren (z. B. den Klickhandler).

  1. Suchen Sie in Projektmappen-Explorer die VSCT-Datei für die Erweiterung VSPackage. In diesem Fall heißt es "HelloWorldPackage.vsct".

  2. Ändern Sie den Parameter ButtonText in Say Hello World!.

      ...
  <Button guid="guidCommandPackageCmdSet" id="CommandId" priority="0x0100" type="Button">
    <Parent guid="guidCommandPackageCmdSet" id="MyMenuGroup" />
    <Icon guid="guidImages" id="bmpPic1" />
    <Strings>
        <ButtonText>Say Hello World!</ButtonText>
    </Strings>
  </Button>
  ...

  3. Navigieren Sie zurück zum Projektmappen-Explorer, und suchen Sie die Datei Command.cs. Ändern Sie in der Execute-Methode die Zeichenfolge message von string.Format(..) in Hello World!.

      ...
  private void Execute(object sender, EventArgs e)
  {
    ThreadHelper.ThrowIfNotOnUIThread();
    string message = "Hello World!";
    string title = "Command";

    // Show a message box to prove we were here
    VsShellUtilities.ShowMessageBox(
        this.ServiceProvider,
        message,
        title,
        OLEMSGICON.OLEMSGICON_INFO,
        OLEMSGBUTTON.OLEMSGBUTTON_OK,
        OLEMSGDEFBUTTON.OLEMSGDEFBUTTON_FIRST);
  }
  ...

Stellen Sie sich, dass Sie alle Änderungen an den Dateien speichern.

Führen Sie das Skript aus.

Sie können nun den Quellcode in der experimentellen Instanz von Visual Studio ausführen.

Schritt 1. Drücken Sie F5, um den Befehl Debuggen starten auszuführen. Mit diesem Befehl wird das Projekt erstellt und der Debugger gestartet. Eine neue Instanz von Visual Studio wird gestartet, die als experimentelle Instanz bezeichnet wird.

Schritt 2. Klicken Sie im Menü Extras der experimentellen Instanz auf Sag Hallo Welt!.

Screenshot showing that the custom command displays a message box.

In diesem Fall sollte die Ausgabe des neuen benutzerdefinierten Befehls angezeigt werden, in diesem Fall das Dialogfeld in der Mitte des Bildschirms, in dem Sie die Hallo Welt!-Nachricht erhalten.

Nächste Schritte

Nachdem Sie nun mit den Grundlagen der Visual Studio-Erweiterbarkeit vertraut sind, finden Sie hier weitere Informationen: