VirtualCharOffset Property

VirtualPoint.VirtualCharOffset Property


Gets the column index of a virtual point in virtual space.

Namespace:   EnvDTE
Assembly:  EnvDTE (in EnvDTE.dll)

int VirtualCharOffset { get; }

Property Value

Type: System.Int32

An integer value indicating the column index of a virtual point in virtual space.

Character numbering begins at one. VirtualCharOffset returns the number of characters the virtual point is from the left side of a line in the document.

Sub VirtualPointExample()
   ' Before running this example, open a text document.
   Dim objSel As TextSelection = DTE.ActiveDocument.Selection
   Dim objActive As VirtualPoint = objSel.ActivePoint
   ' Collapse the selection to the beginning of the line.
   ' objActive is "live", tied to the position of the actual selection, 
   ' so it will reflect the new position.
   Dim iCol As Long = objActive.DisplayColumn
   ' Move the selection to the end of the line.

   MsgBox("The length of the insertion point line is " & (objActive.DisplayColumn - iCol) & " display characters.")
   MsgBox("VirtualCharOffset value: " & objActive.VirtualCharOffset & vbCr & "VirtualDisplayColumn value: " & objActive.VirtualDisplayColumn)
End Sub
Return to top
© 2015 Microsoft