TextSelection::EndOfDocument Method (Boolean)

 

Moves the object to the end of the document.

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

void EndOfDocument(
	bool Extend = false
)

Parameters

Extend
Type: System::Boolean

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

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.

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
Return to top
Show: