CompletionContext Class

Definition

Namespace:

Microsoft.VisualStudio.Language.Intellisense.AsyncCompletion.Data

Assembly:

Microsoft.VisualStudio.Language.dll

Package:

Microsoft.VisualStudio.Language v17.9.187

This type is used to transfer data from IAsyncCompletionSource to IAsyncCompletionBroker and further to IAsyncCompletionItemManager

public ref class CompletionContext sealed

[System.Diagnostics.DebuggerDisplay("{ItemList.Count} items")]
public sealed class CompletionContext

[<System.Diagnostics.DebuggerDisplay("{ItemList.Count} items")>]
type CompletionContext = class

Public NotInheritable Class CompletionContext

Inheritance

Object

CompletionContext

Attributes

DebuggerDisplayAttribute

Constructors

CompletionContext(CompletionList<CompletionItem>, SuggestionItemOptions, InitialSelectionHint, ImmutableArray<CompletionFilterWithState>, Boolean, PropertyCollection)	Constructs CompletionContext with specified CompletionItems, with recommendation to use suggestion mode item and to use a specific selection mode.
CompletionContext(ImmutableArray<CompletionItem>)	[Deprecated] Constructs CompletionContext with specified CompletionItems, with recommendation to not use suggestion mode and to use use regular selection. Note: completion will iterate through all items to determine filters. For better performance, use the overload which accepts ImmutableArray<T>
CompletionContext(ImmutableArray<CompletionItem>, ImmutableArray<CompletionFilterWithState>)	Constructs CompletionContext with specified CompletionItems and CompletionFilterWithStates with recommendation to not use suggestion mode and to use use regular selection.
CompletionContext(ImmutableArray<CompletionItem>, ImmutableArray<CompletionFilterWithState>, Boolean)	Constructs CompletionContext with specified CompletionItems and CompletionFilterWithStates with recommendation to not use suggestion mode and to use use regular selection.
CompletionContext(ImmutableArray<CompletionItem>, SuggestionItemOptions)	Constructs CompletionContext with specified CompletionItems, with recommendation to use suggestion mode and to use regular selection. Note: completion will iterate through all items to determine filters. For better performance, use the overload which accepts ImmutableArray<T>
CompletionContext(ImmutableArray<CompletionItem>, SuggestionItemOptions, InitialSelectionHint)	Constructs CompletionContext with specified CompletionItems, with recommendation to use suggestion mode item and to use a specific selection mode. Note: completion will iterate through all items to determine filters. For better performance, use the overload which accepts ImmutableArray<T>
CompletionContext(ImmutableArray<CompletionItem>, SuggestionItemOptions, InitialSelectionHint, ImmutableArray<CompletionFilterWithState>)	Constructs CompletionContext with specified CompletionItems, with recommendation to use suggestion mode item and to use a specific selection mode.
CompletionContext(ImmutableArray<CompletionItem>, SuggestionItemOptions, InitialSelectionHint, ImmutableArray<CompletionFilterWithState>, Boolean)	Constructs CompletionContext with specified CompletionItems, with recommendation to use suggestion mode item and to use a specific selection mode.
CompletionContext(ImmutableArray<CompletionItem>, SuggestionItemOptions, InitialSelectionHint, ImmutableArray<CompletionFilterWithState>, Boolean, PropertyCollection)	Constructs CompletionContext with specified CompletionItems, with recommendation to use suggestion mode item and to use a specific selection mode.

Properties

Empty	Empty completion context, when IAsyncCompletionSource offers no items pertinent to given location.
Filters	Set of completion filters available for this session. Each filter's IsSelected property is used to determine initial selection. The IsAvailable property is ignored. Typically, this is used to select CompletionExpanders that correspond to provided CompletionItems, in scenarios when the completion source provides expanded items by default.
IsIncomplete	When set, subsequent typing will dispatch another request for CompletionContext. This gives the completion source a chance to provide more items.
ItemList	Set of completion items available at a location
Items	Obsolete. Set of completion items available at a location
Properties	Optional property bag which, when present, will be merged with IAsyncCompletionSession.Properties.
SelectionHint	Recommends the initial selection method for the completion list. When SuggestionItemOptions is defined, "soft selection" will be used without a need to set this property.
SuggestionItemOptions	When defined, uses suggestion mode with options specified in this object. When null, this context does not activate the suggestion mode. Suggestion mode puts selection in "soft selection" mode without need to set SelectionHint