CompletionSession Class

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

public CompletionSession()

public CharClass AllowedCharacters { get; set; }

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.

public override Rect? Bounds { get; }

Property Value

Rect?:

The view-relative bounds of the session's open popup, if available.

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

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:

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.

public object Context { get; set; }

Property Value

object:

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

public double ControlKeyDownOpacity { get; set; }

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.

public double DescriptionTipMaxWidth { get; set; }

Property Value

double:

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 TimeSpan to wait after the selection is updated before showing the description tip. The default value is 400ms.

public ICompletionItemCollectionView FilteredItems { get; }

Property Value

ICompletionItemCollectionView:

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

public ICompletionFilterCollection Filters { get; }

Property Value

ICompletionFilterCollection:

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

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:

The collection of ICompletionItemMatcher objects to use when matching items.

public ICompletionItemCollection Items { get; }

Property Value

ICompletionItemCollection:

The collection of ICompletionItem objects within the completion.

public CompletionMatchOptions MatchOptions { get; set; }

Property Value

CompletionMatchOptions:

The CompletionMatchOptions indicating the options to use when matching items.

protected virtual Rect? PlacementRectangle { get; }

Property Value

Rect?:

The placement System.Windows.Rect, if known, around which the session should be placed.

protected virtual UIElement PlacementTarget { get; }

Property Value

UIElement:

The placement target for the session, if known.

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:

A CompletionSelection indicating the current selection within the completion.

public override IIntelliPromptSessionType SessionType { get; }

Property Value

IIntelliPromptSessionType:

The IIntelliPromptSessionType that identifies the type of session.

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

public void ApplyFilters()

public void Cancel()

public void CloseDescriptionTip()

public void Commit()

protected virtual IntelliPromptCompletionList CreatePopupContent()

Returns

IntelliPromptCompletionList:

The control that was created.

protected override void OnClosed(CancelEventArgs e)

Parameter	Type	Description
e	CancelEventArgs	An CancelEventArgs that contains the event data.

protected virtual void OnCommitted(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected virtual void OnCommitting(CancelEventArgs e)

Parameter	Type	Description
e	CancelEventArgs	An CancelEventArgs that contains 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 EditorSnapshotChangedEventArgs that contains 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 EditorSnapshotChangingEventArgs that contains the event data.

protected override void OnOpened(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected virtual void OnRequestNavigate(RequestNavigateEventArgs e)

Parameter	Type	Description
e	RequestNavigateEventArgs	An RequestNavigateEventArgs that contains the event data.

protected virtual void OnSelectionChanged(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains 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 KeyEventArgs that contains 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 KeyEventArgs that contains 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 InputPointerButtonEventArgs that contains 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 EditorViewSelectionEventArgs that contains 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 RequestNavigateEventHandler RequestNavigate

Event Type

RequestNavigateEventHandler

public event EventHandler SelectionChanged

Event Type

EventHandler