ITextCaret, interface

Représente le signe insertion associé à un élément ITextView.

Espace de noms :  Microsoft.VisualStudio.Text.Editor
Assembly :  Microsoft.VisualStudio.Text.UI (dans Microsoft.VisualStudio.Text.UI.dll)

Syntaxe

'Déclaration
Public Interface ITextCaret

public interface ITextCaret

public interface class ITextCaret

type ITextCaret =  interface end

public interface ITextCaret

Le type ITextCaret expose les membres suivants.

Propriétés

	Nom	Description
	Bottom	Obtient la position du bord inférieur du signe insertion dans le système de coordonnées d'affichage du texte.
	ContainingTextViewLine	Obtient l'élément ITextViewLine contenant le signe insertion, tant que cette ligne de texte est visible dans la vue.
	Height	Obtient la hauteur du signe insertion dans le système de coordonnées d'affichage du texte.
	InVirtualSpace	Détermine si le signe insertion se trouve dans l'espace virtuel.Ce dernier correspond à l'espace situé après la fin physique d'une ligne.
	IsHidden	Obtient ou définit la visibilité du signe insertion.
	Left	Obtient la position du bord gauche du signe insertion dans le système de coordonnées d'affichage du texte.
	OverwriteMode	Détermine si le signe insertion est en mode de remplacement.
	Position	Obtient la position actuelle du signe insertion.
	Right	Obtient la position du bord droit du signe insertion dans le système de coordonnées d'affichage du texte.
	Top	Obtient la position du bord supérieur du signe insertion dans le système de coordonnées d'affichage du texte.
	Width	Obtient la largeur du signe insertion dans le système de coordonnées d'affichage du texte.

Début

Méthodes

	Nom	Description
	EnsureVisible	Permet de visualiser le signe insertion en faisant défiler la vue vers le haut ou vers le bas et de gauche à droite jusqu'à ce que le signe soit visible.
	MoveTo(ITextViewLine)	Déplace le signe insertion à la ligne de texte spécifiée tout en conservant son coordonnée x actuel.
	MoveTo(SnapshotPoint)	Déplace le signe d'insertion vers l'index donné dans le ITextBuffer sous-jacent.
	MoveTo(VirtualSnapshotPoint)	Déplace le signe insertion à la position dans la mémoire tampon spécifiée.
	MoveTo(ITextViewLine, Double)	Déplace le signe insertion vers l'élément CaretPosition le plus pertinent correspondant à la ligne de texte et à l'abscisse spécifiées.
	MoveTo(SnapshotPoint, PositionAffinity)	Déplace le signe d'insertion vers l'index donné dans le ITextBuffer sous-jacent.
	MoveTo(VirtualSnapshotPoint, PositionAffinity)	Déplace le signe insertion à la position dans la mémoire tampon spécifiée.
	MoveTo(ITextViewLine, Double, Boolean)	Déplace le signe insertion vers l'élément CaretPosition le plus pertinent correspondant à la ligne de texte et à l'abscisse spécifiées.
	MoveTo(SnapshotPoint, PositionAffinity, Boolean)	Déplace le signe d'insertion vers l'index donné dans le ITextBuffer sous-jacent.
	MoveTo(VirtualSnapshotPoint, PositionAffinity, Boolean)	Déplace le signe insertion à la position dans la mémoire tampon spécifiée.
	MoveToNextCaretPosition	Déplace le signe insertion vers l'élément CaretPosition valide suivant.
	MoveToPreferredCoordinates	Déplace le signe insertion au coordonnées x et y par défaut.
	MoveToPreviousCaretPosition	Déplace le signe insertion vers l'élément CaretPosition valide précédent.

Début

Événements

	Nom	Description
	PositionChanged	Se produit lorsque la position du signe insertion a été modifiée explicitement.

Début

Notes

Cette interface est utilisée comme moyen pratique d'obtenir la position actuelle du signe insertion et de déplacer le signe insertion à une position différente. Pour plus d'informations sur utiliser le signe insertion, voyez les procédures pas à pas d'éditeur, par exemple Procédure pas - à - pas : Mettre le texte en surbrillance.

La plupart des propriétés et paramètres qui sont des doubles correspondent aux coordonnées ou des distances dans le système de coordonnées de rendu de texte. Dans ce système de coordonnées x, = 0,0 correspond au bord gauche de la surface de dessin sur laquelle le texte est affiché (x view.ViewportLeft = correspond au bord gauche de la fenêtre d'affichage), et y = view.ViewportTop correspond au bord supérieur de la fenêtre d'affichage. Le coordonnée x augmente de gauche à droite, et le coordonnée y augmente de bas en haut. Les axes horizontaux et verticaux de la vue se comportent différemment. Lorsque le texte dans la vue est mis en forme, uniquement les lignes visibles sont mises en forme. Par conséquent, une fenêtre d'affichage ne peut pas être faite défiler horizontalement et verticalement de la même façon. Une fenêtre d'affichage est faite défiler horizontalement en modifiant la coordonnée gauche de la fenêtre d'affichage afin qu'il déplace en ce qui concerne la surface de dessin. Une vue peut être faite défiler verticalement uniquement en effectuant une nouvelle mise en page. Effectuer une mise en page dans la vue peut provoquer la propriété d'ViewportTop de la vue à la modification.

Par exemple, faire défiler vers le bas d'une ligne ne traduira pas les lignes visibles l'une d'elles. À la place il modifiera simplement la propriété d'ViewportTop de la vue (provoquant les lignes de le déplacer sur l'écran même si leurs coordonnée y n'aient pas changé). Les distances dans le système de coordonnées de rendu de texte correspondent aux pixels logiques. Si la surface de rendu de texte est affichée sans aucune transformation de mise à l'échelle, alors 1 unité dans le système de coordonnées de rendu de texte correspond à un pixel dans l'affichage.

Voir aussi

Référence

Microsoft.VisualStudio.Text.Editor, espace de noms