IVsExpansionSession.GoToNextExpansionField Method

Article
03/11/2013

Move the highlight to the next field in order.

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

Syntax

'Declaration
Function GoToNextExpansionField ( _
    fCommitIfLast As Integer _
) As Integer

int GoToNextExpansionField(
    int fCommitIfLast
)

int GoToNextExpansionField(
    [InAttribute] int fCommitIfLast
)

abstract GoToNextExpansionField : 
        fCommitIfLast:int -> int

function GoToNextExpansionField(
    fCommitIfLast : int
) : int

Parameters

fCommitIfLast
Type: System.Int32
[in] Non-zero (TRUE) if to commit all changes to the code snippet if moving off the last field; otherwise, zero (FALSE) if to move to the first field.

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:

HRESULT IVsExpansionSession::GoToNextExpansionField(
   [in]bool fCommitIfLast
);

This method is used in support of the special edit mode that is entered after a code snippet is inserted. Typically, this method is called in response to the user typing the Tab key. If you do not wish to support cycling through the fields with the Tab key, set the fCommitIfLast parameter to non-zero (TRUE): this causes all changes made to the code snippet to be committed when attempting to Tab off the last field in the code snippet.

.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