TextSelection.Indent(Int32) Method

Reference

Definition

Namespace:: EnvDTE

Assembly:: EnvDTE.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

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.

Indents the selected lines by the given number of indentation levels.

void Indent(int Count = 1);

[System.Runtime.InteropServices.DispId(33)]
public void Indent (int Count = 1);

[<System.Runtime.InteropServices.DispId(33)>]
abstract member Indent : int -> unit

Public Sub Indent (Optional Count As Integer = 1)

Parameters

Count: Int32

Optional. The number of display indent levels to indent each line in the text selection. The default is 1.

Attributes: DispIdAttribute

Examples

Sub IndentExample()  
   ' Before running this example, open a text document.  
   Dim objSel As TextSelection = DTE.ActiveDocument.Selection  
   ' Go to first line in document and indent it.  
   objSel.GotoLine(1, False)  
   objSel.Indent(1)  
End Sub

Remarks

Indent indents the text selection by the number of display columns indicated by the global setting for one indentation level. Indent does not do smart formatting or indent lines based on the context of the code. Tabs and spaces are inserted, depending on the global setting for whether to use tabs when indenting. The indentation may consist of multiple tab and space characters, depending on the global setting for how many spaces a tab equals.

Indent behaves differently depending on whether the text selection is continuous or columnar. If it is continuous, all lines partially or completely within the selection, are indented at the first column. If it is a columnar selection, the text selection is indented at the left edge of the selection.

Indent behavior depends on whether the text selection is the entire line or only a portion of it. If only a portion of the line is selected, the selected portion is deleted and the remainder is indented either one indent level or Count number of columns.

If the value of Count is negative, then Indent performs like the Unindent method.

Indent fails if the value of Count is greater than or equal to 10,000.

Applies to

Condividi tramite