TextSelection.EndOfDocument(Boolean) Method

Reference

Definition

Namespace:: EnvDTE

Assembly:: EnvDTE.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Moves the object to the end of the document.

void EndOfDocument(bool Extend = false);

[System.Runtime.InteropServices.DispId(28)]
public void EndOfDocument (bool Extend = false);

[<System.Runtime.InteropServices.DispId(28)>]
abstract member EndOfDocument : bool -> unit

Public Sub EndOfDocument (Optional Extend As Boolean = false)

Parameters

Extend: Boolean

Optional. Determines whether the moved text is collapsed or not. The default is false.

Attributes: DispIdAttribute

Examples

Sub EndOfDocumentExample()  
    ' Before running this example, open a text document.  
    Dim objSel As TextSelection = DTE.ActiveDocument.Selection  
    Dim objAnchor As VirtualPoint = objSel.AnchorPoint  
    ' objAnchor is "live", tied to the position of the actual   
    ' selection, so it will reflect any changes. iCol and iRow are   
    ' created here to save a "snapshot" of the anchor point's position   
    ' at this time.  
    Dim iCol As Long = objAnchor.DisplayColumn  
    Dim iRow As Long = objAnchor.Line  
    ' As the selection is extended, the active point moves but the   
    ' anchor point remains in place.  
    objSel.StartOfDocument(True)  
    objSel.EndOfDocument(True)  

    If (iCol = objAnchor.DisplayColumn And iRow = objAnchor.Line) Then  
        MsgBox("The anchor point has remained in place at row " & iRow & ", display column " & iCol)  
    End If  
End Sub

Remarks

If Extend is true, then only the active end of the text selection is moved. Otherwise, the text selection is collapsed and positioned at the end of the document.

Applies to