EditPoint.AtEndOfDocument Property

Definition

Namespace:

EnvDTE

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Gets a value indicating whether or not the object is at the end of the document.

public:
 property bool AtEndOfDocument { bool get(); };

public:
 property bool AtEndOfDocument { bool get(); };

[System.Runtime.InteropServices.DispId(21)]
public bool AtEndOfDocument { [System.Runtime.InteropServices.DispId(21)] get; }

[<System.Runtime.InteropServices.DispId(21)>]
[<get: System.Runtime.InteropServices.DispId(21)>]
member this.AtEndOfDocument : bool

Public ReadOnly Property AtEndOfDocument As Boolean

Property Value

Boolean

true if you are at the end of the document; otherwise, false.

Implements

AtEndOfDocument

Attributes

DispIdAttribute

Examples

Sub AtEndOfDocumentExample(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 & _  
        "AtEndOfDocument: " & point.AtEndOfDocument & vbCrLf & _  
        "AtEndOfLine: " & point.AtEndOfLine & vbCrLf & _  
        "AtStartOfDocument: " & point.AtStartOfDocument & vbCrLf & _  
        "AtStartOfLine: " & point.AtStartOfLine)  

End Sub  

public void AtEndOfDocumentExample(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");  

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