EditPoint.LineLength Property

Definition

Namespace:

EnvDTE

Assembly:

Microsoft.VisualStudio.Interop.dll

Gets the number of characters in a line.

public:
 property int LineLength { int get(); };

public:
 property int LineLength { int get(); };

[System.Runtime.InteropServices.DispId(25)]
public int LineLength { [System.Runtime.InteropServices.DispId(25)] get; }

[<System.Runtime.InteropServices.DispId(25)>]
[<get: System.Runtime.InteropServices.DispId(25)>]
member this.LineLength : int

Public ReadOnly Property LineLength As Integer

Property Value

Int32

The number of characters in a line containing the EditPoint object, excluding the new line character.

Implements

LineLength

Attributes

DispIdAttribute

Examples

Sub LineLengthExample(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  

    point.StartOfDocument()  

    ' 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 & vbCrLf & _  
        "LineLength: " & point.LineLength)  

End Sub  

public void LineLengthExample(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 = 1; i <= 10; ++i)  
        point.Insert("This is a test.\n");  

    point.StartOfDocument();  

    // 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 + "\n" +  
        "LineLength: " + point.LineLength);  
}  

Remarks

Character numbering begins at one.