Freigeben über


ITextCaret-Schnittstelle

Stellt die Einfügemarke dar, die einer ITextView zugeordnet ist.

Namespace:  Microsoft.VisualStudio.Text.Editor
Assembly:  Microsoft.VisualStudio.Text.UI (in Microsoft.VisualStudio.Text.UI.dll)

Syntax

'Declaration
Public Interface ITextCaret
public interface ITextCaret
public interface class ITextCaret
type ITextCaret =  interface end
public interface ITextCaret

Der ITextCaret-Typ macht die folgenden Member verfügbar.

Eigenschaften

  Name Beschreibung
Öffentliche Eigenschaft Bottom Ruft die Position des unteren Rands der Einfügemarke im Textrendering-Koordinatensystem ab.
Öffentliche Eigenschaft ContainingTextViewLine Ruft die ITextViewLine ab, die die Einfügemarke enthält, sofern diese Textzeile in der Ansicht sichtbar ist.
Öffentliche Eigenschaft Height Ruft die Höhe der Einfügemarke im Textrendering-Koordinatensystem ab.
Öffentliche Eigenschaft InVirtualSpace Bestimmt, ob die Einfügemarke im virtuellen Leerraum liegt.Virtueller Leerraum ist Leerraum nach dem physischen Ende einer Zeile.
Öffentliche Eigenschaft IsHidden Ruft die Sichtbarkeit der Einfügemarke ab oder legt diese fest.
Öffentliche Eigenschaft Left Ruft die Position des linken Rands der Einfügemarke im Textrendering-Koordinatensystem ab.
Öffentliche Eigenschaft OverwriteMode Bestimmt, ob die Einfügemarke sich im Überschreibungsmodus befindet.
Öffentliche Eigenschaft Position Ruft die aktuelle Position der Einfügemarke ab.
Öffentliche Eigenschaft Right Ruft die Position des rechten Rands der Einfügemarke im Textrendering-Koordinatensystem ab.
Öffentliche Eigenschaft Top Ruft die Position des oberen Rands der Einfügemarke im Textrendering-Koordinatensystem ab.
Öffentliche Eigenschaft Width Ruft die Breite der Einfügemarke im Textrendering-Koordinatensystem ab.

Zum Seitenanfang

Methoden

  Name Beschreibung
Öffentliche Methode EnsureVisible Macht die Einfügemarke sichtbar, indem ein Bildlauf nach oben oder unten und nach links oder rechts durch die Ansicht ausgeführt wird, bis die Einfügemarke sichtbar ist.
Öffentliche Methode MoveTo(ITextViewLine) Verschiebt die Einfügemarke in die angegebene Textzeile unter Beibehaltung seiner aktuellen x-Koordinate.
Öffentliche Methode MoveTo(SnapshotPoint) Bewegt die Einfügemarke zum angegebenen Index im zugrunde liegenden ITextBuffer.
Öffentliche Methode MoveTo(VirtualSnapshotPoint) Verschiebt die Einfügemarke in die angegebene Pufferposition.
Öffentliche Methode MoveTo(ITextViewLine, Double) Verschiebt die Einfügemarke in die beste CaretPosition für die angegebene x-Koordinate und Textzeile.
Öffentliche Methode MoveTo(SnapshotPoint, PositionAffinity) Bewegt die Einfügemarke zum angegebenen Index im zugrunde liegenden ITextBuffer.
Öffentliche Methode MoveTo(VirtualSnapshotPoint, PositionAffinity) Verschiebt die Einfügemarke in die angegebene Pufferposition.
Öffentliche Methode MoveTo(ITextViewLine, Double, Boolean) Verschiebt die Einfügemarke in die beste CaretPosition für die angegebene x-Koordinate und Textzeile.
Öffentliche Methode MoveTo(SnapshotPoint, PositionAffinity, Boolean) Bewegt die Einfügemarke zum angegebenen Index im zugrunde liegenden ITextBuffer.
Öffentliche Methode MoveTo(VirtualSnapshotPoint, PositionAffinity, Boolean) Verschiebt die Einfügemarke in die angegebene Pufferposition.
Öffentliche Methode MoveToNextCaretPosition Verschiebt die Einfügemarke zur nächsten gültigen CaretPosition.
Öffentliche Methode MoveToPreferredCoordinates Verschiebt die Einfügemarke zum bevorzugten x- und y-Koordinaten.
Öffentliche Methode MoveToPreviousCaretPosition Verschiebt die Einfügemarke zur vorhergehenden gültigen CaretPosition.

Zum Seitenanfang

Ereignisse

  Name Beschreibung
Öffentliches Ereignis PositionChanged Tritt ein, wenn die Position der Einfügemarke explizit geändert wurde.

Zum Seitenanfang

Hinweise

Diese Schnittstelle wird als bequeme Möglichkeit, die aktuelle Position des Caretzeichens abzurufen und die Einfügemarke an eine andere Position verschoben werden soll. Weitere Informationen über die Verwendung des Caretzeichens finden Sie in den Editor exemplarischen Vorgehensweisen für, z. B. Exemplarische Vorgehensweise: Text markieren

Die meisten Eigenschaften und Parameter, die Doubles sind, entsprechen den Koordinaten oder Abständen im Textrendering-Koordinatensystem. In diesem Koordinatensystem ist x = 0.0 bis zur linken Kante der Zeichenoberfläche, für die Text (x = view.ViewportLeft entspricht dem linken Rand des Viewports) gerendert wird, und y = view.ViewportTop entspricht dem oberen Rand des Viewports. Die x-Koordinate vergrößert sich von links nach rechts und y-Koordinaten vergrößert sich von oben nach unten. Das horizontale und Hochachsen der Ansicht verhalten sich anders. Wenn der Text in der Ansicht formatiert wird, werden nur die sichtbaren Zeilen formatiert werden. Daher kann es sich um einen Viewport nicht auf die horizontale und vertikale Bildläufe durchgeführt werden. Ein Viewport horizontaler Bildlauf durchgeführt wird, indem die linke Koordinate des Viewports geändert wird, damit er in Bezug auf die Zeichenoberfläche befindet. Eine Sicht kann nur ein vertikaler Bildlauf durchgeführt werden, indem ein neues Lay-out ausgeführt wird. Dies eines Lay-outs in der Ansicht kann die ViewportTop-Eigenschaft der Ansicht für die Änderung.

Zum Beispiel übersetzt das Bildlauf um eine Zeile nach unten ausführen keine sichtbaren Zeilen. Stattdessen ändert es einfach die ViewportTop-Eigenschaft der Ansicht (und bewirkt, dass sich die Zeilen auf dem Bildschirm zu verschieben, obwohl ihre Y-Koordinaten nicht geändert haben). Lücken im Textrendering-Koordinatensystem entsprechen den logischen Pixeln. Wenn die Oberfläche Rendern von Text ohne Skalierung angezeigt wird, transformieren Sie dann entspricht 1 Einheit im Textrendering-Koordinatensystem einem Pixel für die Anzeige.

Siehe auch

Referenz

Microsoft.VisualStudio.Text.Editor-Namespace