EditPoint.LineCharOffset Property

Gets the character offset of the EditPoint object.

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

Syntax

'Declaration
ReadOnly Property LineCharOffset As Integer

'Usage
Dim instance As EditPoint 
Dim value As Integer 

value = instance.LineCharOffset

int LineCharOffset { get; }

property int LineCharOffset {
    int get ();
}

function get LineCharOffset () : int

Property Value

Type: System.Int32
An integer value indicating the character offset of the EditPoint object.

Implements

TextPoint.LineCharOffset

Remarks

Character numbering begins at one. LineCharOffset returns the number of characters the object is from the left side of a line in the document.

Examples

Sub LineCharOffsetExample(ByVal dte As DTE2)

    ' Create a new text file.
    dte.ItemOperations.NewFile()

    ' Create an EditPoint at the start of the new document.
    Dim doc As TextDocument = 
        CType(dte.ActiveDocument.Object("TextDocument"), TextDocument)
    Dim point As EditPoint = doc.StartPoint.CreateEditPoint

    Dim i As Integer

    ' Insert 10 lines of text.
    For i = 1 To 10
        point.Insert("This is a test." & vbCrLf)
    Next

    ' Display EditPoint properties.
    MsgBox( _
        "AbsoluteCharOffset: " & point.AbsoluteCharOffset & vbCrLf & _
        "LineCharOffset: " & point.LineCharOffset & vbCrLf & _
        "DisplayColumn: " & point.DisplayColumn & vbCrLf & _
        "AtEndOfDocument: " & point.AtEndOfDocument & vbCrLf & _
        "AtEndOfLine: " & point.AtEndOfLine & vbCrLf & _
        "AtStartOfDocument: " & point.AtStartOfDocument & vbCrLf & _
        "AtStartOfLine: " & point.AtStartOfLine)

End Sub

public void LineCharOffsetExample(DTE2 dte)
{
    // Create a new text file.
    dte.ItemOperations.NewFile(@"General\Text File", "", 
        Constants.vsViewKindPrimary);

    // Create an EditPoint at the start of the new document.
    TextDocument doc = 
        (TextDocument)dte.ActiveDocument.Object("TextDocument");
    EditPoint point = doc.StartPoint.CreateEditPoint();

    // Insert 10 lines of text.
    for (int i = 0; i < 10; ++i)
        point.Insert("This is a test.\n");

    // Display EditPoint properties.
    MessageBox.Show(
        "AbsoluteCharOffset: " + point.AbsoluteCharOffset + "\n" + 
        "LineCharOffset: " + point.LineCharOffset + "\n" +
        "AtEndOfDocument: " + point.AtEndOfDocument + "\n" + 
        "AtEndOfLine: " + point.AtEndOfLine + "\n" + 
        "AtStartOfDocument: " + point.AtStartOfDocument + "\n" + 
        "AtStartOfLine: " + point.AtStartOfLine);
}

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

EditPoint Interface

EditPoint Members

LineCharOffset Overload

EnvDTE Namespace

Other Resources

How to: Compile and Run the Automation Object Model Code Examples