Erweitern des Visual Studio-Editors

Der Visual Studio-Editor unterstützt Erweiterungen, die ihren Funktionen hinzugefügt werden. Beispiele sind Erweiterungen, die:

  • Einfügen und Ändern von Code in einer vorhandenen Sprache.
  • Passen Sie das Verhalten bestimmter Editorfeatures wie CodeLens an.

Der Visual Studio-Editor bezieht sich im Allgemeinen auf die Funktionalität der Bearbeitung von Textdateien, die als Dokumente bezeichnet werden, von jedem Typ. Sie können einzelne Dateien zur Bearbeitung öffnen. Das geöffnete Editor-Fenster wird als Textansicht bezeichnet.

Weitere Informationen zum Editorobjektmodell finden Sie unter Editorerweiterungskonzepte.

In den folgenden Abschnitten sind die übergeordneten Editorerweiterungsszenarien zusammengefasst, die VisualStudio.Extensibility unterstützt. Jedes dieser Szenarien ist reich an Konzepten und APIs. Separate, ausführlichere Abschnitte enthalten Links, um ausführlichere Erläuterungen der APIs und deren Verwendung bereitzustellen.

Lesen von Text und Beobachten von Änderungen im Editor

Der grundlegendste Erweiterbarkeitspunkt für den Visual Studio-Editor besteht darin, Text zu bearbeiten, indem er den Text im Editor liest oder den Text bearbeitet. Diese Szenarien sind für alle editorbasierten Erweiterungen wesentlich. Um z. B. Diagnoseinformationen wie Warnungen oder Fehler bereitzustellen, muss die Erweiterung den Code im Editor lesen und dann interpretieren. Eine Erweiterung benötigt außerdem eine Möglichkeit, zu erkennen, wann sich der Text im Editor geändert hat, wenn eine neue Datei geöffnet wurde oder ob eine geöffnete Datei geschlossen wurde.

Eine Anleitung zum Lesen von Text und zum Nachverfolgen von Textänderungen mithilfe von VisualStudio.Extensibility finden Sie unter Arbeiten mit Text im Editor.

Bearbeiten von Text im Editor

Jede Erweiterung, die darauf abzielt, die Bearbeitungsproduktivität zu steigern, indem Text automatisch eingefügt wird (wie z. B. eine GUID automatisch generiert und eingefügt wird), muss APIs definieren, um festzulegen, wo und was eingefügt werden soll. Das VisualStudio.Extensibility Erweiterungsmodell führt Code aus dem Prozess und asynchron aus, was die Einhaltung bestimmter Prinzipien erfordert, wenn Sie Textbearbeitungserweiterungen entwickeln.

Eine exemplarische Vorgehensweise zum Bearbeiten von Text mithilfe von VisualStudio.Extensibility finden Sie unter Ändern von Text im Editor.

Erweiterung der Editorfunktionen

Erweiterungen können auch mit vielen Features im Editor verbunden werden, die Kontextinformationen bereitstellen. In den folgenden Abschnitten werden die verschiedenen Features im Editor zusammengefasst, die Sie erweitern können.

Rand der Textansicht

Erweiterungen können neue Textansichtsränder zum Visual Studio-Editor beitragen. Ein Textansichtsrand ist ein rechteckiges UI-Steuerelement, das an einer der vier Seiten einer Textansicht angefügt ist. Diese UI-Steuerelemente bieten auf einen Blick mehr Informationen, sodass Entwickler produktiv bleiben können, wenn sie im Editor arbeiten. Viele der beliebtesten Features im Visual Studio-Editor verwenden Textansichtsränder, z. B. Zoomsteuerelement, Haltepunktindikator und Zeilennummernindikator.

Eine exemplarische Vorgehensweise zum Anpassen von Textansichtsrändern mit der Erweiterung finden Sie unter Erweitern des Visual Studio-Editors mit einem neuen Rand.

CodeLens

Erweiterungen können dem Visual Studio-Editor neue CodeLenses hinzufügen. Ein CodeLens ist ein visueller Indikator, der über Textzeilen angezeigt wird, um umsetzbare kontextbezogene Informationen bereitzustellen. Beispiele sind die Anzahl der Verweise auf ein Codeelement, Ergebnisse der letzten Komponententestausführung oder Aktionen zum Ausführen oder Debuggen eines Komponententests. Einige gängige CodeLenses enthalten den Codeverweis CodeLens, der Informationen zu allen verschiedenen Teilen des Codes bereitstellt, die auf einen bestimmten Codeblock verweisen. Der Codeverlauf "CodeLens" enthält Informationen dazu, wie sich ein bestimmter Codeblock in der Quellcodeverwaltung geändert hat.

Eine exemplarische Vorgehensweise zum Bereitstellen eigener CodeLens mit Ihrer Erweiterung finden Sie unter Erweitern des Visual Studio-Editors mit einem neuen CodeLens.

Taggers

Erweiterungen können neue Tagger zum Visual Studio-Editor beitragen. Tagger werden verwendet, um Daten mit Textabschnitten zuzuordnen. Andere Visual Studio-Features (z. B. CodeLens und Klassifizierung) nutzen diese Daten.

Eine exemplarische Vorgehensweise zum Bereitstellen eigener Tagger mit Ihrer Erweiterung finden Sie unter Erweitern des Visual Studio-Editors mit einem neuen Tagger.