ExpansionProvider.PositionCaretForEditing Method

Article
04/29/2015

Puts the caret in a position suitable for editing.

Namespace: Microsoft.VisualStudio.Package
Assemblies:   Microsoft.VisualStudio.Package.LanguageService.11.0 (in Microsoft.VisualStudio.Package.LanguageService.11.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.12.0 (in Microsoft.VisualStudio.Package.LanguageService.12.0.dll)
  Microsoft.VisualStudio.Package.LanguageService (in Microsoft.VisualStudio.Package.LanguageService.dll)
  Microsoft.VisualStudio.Package.LanguageService.9.0 (in Microsoft.VisualStudio.Package.LanguageService.9.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.10.0 (in Microsoft.VisualStudio.Package.LanguageService.10.0.dll)

Syntax

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

public virtual int PositionCaretForEditing(
    IVsTextLines pBuffer,
    TextSpan[] ts
)

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

abstract PositionCaretForEditing : 
        pBuffer:IVsTextLines * 
        ts:TextSpan[] -> int  
override PositionCaretForEditing : 
        pBuffer:IVsTextLines * 
        ts:TextSpan[] -> int

public function PositionCaretForEditing(
    pBuffer : IVsTextLines, 
    ts : TextSpan[]
) : int

Parameters

pBuffer
Type: Microsoft.VisualStudio.TextManager.Interop.IVsTextLines

The IVsTextLines buffer.

ts
Type: array<Microsoft.VisualStudio.TextManager.Interop.TextSpan[]

An array of TextSpan objects.

Return Value

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

Implements

IVsExpansionClient.PositionCaretForEditing(IVsTextLines, array<TextSpan[])

Remarks

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

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via