CompletionSession Class

public class CompletionSession : IntelliPromptSessionBase, ICompletionSession, IIntelliPromptSession, IServiceLocator, IEditorDocumentTextChangeEventSink, IEditorViewKeyInputEventSink, IEditorViewPointerInputEventSink, IEditorViewSelectionChangeEventSink, IEditorViewTextInputEventSink

public CompletionSession()

public CharClass AllowedCharacters { get; set; }

Property Value

CharClass

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.

public override Rectangle? Bounds { get; }

Property Value

Rectangle?

public bool CanCommitWithoutPopup { get; set; }

Property Value

bool:

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.

public bool CanFilterUnmatchedItems { get; set; }

Property Value

bool:

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.

public bool CanHighlightMatchedText { get; set; }

Property Value

bool:

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

protected override bool CanOpenForReadOnlyTextRanges { get; }

Property Value

bool:

true if the session is able to be opened for read-only text ranges; otherwise, false. The default value is true.

public override bool ClosesOnLostFocus { get; }

Property Value

bool:

true if this session auto-closes when the editor or any IntelliPrompt popups lose focus; otherwise, false.

public CharClass CommitCharacters { get; set; }

Property Value

CharClass

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.

public object? Context { get; set; }

Property Value

object

public double ControlKeyDownOpacity { get; set; }

Property Value

double:

The default value is 0.25.

Remarks

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

public int DescriptionTipMaxWidth { get; set; }

Property Value

int:

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

public TimeSpan DescriptionTipShowDelay { get; set; }

Property Value

TimeSpan:

The default value is 400ms.

public ICompletionItemCollectionView FilteredItems { get; }

Property Value

ICompletionItemCollectionView

public ICompletionFilterCollection Filters { get; }

Property Value

ICompletionFilterCollection

public bool IsEnterKeyHandledOnCommit { get; set; }

Property Value

bool:

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.

public ICompletionItemMatcherCollection ItemMatchers { get; }

Property Value

ICompletionItemMatcherCollection

public ICompletionItemCollection Items { get; }

Property Value

ICompletionItemCollection

public CompletionMatchOptions MatchOptions { get; set; }

Property Value

CompletionMatchOptions

protected virtual Rectangle? PlacementRectangle { get; }

Property Value

Rectangle?

protected virtual IUIElement? PlacementTarget { get; }

Property Value

IUIElement

Remarks

The view will be used if this property returns null.

public bool RequiresFilterOnTextChange { get; set; }

Property Value

bool:

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

public CompletionSelection? Selection { get; set; }

Property Value

CompletionSelection

public override IIntelliPromptSessionType SessionType { get; }

Property Value

IIntelliPromptSessionType

public string TypedText { get; }

Property Value

string

public void ApplyFilters()

public void Cancel()

public void CloseDescriptionTip()

public void Commit()

protected virtual IntelliPromptCompletionList CreatePopupContent()

Returns

IntelliPromptCompletionList

protected override void OnClosed(CancelEventArgs e)

Parameter	Type	Description
e	CancelEventArgs	The event data.

protected virtual void OnCommitted(EventArgs e)

Parameter	Type	Description
e	EventArgs	The event data.

protected virtual void OnCommitting(CancelEventArgs e)

Parameter	Type	Description
e	CancelEventArgs	The event data.

protected virtual void OnDocumentTextChanged(SyntaxEditor editor, EditorSnapshotChangedEventArgs e)

Parameter	Type	Description
editor	SyntaxEditor	The SyntaxEditor whose IEditorDocument is changed.
e	EditorSnapshotChangedEventArgs	The event data.

protected virtual void OnDocumentTextChanging(SyntaxEditor editor, EditorSnapshotChangingEventArgs e)

Parameter	Type	Description
editor	SyntaxEditor	The SyntaxEditor whose IEditorDocument is changed.
e	EditorSnapshotChangingEventArgs	The event data.

protected override void OnOpened(EventArgs e)

Parameter	Type	Description
e	EventArgs	The event data.

protected virtual void OnSelectionChanged(EventArgs e)

Parameter	Type	Description
e	EventArgs	The event data.

protected virtual void OnViewKeyDown(IEditorView view, KeyEventArgs e)

Parameter	Type	Description
view	IEditorView	The IEditorView that received the event.
e	KeyEventArgs	The event data.

protected virtual void OnViewKeyUp(IEditorView view, KeyEventArgs e)

Parameter	Type	Description
view	IEditorView	The IEditorView that received the event.
e	KeyEventArgs	The event data.

protected virtual void OnViewPointerPressed(IEditorView view, InputPointerButtonEventArgs e)

Parameter	Type	Description
view	IEditorView	The IEditorView that received the event.
e	InputPointerButtonEventArgs	The event data.

protected virtual void OnViewSelectionChanged(IEditorView view, EditorViewSelectionEventArgs e)

Parameter	Type	Description
view	IEditorView	The IEditorView that received the event.
e	EditorViewSelectionEventArgs	The event data.

protected virtual void OnViewTextInput(IEditorView view, TextCompositionEventArgs e)

Parameter	Type	Description
view	IEditorView	The IEditorView that received the event.
e	TextCompositionEventArgs	The TextCompositionEventArgs that contains the event data.

public void Open(IEditorView view)

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

public override void Reposition()

public void RestartDescriptionTipTimer()

public 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.

public 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.

protected virtual TextSnapshotRange TranslateTrackedSnapshotRange(TextSnapshotRange snapshotRange, ITextSnapshot targetSnapshot)

Parameter	Type	Description
snapshotRange	TextSnapshotRange	The TextSnapshotRange to translate.
targetSnapshot	ITextSnapshot	The target ITextSnapshot.

Returns

TextSnapshotRange:

The translated TextSnapshotRange.

public event EventHandler? Committed

Event Type

EventHandler

public event EventHandler<CancelEventArgs>? Committing

Event Type

EventHandler<CancelEventArgs>

public event EventHandler? SelectionChanged

Event Type

EventHandler