ICompletionSession Interface

public interface ICompletionSession : IIntelliPromptSession, IServiceLocator

CharClass AllowedCharacters { get; }

Property Value

CharClass:

The CharClass containing the non-letter/digit characters allowed to be typed while the completion popup is displayed.

Remarks

All letter and digit characters are automatically allowed by the completion popup and therefore do not need to added to this property. This property should only contain additional non-letter/digit characters that need to be allowed.

When a character is typed, it's first checked to see if it's a letter, number, or is in the AllowedCharacters collection. If any of those cases is true, the character is entered into the editor and the session remains open. If instead the character is in the CommitCharacters collection and there is a full selection in the completion list, a Commit() occurs. Otherwise, the session is cancelled.

bool CanCommitWithoutPopup { get; }

Property Value

Boolean:

true if the session can immediately commit if a single match is made when the session is opened; otherwise, false. The default value is true.

Remarks

A value of false will force the popup list to always display, even if a single match is made upon open.

bool CanFilterUnmatchedItems { get; }

Property Value

Boolean:

true if items that don't match the typed text should be filtered out, thereby shrinking the list of visible items; otherwise, false. The default value is false.

bool CanHighlightMatchedText { get; }

Property Value

Boolean:

true if list items show possible matched characters in a highlight color; otherwise, false. The default value is true.

CharClass CommitCharacters { get; }

Property Value

CharClass:

The CharClass containing the characters that can be typed when there is a full selection to trigger a Commit().

Remarks

The default value of this property is a CharClass that contains all characters.

When a character is typed, it's first checked to see if it's a letter, number, or is in the AllowedCharacters collection. If any of those cases is true, the character is entered into the editor and the session remains open. If instead the character is in the CommitCharacters collection and there is a full selection in the completion list, a Commit() occurs. Otherwise, the session is cancelled.

object Context { get; }

Property Value

Object:

An object that describes the context in which the completion session is opened.

double ControlKeyDownOpacity { get; }

Property Value

Double:

The opacity of the popup while the control key is pressed. The default value is 0.25.

Remarks

Set the value to 1.0 to prevent opacity changes when the control key is pressed.

double DescriptionTipMaxWidth { get; }

Property Value

Double:

The description tip popup's maximum width, or NaN to indicate no constraint. The default value is 800.

TimeSpan DescriptionTipShowDelay { get; }

Property Value

TimeSpan:

The TimeSpan to wait after the selection is updated before showing the description tip. The default value is 400ms.

ICompletionItemCollectionView FilteredItems { get; }

Property Value

ICompletionItemCollectionView:

The read-only collection of filtered ICompletionItem objects that are visible within the completion list.

ICompletionFilterCollection Filters { get; }

Property Value

ICompletionFilterCollection:

The collection of ICompletionFilter objects that can be applied to the session.

bool IsEnterKeyHandledOnCommit { get; }

Property Value

Boolean:

true if the Enter key is handled (not allowed to insert a line feed) when it commits the session; otherwise, false. The default value is true.

ICompletionItemMatcherCollection ItemMatchers { get; }

Property Value

ICompletionItemMatcherCollection:

The collection of ICompletionItemMatcher objects to use when matching items.

ICompletionItemCollection Items { get; }

Property Value

ICompletionItemCollection:

The collection of ICompletionItem objects within the completion.

CompletionMatchOptions MatchOptions { get; }

Property Value

CompletionMatchOptions:

The CompletionMatchOptions indicating the options to use when matching items.

bool RequiresFilterOnTextChange { get; set; }

Property Value

Boolean:

true if filters should be applied when a text change occurs; otherwise, false. The default value is false.

CompletionSelection Selection { get; set; }

Property Value

CompletionSelection:

A CompletionSelection indicating the current selection within the completion.

string TypedText { get; }

Property Value

String:

The text that has been used to initialize the session and/or been entered by the end user since the session opened.

void ApplyFilters()

void Cancel()

void CloseDescriptionTip()

void Commit()

void Open(IEditorView view)

Parameter	Type	Description
view	IEditorView	The IEditorView in which the session is opened.

void RestartDescriptionTipTimer()

void SortItems()

Remarks

Items should always be sorted before the session is opened for an optimal user experience. This method should be called to sort the items right before the session is opened if the items were not pre-sorted.

void SortItems(IComparer<ICompletionItem> comparer)

Parameter	Type	Description
comparer	IComparer<ICompletionItem>	The IComparer<T> to use.

Remarks

Items should always be sorted before the session is opened for an optimal user experience. This method should be called to sort the items right before the session is opened if the items were not pre-sorted.

event EventHandler Committed

Event Type

EventHandler

event EventHandler<CancelEventArgs> Committing

Event Type

EventHandler<CancelEventArgs>

event RequestNavigateEventHandler RequestNavigate

Event Type

RequestNavigateEventHandler

event EventHandler SelectionChanged

Event Type

EventHandler