CommitBehavior Enum
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Instructs the editor how to behave after committing a CompletionItem.
This enumeration supports a bitwise combination of its member values.
public enum class CommitBehavior[System.Flags]
public enum CommitBehavior[<System.Flags>]
type CommitBehavior = Public Enum CommitBehavior- Inheritance
-
CommitBehavior
- Attributes
Fields
| Name | Value | Description |
|---|---|---|
| None | 0 | Use the default behavior, that is, to propagate TypeChar command, but suppress ReturnKey and TabKey commands. |
| SuppressFurtherTypeCharCommandHandlers | 1 | Suppresses further invocation of the TypeChar and other command handlers, which typically act after completion. By default, editor invokes these command handlers to enable features such as brace completion or automatic line ending. |
| RaiseFurtherReturnKeyAndTabKeyCommandHandlers | 2 | Raises further invocation of the ReturnKey and Tab command handlers, which typically are suppressed after completion. By default, editor doesn't invoke ReturnKey and Tab command handlers after committing completion session. |
| CancelCommit | 4 | Cancels the commit operation, does not call any other TryCommit(IAsyncCompletionSession, ITextBuffer, CompletionItem, Char, CancellationToken). Functionally, acts as if the typed character was not a commit character, allowing the user to continue working with the IAsyncCompletionSession |
| Retrigger | 8 | Ensures that another completion session is triggered, even though user committed the current one with gestures that don't trigger new sessions, for example mouse, Ctrl+Space or TAB. Without this flag set, new session will trigger only if previous one was committed with a trigger character, and SuppressFurtherTypeCharCommandHandlers flag was not used. |