TextSelection.LineDown(Boolean, Int32) 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 insertion point of the text selection down the specified number of lines.

void LineDown(bool Extend = false, int Count = 1);

[System.Runtime.InteropServices.DispId(36)]
public void LineDown (bool Extend = false, int Count = 1);

[<System.Runtime.InteropServices.DispId(36)>]
abstract member LineDown : bool * int -> unit

Public Sub LineDown (Optional Extend As Boolean = false, Optional Count As Integer = 1)

Parameters

Extend: Boolean

Optional. Determines whether the line in which the insertion point is moved is highlighted. The default is false.

Count: Int32

Optional. Indicates how many lines down to move the insertion point. The default value is 1.

Attributes: DispIdAttribute

Examples

Sub LineUpExample()  
   ' Before running this example, open a text document containing  
   ' at least 5 lines of text.  
   Dim objSel As TextSelection = DTE.ActiveDocument.Selection  
   ' Go to fourth line in document and then move down one line.  
   objSel.GotoLine(4, False)  
   objSel.LineDown(True, 1)  
End Sub

Remarks

LineDown moves the insertion point of the text selection up Count number of lines from its current position. If Extend is true, then the new line is highlighted after the insertion point is moved. If the beginning of the document is encountered before Count lines, then the position remains at the beginning of the document.

LineDown tries to match the display column from the line of origin to the target line, rounding down a character position, if necessary, if it ends up in the middle of a tab on the target line.

If the value of Count is negative, then LineDown performs like the LineUp method.

Applies to