Freigeben über


Lernprogramm – Erstellen Ihrer ersten Erweiterung: Hello World

In diesem Beispiel für Hello World werden Sie durch die Erstellung Ihrer ersten Erweiterung für Visual Studio führt. In diesem Lernprogramm erfahren Sie, wie Sie 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 "Say Hello World!" hinzuzufügen, die wie folgt aussieht:

Screenshot mit einem benutzerdefinierten Menübefehl.

Voraussetzungen

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

Anmerkung

Sie können eine beliebige Version 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 aus und klicken Sie dann auf „Next“.

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

Screenshot mit dem Erstellen eines neuen VSIX-Projekts.

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). Wählen Sie im Kontextmenü "hinzufügen" aus, und "Neues Element".

  3. Wählen Sie den Abschnitt Erweiterbarkeit aus, und wählen Sie dann den Befehlaus.

  4. Geben Sie im Feld Name unten einen Dateinamen wie Command.csein.

Screenshot mit dem Erstellen eines benutzerdefinierten Befehls.

Ihre neue Befehlsdatei ist im Projektmappen-Explorersichtbar. Unter dem Knoten Ressourcen finden Sie weitere Dateien im Zusammenhang mit Ihrem Befehl. Wenn Sie beispielsweise das Bild ändern möchten, ist die PNG-Datei hier.

Ändern des Quellcodes

Zum jetzigen Zeitpunkt werden der Befehls- und Schaltflächentext automatisch generiert und sind nicht besonders interessant. Sie können die VSCT-Datei und die 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 des VSCT-Codes steuern.

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

  1. Suchen Sie im Projektmappen-Explorerdie 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. Wechseln Sie zurück zum Projektmappen-Explorer, und suchen Sie die Command.cs Datei. Ä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);
      }
      ...
    

Achten Sie darauf, die Änderungen an jeder Datei zu speichern.

Ausführen

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

Schritt 1. Drücken Sie F5-, um den Befehl Debuggen starten auszuführen. Dieser Befehl erstellt Ihr Projekt und startet den Debugger und startet eine neue Instanz von Visual Studio, die als Experimentelle Instanzbezeichnet wird.

Schritt 2. Klicken Sie im Menü Tools der Experimentellen Instanzauf Say Hello World!.

Screenshot, der zeigt, dass der benutzerdefinierte Befehl ein Meldungsfeld anzeigt.

Die Ausgabe des neuen benutzerdefinierten Befehls, nämlich die Nachricht Hallo Welt, sollte in diesem Fall im Dialogfeld in der Mitte des Bildschirms angezeigt werden.

Nächste Schritte

Nachdem Sie nun die Grundlagen der Arbeit mit der Erweiterbarkeit von Visual Studio kennen, finden Sie hier weitere Informationen: