TextPoint, interface

Représente un emplacement de texte dans un document texte.

Espace de noms :  EnvDTE
Assembly :  EnvDTE (dans EnvDTE.dll)

Syntaxe

'Déclaration
<GuidAttribute("7F59E94E-4939-40D2-9F7F-B7651C25905D")> _
Public Interface TextPoint
[GuidAttribute("7F59E94E-4939-40D2-9F7F-B7651C25905D")]
public interface TextPoint
[GuidAttribute(L"7F59E94E-4939-40D2-9F7F-B7651C25905D")]
public interface class TextPoint
[<GuidAttribute("7F59E94E-4939-40D2-9F7F-B7651C25905D")>]
type TextPoint =  interface end
public interface TextPoint

Le type TextPoint expose les membres suivants.

Propriétés

  Nom Description
Propriété publique AbsoluteCharOffset Obtient l'offset de caractère base 1 entre le début du document et l'objet TextPoint.
Propriété publique AtEndOfDocument Obtient une valeur indiquant si l'objet se trouve à la fin du document.
Propriété publique AtEndOfLine Obtient une valeur indiquant si l'objet se trouve à la fin d'une ligne.
Propriété publique AtStartOfDocument Obtient une valeur indiquant si l'objet se trouve au début du document.
Propriété publique AtStartOfLine Obtient une valeur indiquant si l'objet se trouve au début d'une ligne.
Propriété publique CodeElement Retourne l'élément de code à l'emplacement de TextPoint.
Propriété publique DisplayColumn Obtient le numéro de la colonne affichée contenant l'objet TextPoint.
Propriété publique DTE Obtient l'objet d'extensibilité de niveau supérieur.
Propriété publique Line Obtient le numéro de ligne de l'objet.
Propriété publique LineCharOffset Obtient l'offset de caractère de l'objet.
Propriété publique LineLength Obtient le nombre de caractères de la ligne contenant l'objet, à l'exclusion du caractère de saut de ligne.
Propriété publique Parent Obtient l'objet parent immédiat d'un objet TextPoint.

Début

Méthodes

  Nom Description
Méthode publique CreateEditPoint Crée et retourne un objet EditPoint à l'emplacement de l'objet appelant.
Méthode publique EqualTo Retourne une valeur indiquant si la valeur de la propriété donnée AbsoluteCharOffset de l'objet du point équivaut à celle de l'objet TextPoint appelant.
Méthode publique GreaterThan Indique si la valeur de la propriété AbsoluteCharOffset de l'objet appelant est supérieure ou pas à celle de l'objet de point donné.
Méthode publique LessThan Indique si la valeur de la propriété AbsoluteCharOffset de l'objet appelé est inférieure ou pas à celle de l'objet de point donné.
Méthode publique TryToShow Tente d'afficher l'emplacement du point de texte.

Début

Notes

L'objet TextPoint vous permet de trouver des emplacements dans un document. À l'aide des propriétés de l'objet TextPoint, vous pouvez rechercher du texte selon les critères suivants :

  • Numéros de ligne

  • Numéros de caractères dans une ligne

  • Positions absolues de caractères à partir du début du document

  • Colonnes d'affichage

Les objets TextPoint sont semblables aux objets EditPoint, à ceci près qu'ils opèrent sur du texte affiché dans un éditeur de code et non sur les données du tampon de texte. Le texte situé dans un document est affecté par les états de l'éditeur en général, notamment le retour à la ligne automatique et les espaces virtuels, ce qui n'est pas le cas du tampon de texte.

Lorsque vous modifiez un document, les objets TextPoint ne se déplacent pas par rapport au texte qui les entoure. Autrement dit, si du texte est inséré avant un point de texte, la valeur de la propriété AbsoluteCharOffset est incrémentée pour refléter son nouvel emplacement plus loin dans le document. Si plusieurs objets TextPoint se trouvent au même emplacement et qu'un objet EditPoint est utilisé pour insérer du texte, les nouveaux caractères viendront se placer à droite de tous les objets TextPoint, à l'exception de celui qui est utilisé pour insérer le texte.

Toute opération visant à modifier un objet TextDocument échoue si TextDocument est en lecture seule.

Exemples

Sub TextPointExample()
   ' Comments a region of code.
   Dim selection As TextSelection
   selection = dte.ActiveDocument.selection()
   Dim Start As Editpoint
   Start = selection.TopPoint.CreateEditPoint()
   Dim endpt As TextPoint
   endpt = selection.BottomPoint
      
   Dim undoObj As UndoContext = dte.UndoContext
   undoobj.Open("Comment Region")
   Do While (Start.LessThan(endpt))
      Start.Insert("//")
      Start.LineDown()
      Start.StartOfLine()
   Loop
   undoobj.Close()
End Sub

Voir aussi

Référence

EnvDTE, espace de noms