EditPoint.Unindent(TextPoint, Int32) Method

Reference

Definition

Namespace:: EnvDTE

Assembly:: EnvDTE.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

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.

Removes the indent characters from the selected lines by the given number of indentation levels.

void Unindent(EnvDTE::TextPoint const & Point = null, int Count = 1);

[System.Runtime.InteropServices.DispId(162)]
public void Unindent (EnvDTE.TextPoint Point = default, int Count = 1);

[<System.Runtime.InteropServices.DispId(162)>]
abstract member Unindent : EnvDTE.TextPoint * int -> unit

Public Sub Unindent (Optional Point As TextPoint = Nothing, Optional Count As Integer = 1)

Parameters

Point: TextPoint

Optional. The endpoint. Defaults to the endpoint, causing the current line in the buffer to be outdented. The default value is one indentation level.

Count: Int32

Optional. The number of display columns to indent each line. The default is 1.

Attributes: DispIdAttribute

Examples

Sub UnindentExample()  
  ' Before running this example, open a text document.  
  Dim objTD As TextDocument  
  Dim objEP As EditPoint  

  objTD = DTE.ActiveDocument.Object("TextDocument")  
  objEP = objTD.StartPoint.CreateEditPoint  
  objEP.Indent(,10)  
  objEP.Unindent(,5)  
End Sub

Remarks

Unindent removes Count levels of indentation from each line between the edit point and Point, including the lines that contain these endpoints. The number of columns that display in a level of indentation is determined by a global setting. Tabs and characters are deleted and inserted as necessary to remove one indentation level according to the current global settings for tab size and indent level size.

If Count is negative, then Unindent performs similarly to Indent.

Unindent fails if Count is greater than or equal to 10,000.

Applies to

Compartilhar via