IVsExpansionSession.GoToNextExpansionField(Int32) Method

Definition

Namespace:

Microsoft.VisualStudio.TextManager.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Move the highlight to the next field in order.

public:
 int GoToNextExpansionField(int fCommitIfLast);

public:
 int GoToNextExpansionField(int fCommitIfLast);

int GoToNextExpansionField(int fCommitIfLast);

public int GoToNextExpansionField (int fCommitIfLast);

abstract member GoToNextExpansionField : int -> int

Public Function GoToNextExpansionField (fCommitIfLast As Integer) As Integer

Parameters

fCommitIfLast

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.

Returns

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.