IVsTextView::PositionCaretForEditing Method (Int32, Int32)

Visual Studio 2015

Puts the caret in a position suitable for editing a function.

Namespace: Microsoft.VisualStudio.TextManager.Interop
Assembly: Microsoft.VisualStudio.TextManager.Interop (in Microsoft.VisualStudio.TextManager.Interop.dll)

Syntax

C++

int PositionCaretForEditing(
	int iLine,
	int cIndentLevels
)

Parameters

iLine: Type: System::Int32
[in] Integer containing the line to position the caret (cursor) on.

cIndentLevels: Type: System::Int32
[in] Count of indent levels.

Return Value

Type: System::Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From textmgr.idl:

C++

HRESULT IVsTextView::PositionCaretForEditing(
   [in] long iLine,
   [in] long cIndentLevels
);

This method places the caret in a position suitable for editing a function. If there is text on the line, the caret goes to the first non-white space character. Otherwise, this method creates the appropriate number of indentations (cIndentLevels) according to the current language settings and places the caret at this location. No centering is done.