ExpansionProvider.PositionCaretForEditing(IVsTextLines, TextSpan[]) Method

Definition

Namespace:

Microsoft.VisualStudio.Package

Assembly:

Microsoft.VisualStudio.Package.LanguageService.15.0.dll

Package:

Microsoft.VisualStudio.Package.LanguageService.15.0 v17.11.40262

Puts the caret in a position suitable for editing.

public:
 virtual int PositionCaretForEditing(Microsoft::VisualStudio::TextManager::Interop::IVsTextLines ^ pBuffer, cli::array <Microsoft::VisualStudio::TextManager::Interop::TextSpan> ^ ts);

public:
 virtual int PositionCaretForEditing(Microsoft::VisualStudio::TextManager::Interop::IVsTextLines ^ pBuffer, Platform::Array <Microsoft::VisualStudio::TextManager::Interop::TextSpan> ^ ts);

 virtual int PositionCaretForEditing(Microsoft::VisualStudio::TextManager::Interop::IVsTextLines const & pBuffer, std::Array <Microsoft::VisualStudio::TextManager::Interop::TextSpan> const & ts);

public virtual int PositionCaretForEditing (Microsoft.VisualStudio.TextManager.Interop.IVsTextLines pBuffer, Microsoft.VisualStudio.TextManager.Interop.TextSpan[] ts);

abstract member PositionCaretForEditing : Microsoft.VisualStudio.TextManager.Interop.IVsTextLines * Microsoft.VisualStudio.TextManager.Interop.TextSpan[] -> int
override this.PositionCaretForEditing : Microsoft.VisualStudio.TextManager.Interop.IVsTextLines * Microsoft.VisualStudio.TextManager.Interop.TextSpan[] -> int

Public Overridable Function PositionCaretForEditing (pBuffer As IVsTextLines, ts As TextSpan()) As Integer

Parameters

pBuffer

IVsTextLines

The IVsTextLines buffer.

ts

TextSpan[]

An array of TextSpan objects.

Returns

Int32

When overridden in derived classes, S_OK if the method succeeds, otherwise an error code.

Implements

PositionCaretForEditing(IVsTextLines, TextSpan[])

Remarks

This method is an implementation of PositionCaretForEditing. By default it does nothing and returns S_OK.