OutdentLines Method

Outdents a block of lines (i.e. removes leading whitepsace).

Syntax

Visual Basic

'Declaration
 
Public Function OutdentLines( _
   ByVal lineIndex As Integer, _
   ByVal lineCount As Integer _
) As Boolean

C#

public bool OutdentLines( 
   int lineIndex,
   int lineCount
)

Parameters

lineIndex

The zero-based index of the first line to outdent.

lineCount

The total number of lines to outdent.

Return Value

True if the operation was successful, otherwise false.

Exceptions

Exception	Description
System.InvalidOperationException	If the IsReadOnly property is set to true or if this method is called in the middle of an update operation, e.g. from within a TextChanging event handler.
System.ArgumentOutOfRangeException	If lineIndex is less than 0 or lineIndex plus lineCount greater than 1 minus the number of lines in the document.

Remarks

Note: the amount and type of whitespace removed is determined by the TabExtent property setting.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2