IVsExpansionClient::PositionCaretForEditing Method (IVsTextLines^, array<TextSpan>^)

Visual Studio 2015

Called to position the edit caret in the specified place in a code snippet after it has been inserted and formatted.

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

Syntax

C++

int PositionCaretForEditing(
	IVsTextLines^ pBuffer,
	array<TextSpan>^ ts
)

Parameters

pBuffer: Type: Microsoft.VisualStudio.TextManager.Interop::IVsTextLines^
[in] An IVsTextLines object that represents the text buffer where the code snippet has been inserted.

ts: Type: array<Microsoft.VisualStudio.TextManager.Interop::TextSpan>^
[in] A TextSpan object that describes the location where the code snippet was inserted.

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 textmgr2.idl:

C++

HRESULT IVsExpansionClient::PositionCaretForEditing(
   [in]IVsTextLines *pBuffer,
   [in]TextSpan *ts
);

This method is called after the edit caret has been positioned according to the notations in the code snippet file. This method provides an opportunity to override the normal placement of the edit caret but is rarely used.