TextSelection.EndOfDocument Method
Moves the object to the end of the document.
Namespace: EnvDTE
Assembly: EnvDTE (in EnvDTE.dll)
Syntax
'Declaration
Sub EndOfDocument ( _
Extend As Boolean _
)
void EndOfDocument(
bool Extend
)
void EndOfDocument(
[InAttribute] bool Extend
)
abstract EndOfDocument :
Extend:bool -> unit
function EndOfDocument(
Extend : boolean
)
Parameters
- Extend
Type: System.Boolean
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.
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
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.