Export (0) Print
Expand All
Cut
Run
Expand Minimize

EndOfDocument Method (TextSelection Object)

Visual Studio .NET 2003

Moves the object to the end of the document.

[Visual Basic .NET]
Public Sub EndOfDocument( _
   Optional ByVal Extend As Boolean = False _
) 
[Visual Basic 6]
Sub EndOfDocument( _
   Optional ByVal Extend As Boolean = False _
) 
[C++]
HRESULT __stdcall EndOfDocument(
   VARIANT_BOOL Extend
);
[C#]
public void EndOfDocument(
   bool Extend
);
[JScript .NET]
public function EndOfDocument(
   Extend : Boolean
)

Parameters

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

Remarks

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

Example

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

See Also

Applies To: TextSelection Object

Show:
© 2015 Microsoft