Modern completion API

Contents #

• CompletionContext
  • #ctor(items,applicableSpan)
  • #ctor(items,applicableSpan,availableFilters)
  • #ctor(items,applicableSpan,availableFilters,useSoftSelection,useSuggestionMode,suggestionModeDescription)
  • ApplicableToSpan
  • AvailableFilters
  • Items
  • SuggestionModeDescription
  • UseSoftSelection
  • UseSuggestionMode
• CompletionFilter
  • #ctor(displayText,accessKey,icon)
  • AccessKey
  • DisplayText
  • Icon
• CompletionFilterChangedEventArgs
  • #ctor(filters)
  • Filters
• CompletionFilterWithState
  • #ctor(filter,isAvailable)
  • #ctor(filter,isAvailable,isSelected)
  • Filter
  • IsAvailable
  • IsSelected
  • WithAvailability(availability)
  • WithSelected(availability)
• CompletionItem
• CompletionItemWithHighlight
  • #ctor(completionItem)
  • #ctor(completionItem,highlightedSpans)
  • Empty
  • CompletionItem
  • HighlightedSpans
• CompletionList
  • #ctor(items,selectedItemIndex,filters)
  • #ctor(items,selectedItemIndex)
  • Filters
  • Items
  • SelectedItemIndex
• CompletionPresentation
  • #ctor(items,filters,applicableSpan,useSoftSelection,useSuggestionMode,selectSuggestionMode,selectedItemIndex,suggestionModeItem)
  • ApplicableSpan
  • Filters
  • Items
  • SelectedItemIndex
  • SelectSuggestionMode
  • SuggestionModeItem
  • UseSoftSelection
  • UseSuggestionMode
• CompletionTrigger
  • #ctor(kind,edit)
  • #ctor(kind)
  • Edit
  • Kind
• CompletionTriggerReason
  • Command
  • Deletion
  • Insertion
  • InvokeAndCommitIfUnique
  • Snippets
• IAsyncCompletionBroker
  • Commit(view,edit)
  • Dismiss(view)
  • IsCompletionActive(view)
  • OpenOrUpdate(view,trigger,trackedEdit,triggerLocation)
  • SelectDown(view)
  • SelectPageDown(view)
  • SelectPageUp(view)
  • SelectUp(view)
  • ShouldCommitCompletion(view,edit,triggerLocation)
  • ShouldTriggerCompletion(view,edit,triggerLocation)
  • TriggerCompletion(view,triggerLocation)
• IAsyncCompletionItemSource
  • CustomCommit(view,buffer,item,applicableSpan,edit)
  • GetCompletionContextAsync(trigger,triggerLocation)
  • GetDescriptionAsync(item)
  • GetPotentialCommitCharacters()
  • HandleViewClosedAsync(view)
  • ShouldCommitCompletion()
  • ShouldTriggerCompletion()
• IAsyncCompletionService
  • UpdateCompletionListAsync(originalList,snapshot,applicableToSpan,availableFilters)
• IAsyncCompletionSession
  • Commit(view,edit)
  • Commit(view,edit,itemToCommit)
  • DismissAndHide()
  • OpenOrUpdate(view,trigger,applicableSpan,triggerLocation)
  • SelectDown()
  • SelectPageDown()
  • SelectPageUp()
  • SelectUp()
  • ShouldCommit(view,edit,triggerLocation)
• ICompletionUI
  • Hide()
  • Open(presentation)
  • SetSelection(selectedIndex)
  • Update(presentation)
• ICompletionUIProvider
  • ResultsPerPage
  • GetUI(textView)
• ImageMoniker
  • Guid
  • Id

Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition.net46 # =

CompletionContext # =

Namespace

Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition

Summary

This struct is used to transfer data from IAsyncCompletionItemSource to IAsyncCompletionBroker and further to IAsyncCompletionService

#ctor(items,applicableSpan) constructor # =

Summary

Constructs CompletionContext with CompletionItem applicable to a SnapshotSpan

Parameters

Name	Type	Description
items	System.Collections.Generic.IEnumerable{Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition.CompletionItem}	Available completion items
applicableSpan	Microsoft.VisualStudio.Text.SnapshotSpan	Completion list will be filtered by contents of this span

#ctor(items,applicableSpan,availableFilters) constructor # =

Summary

Constructs CompletionContext with CompletionItem applicable to a SnapshotSpan and CompletionFilter available for these items.

Parameters

Name	Type	Description
items	System.Collections.Generic.IEnumerable{Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition.CompletionItem}	Available completion items
applicableSpan	Microsoft.VisualStudio.Text.SnapshotSpan	Completion list will be filtered by contents of this span
availableFilters	System.Collections.Immutable.ImmutableArray{Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition.CompletionFilter}	Completion filters available for these completion items

#ctor(items,applicableSpan,availableFilters,useSoftSelection,useSuggestionMode,suggestionModeDescription) constructor # =

Summary

Constructs CompletionContext with CompletionItem applicable to a SnapshotSpan, CompletionFilter available for these items and instructions on suggestion mode and soft selection.

Parameters

Name	Type	Description
items	System.Collections.Generic.IEnumerable{Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition.CompletionItem}	Available completion items
applicableSpan	Microsoft.VisualStudio.Text.SnapshotSpan	Completion list will be filtered by contents of this span
availableFilters	System.Collections.Immutable.ImmutableArray{Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition.CompletionFilter}	Completion filters available for these completion items
useSoftSelection	System.Boolean	Whether UI should use soft selection
useSuggestionMode	System.Boolean	Whether UI should enter suggestion mode
suggestionModeDescription	System.String	Why suggestion mode is active. It is displayed when applicableSpan is empty. Otherwise, UI uses applicableSpan to populate the suggestion mode item.

ApplicableToSpan constants # =

Summary

Location pertinent to the completion items

AvailableFilters constants # =

Summary

Filters available for the provided items

Items constants # =

Summary

Set of completion items available at a location

SuggestionModeDescription constants # =

Summary

Displayed when UI is in suggestion mode, yet there is no code to suggest

UseSoftSelection constants # =

Summary

When set to true, the completion list will be initially soft-selected, such that only hitting Tab will commit the soft-selected item. Selecting another item will use full selection.

UseSuggestionMode constants # =

Summary

When set to true, the completion list will be in the "builder" mode, such that hitting Space will not commit it, but append it to the constructed item.

CompletionFilter # =

Namespace

Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition

Summary

Identifies a filter that toggles exclusive display of associated CompletionItem.

Example

static CompletionFilter MyFilter = new CompletionFilter("My items", "m", MyItemsImageMoniker);

Remarks

These instances should be singletons, such that all CompletionItems that need to be filtered using the same filter button need to use the same instance of CompletionFilter, and this instance needs to be also referenced in AvailableFilters

#ctor(displayText,accessKey,icon) constructor # =

Summary

Constructs an instance of

Parameters

Name	Type	Description
displayText	System.String
accessKey	System.String
icon	Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition.ImageMoniker

AccessKey property # =

Summary

Key used to create a keyboard shortcut that toggles this filter.

DisplayText property # =

Summary

Name of this filter.

Icon property # =

Summary

ImageMoniker that represents this filter.

CompletionFilterChangedEventArgs # =

Namespace

Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition

Summary

This class is used to notify completion's logic of selection change in the filter UI

#ctor(filters) constructor # =

Summary

Constructs instance of CompletionFilterChangedEventArgs.

Parameters

Name	Type	Description
filters	System.Collections.Immutable.ImmutableArray{Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition.CompletionFilterWithState}	Current state of the filters

Filters property # =

Summary

Current state of the filters

CompletionFilterWithState # =

Namespace

Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition

Summary

Immutable data transfer object used to communicate between the completion session and completion UI

#ctor(filter,isAvailable) constructor # =

Summary

Constructs a new instance of CompletionFilterWithState.

Parameters

Name	Type	Description
filter	Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition.CompletionFilter	Reference to CompletionFilter
isAvailable	System.Boolean	Whether this CompletionFilter is available

#ctor(filter,isAvailable,isSelected) constructor # =

Summary

Constructs a new instance of CompletionFilterWithState when selected state is known.

Parameters

Name	Type	Description
filter	Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition.CompletionFilter	Reference to CompletionFilter
isAvailable	System.Boolean	Whether this CompletionFilter is available
isSelected	System.Boolean	Whether this CompletionFilter is selected

Filter property # =

Summary

Reference to the completion filter

IsAvailable property # =

Summary

Whether the filter is available. Filter should be available when there are visible CompletionItems that define this Filter in their Filters

IsSelected property # =

Summary

Whether the filter is selected by the user.

WithAvailability(availability) method # =

Summary

Returns instance of CompletionFilterWithState with specified IsAvailable

Returns

Updated instance of CompletionFilterWithState

Parameters

Name	Type	Description
availability	System.Boolean	Value to use for IsAvailable

WithSelected(availability) method # =

Summary

Returns instance of CompletionFilterWithState with specified IsSelected

Returns

Updated instance of CompletionFilterWithState

Parameters

Name	Type	Description
availability	System.Boolean	Value to use for IsSelected

CompletionItem # =

Namespace

Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition

Summary

This class, returned from IAsyncCompletionItemSource, represents a single entry to be displayed in the completion UI. This class implements IPropertyOwner

CompletionItemWithHighlight # =

Namespace

Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition

Summary

Wraps CompletionItem with information about highlighted parts of its DisplayText. The CompletionItem property may be null.

#ctor(completionItem) constructor # =

Summary

Constructs CompletionItemWithHighlight without any highlighting.

Parameters

Name	Type	Description
completionItem	Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition.CompletionItem	Instance of CompletionItem

#ctor(completionItem,highlightedSpans) constructor # =

Summary

Constructs CompletionItemWithHighlight with given highlighting.

Parameters

Name	Type	Description
completionItem	Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition.CompletionItem	Instance of CompletionItem
highlightedSpans	System.Collections.Immutable.ImmutableArray{Microsoft.VisualStudio.Text.Span}	Spans of DisplayText to highlight

Empty constants # =

Summary

Represents no CompletionItem

CompletionItem property # =

Summary

The completion item

HighlightedSpans property # =

Summary

Which parts of DisplayText to highlight

CompletionList # =

Namespace

Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition

Summary

This struct, returned from IAsyncCompletionService, contains completion items to display in the UI, recommended item to display and available filters.

#ctor(items,selectedItemIndex,filters) constructor # =

Summary

Constructs CompletionList with completion filters.

Parameters

Name	Type	Description
items	System.Collections.Generic.IEnumerable{Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition.CompletionItemWithHighlight}	Items to display in the completion UI.
selectedItemIndex	System.Int32	Recommended item index to select.
filters	System.Collections.Immutable.ImmutableArray{Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition.CompletionFilterWithState}	Completion filters with their availability and selection state.

#ctor(items,selectedItemIndex) constructor # =

Summary

Constructs CompletionList without completion filters.

Parameters

Name	Type	Description
items	System.Collections.Generic.IEnumerable{Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition.CompletionItemWithHighlight}	Items to display in the completion UI.
selectedItemIndex	System.Int32	Recommended item index to select.

Filters property # =

Summary

Completion filters with their availability and selection state.

Items property # =

Summary

Items to display in the completion UI.

SelectedItemIndex property # =

Summary

Recommended item index to select.

CompletionPresentation # =

Namespace

Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition

Summary

This struct, contains completion items, filters and other pieces of information used by ICompletionUI to render the completion UI.

#ctor(items,filters,applicableSpan,useSoftSelection,useSuggestionMode,selectSuggestionMode,selectedItemIndex,suggestionModeItem) constructor # =

Summary

Constructs CompletionPresentation

Parameters

Name	Type	Description
items	System.Collections.Generic.IEnumerable{Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition.CompletionItemWithHighlight}	Completion items to display with their highlighted spans
filters	System.Collections.Generic.IEnumerable{Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition.CompletionFilterWithState}	Completion filters with their available and selected state
applicableSpan	Microsoft.VisualStudio.Text.ITrackingSpan	Span pertinent to the completion session
useSoftSelection	System.Boolean	Controls whether selected item should be soft selected
useSuggestionMode	System.Boolean	Controls whether suggestion mode item is visible
selectSuggestionMode	System.Boolean	Controls whether suggestion mode item is selected
selectedItemIndex	System.Int32	Controls which item is selected. Use -1 in suggestion mode
suggestionModeItem	Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition.CompletionItemWithHighlight	Suggestion mode item to display

ApplicableSpan constants # =

Summary

Span pertinent to the completion session.

Filters constants # =

Summary

Completion filters with their available and selected state.

Items constants # =

Summary

Completion items to display with their highlighted spans.

SelectedItemIndex constants # =

Summary

Controls which item is selected. Use -1 in suggestion mode.

SelectSuggestionMode constants # =

Summary

Controls whether suggestion mode item is selected.

SuggestionModeItem constants # =

Summary

Suggestion mode item to display.

UseSoftSelection constants # =

Summary

Controls whether selected item should be soft selected.

UseSuggestionMode constants # =

Summary

Controls whether suggestion mode item is visible.

CompletionTrigger # =

Namespace

Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition

Summary

What triggered the completion (but not where it happened)

#ctor(kind,edit) constructor # =

Summary

Creates a CompletionTrigger associated with a text edit

Parameters

Name	Type	Description
kind	Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition.CompletionTriggerReason	The kind of action that triggered completion to start
edit	System.String	Associated text edit

#ctor(kind) constructor # =

Summary

Creates a CompletionTrigger not associated with a text edit

Parameters

Name	Type	Description
kind	Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition.CompletionTriggerReason	The kind of action that triggered completion to start

Edit property # =

Summary

The text edit associated with the triggering action.

Kind property # =

Summary

The reason that completion was started.

CompletionTriggerReason # =

Namespace

Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition

Summary

The kind of action that triggered completion to start.

Command constants # =

Summary

Completion was triggered by a direct invocation of the completion feature (ctrl-j in Visual Studio).

Deletion constants # =

Summary

Completion was triggered via an action deleting a character from the document.

Insertion constants # =

Summary

Completion was triggered via an action inserting a character into the document.

InvokeAndCommitIfUnique constants # =

Summary

Completion was triggered with a request to commit if a unique item would be selected (ctrl-space in Visual Studio).

Snippets constants # =

Summary

Completion was triggered for snippets only.

IAsyncCompletionBroker # =

Namespace

Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition

Summary

Represents a class that manages the completion feature.

Example

[Export(typeof(IAsyncCompletionBroker))] public class MyCompletionBroker : IAsyncCompletionBroker

Remarks

This is a MEF component and there should be only one exported at a time.

Commit(view,edit) method # =

Summary

Commits selected item, passing in associated text edit, then dismisses the UI

Returns

Parameters

Name	Type	Description
view	Microsoft.VisualStudio.Text.Editor.ITextView	View that hosts completion and relevant buffers
edit	System.String	The text edit which caused this action

Dismiss(view) method # =

Summary

Immediately dismisses completion and closes its UI.

Parameters

Name	Type	Description
view	Microsoft.VisualStudio.Text.Editor.ITextView	View that hosts completion and relevant buffers

IsCompletionActive(view) method # =

Summary

Returns whether completion is active in given view

Parameters

Name	Type	Description
view	Microsoft.VisualStudio.Text.Editor.ITextView	View that hosts completion and relevant buffers

OpenOrUpdate(view,trigger,trackedEdit,triggerLocation) method # =

Summary

Dispatches a worker to compute, sort and filter CompletionItems to be displayed display in the UI, and displays the UI. This method is called on initial text edit and on subsequent typing events.

Parameters

Name	Type	Description
view	Microsoft.VisualStudio.Text.Editor.ITextView	View that hosts completion and relevant buffers
trigger	Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition.CompletionTrigger	What caused completion
trackedEdit	Microsoft.VisualStudio.Text.ITrackingSpan	Span which tracks the location of the completion session and user's input
triggerLocation	Microsoft.VisualStudio.Text.SnapshotPoint	Location of the trigger on the view's top buffer

SelectDown(view) method # =

Summary

Selects an item below the current item

Parameters

Name	Type	Description
view	Microsoft.VisualStudio.Text.Editor.ITextView	View that hosts completion and relevant buffers

SelectPageDown(view) method # =

Summary

Select an item one page below the current item. Page size is determined by ICompletionUIProvider.

Parameters

Name	Type	Description
view	Microsoft.VisualStudio.Text.Editor.ITextView	View that hosts completion and relevant buffers

SelectPageUp(view) method # =

Summary

Select an item one page above the current item. Page size is determined by ICompletionUIProvider.

Parameters

Name	Type	Description
view	Microsoft.VisualStudio.Text.Editor.ITextView	View that hosts completion and relevant buffers

SelectUp(view) method # =

Summary

Selects an item above the current item

Parameters

Name	Type	Description
view	Microsoft.VisualStudio.Text.Editor.ITextView	View that hosts completion and relevant buffers

ShouldCommitCompletion(view,edit,triggerLocation) method # =

Summary

Returns whether completion should commit, given the originating text view and the typed character

Returns

False if there is no completion or typed character is not a commit character

Parameters

Name	Type	Description
view	Microsoft.VisualStudio.Text.Editor.ITextView	View that hosts completion and relevant buffers
edit	System.String	The text edit to evaluate
triggerLocation	Microsoft.VisualStudio.Text.SnapshotPoint	Location of the text edit on the view's top buffer

ShouldTriggerCompletion(view,edit,triggerLocation) method # =

Summary

Returns whether completion should trigger as a result of the text edit.

Returns

true if completion should trigger

Parameters

Name	Type	Description
view	Microsoft.VisualStudio.Text.Editor.ITextView	View that hosts completion and relevant buffers
edit	System.String	The text edit to evaluate
triggerLocation	Microsoft.VisualStudio.Text.SnapshotPoint	Location of the text edit on the view's top buffer

TriggerCompletion(view,triggerLocation) method # =

Summary

Activates completion. Must be called before other methods.

Parameters

Name	Type	Description
view	Microsoft.VisualStudio.Text.Editor.ITextView	View that hosts completion and relevant buffers
triggerLocation	Microsoft.VisualStudio.Text.SnapshotPoint	Location of completion on the view's top buffer. Used to pick relevant IAsyncCompletionItemSources and IAsyncCompletionService

IAsyncCompletionItemSource # =

Namespace

Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition

Summary

Represents a class that provides CompletionItems and other information relevant to the completion feature at a specific SnapshotPoint

Example

[Export(typeof(IAsyncCompletionItemSource))] [Name(nameof(MyCompletionItemSource))] [ContentType("text")] public class MyCompletionItemSource : IAsyncCompletionItemSource

Remarks

This is a MEF component and should be exported with [ContentType] and [Name] attributes. Completion feature will request data from all exported IAsyncCompletionItemSources whose ContentType matches content type of any buffer in the completion's trigger location.

CustomCommit(view,buffer,item,applicableSpan,edit) method # =

Summary

Custom commit behavior for completion item created by this completion item source. Called if CustomCommit is set.

Returns

Parameters

Name	Type	Description
view	Microsoft.VisualStudio.Text.Editor.ITextView	View that hosts completion and relevant buffers
buffer	Microsoft.VisualStudio.Text.ITextBuffer	Reference to the buffer with matching content type to perform text edits etc.
item	Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition.CompletionItem	Which completion item is to be applied
applicableSpan	Microsoft.VisualStudio.Text.ITrackingSpan	Span augmented by completion
edit	System.String	Text change associated with this commit

GetCompletionContextAsync(trigger,triggerLocation) method # =

Summary

Called once per completion session to fetch the set of all completion items available at a given location.

Returns

A struct that holds completion items and applicable span

Parameters

Name	Type	Description
trigger	Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition.CompletionTrigger	What caused the completion
triggerLocation	Microsoft.VisualStudio.Text.SnapshotPoint	Where completion was triggered

GetDescriptionAsync(item) method # =

Summary

Returns tooltip associated with provided completion item

Returns

Return type is pending what we agree to describe GUI in cross platform fashion

Parameters

Name	Type	Description
item	Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition.CompletionItem

GetPotentialCommitCharacters() method # =

Summary

Returns characters that may commit completion. When text edit matches one of these characters, ShouldCommitCompletion is called.

Parameters

This method has no parameters.

HandleViewClosedAsync(view) method # =

Summary

Fired when a view, previously involved in completion, closes

Parameters

Name	Type	Description
view	Microsoft.VisualStudio.Text.Editor.ITextView	View that closes

ShouldCommitCompletion() method # =

Summary

Returns whether this character is a commit character in a given location.

Parameters

This method has no parameters.

ShouldTriggerCompletion() method # =

Summary

Returns whether this character is a trigger character in a given context

Parameters

This method has no parameters.

IAsyncCompletionService # =

Namespace

Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition

Summary

Represents a class that filters and sorts available CompletionItems given the current state of the editor. It also declares which completion filters are available for the returned subset of CompletionItems.

Example

[Export(typeof(IAsyncCompletionService))] [Name(nameof(MyCompletionService))] [ContentType("text")] [Order(Before = "OtherCompletionService")] public class MyCompletionService : IAsyncCompletionService

Remarks

This is a MEF component and should be exported with [ContentType] and [Name] attributes and optional [Order] attribute. An instance of IAsyncCompletionService is selected first by matching ContentType with content type of the view's top buffer, and then by Order. Only one IAsyncCompletionService is used in a given view.

UpdateCompletionListAsync(originalList,snapshot,applicableToSpan,availableFilters) method # =

Summary

This method is first called before completion is about to appear, and then on subsequent typing events and when user toggles completion filters. user's input tracked with ITrackingSpan on given ITextSnapshot and a collection of CompletionFilterWithStates that indicate user's filter selection.

Returns

Instance of CompletionList that contains completion items to render, filters to display and recommended item to select

Parameters

Name	Type	Description
originalList	System.Collections.Generic.IEnumerable{Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition.CompletionItem}	Set of CompletionItems to filter and sort
snapshot	Microsoft.VisualStudio.Text.ITextSnapshot	Current text snapshot of the view's top buffer
applicableToSpan	Microsoft.VisualStudio.Text.ITrackingSpan	Span which tracks the location of the completion session and user's input
availableFilters	System.Collections.Immutable.ImmutableArray{Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition.CompletionFilterWithState}	Filters, their availability and selection state

IAsyncCompletionSession # =

Namespace

Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition

Summary

Represents a class that tracks completion within an editor. Constructed by an implementation of IAsyncCompletionBroker

Commit(view,edit) method # =

Summary

Commits the currently selected CompletionItem. Runs on UI thread.

Parameters

Name	Type	Description
view	Microsoft.VisualStudio.Text.Editor.ITextView	View that hosts completion and relevant buffers
edit	System.String	The text edit which caused this action. May be null.

Commit(view,edit,itemToCommit) method # =

Summary

Commits the specified CompletionItem. Runs on UI thread.

Parameters

Name	Type	Description
view	Microsoft.VisualStudio.Text.Editor.ITextView	View that hosts completion and relevant buffers
edit	System.String	The text edit which caused this action. May be null.
itemToCommit	Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition.CompletionItem	Specific item to commit.

DismissAndHide() method # =

Summary

Hides the UI and cleans up resources.

Returns

Parameters

This method has no parameters.

OpenOrUpdate(view,trigger,applicableSpan,triggerLocation) method # =

Summary

Request completion to be opened or updated in a given location, completion items filtered and sorted, and the UI updated.

Parameters

Name	Type	Description
view	Microsoft.VisualStudio.Text.Editor.ITextView	View that hosts completion and relevant buffers
trigger	Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition.CompletionTrigger	What caused completion
applicableSpan	Microsoft.VisualStudio.Text.ITrackingSpan	Span which tracks the location of the completion session and user's input
triggerLocation	Microsoft.VisualStudio.Text.SnapshotPoint	Location of the trigger on the view's top buffer

SelectDown() method # =

Summary

Selects an item below the current item

Parameters

This method has no parameters.

SelectPageDown() method # =

Summary

Select an item one page below the current item. Page size is determined by ICompletionUIProvider.

Parameters

This method has no parameters.

SelectPageUp() method # =

Summary

Select an item one page above the current item. Page size is determined by ICompletionUIProvider.

Parameters

This method has no parameters.

SelectUp() method # =

Summary

Selects an item above the current item

Parameters

This method has no parameters.

ShouldCommit(view,edit,triggerLocation) method # =

Summary

Returns whether given text edit should result in committing this session.

Returns

Parameters

Name	Type	Description
view	Microsoft.VisualStudio.Text.Editor.ITextView
edit	System.String
triggerLocation	Microsoft.VisualStudio.Text.SnapshotPoint	Location on the view's top buffer

ICompletionUI # =

Namespace

Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition

Summary

Represents a class that manages user interface for the completion feature

Hide() method # =

Summary

Hides the completion UI

Parameters

This method has no parameters.

Open(presentation) method # =

Summary

Opens the UI and displays provided data

Parameters

Name	Type	Description
presentation	Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition.CompletionPresentation

SetSelection(selectedIndex) method # =

Summary

Selects item with the specified index

Parameters

Name	Type	Description
selectedIndex	System.Int32	Index of item to select. -1 removes selection.

Update(presentation) method # =

Summary

Displays provided data on the UI

Parameters

Name	Type	Description
presentation	Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition.CompletionPresentation

ICompletionUIProvider # =

Namespace

Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition

Summary

Represents a class that produces instances of ICompletionUI

Example

[Export(typeof(ICompletionUIFactory))] [Name(nameof(MyCompletionUIFactory))] [ContentType("any")] [Order(Before = nameof(MyOtherCompletionUIFactory))] public class MyCompletionUIFactory : ICompletionUIFactory

Remarks

This is a MEF component and should be exported with [ContentType] and [Name] attributes and optional [Order] attribute. An instance of ICompletionUIProvider is selected first by matching ContentType with content type of the view's top buffer, and then by Order. Only one ICompletionUIProvider is used in a given view.

ResultsPerPage property # =

Summary

Declares size of the jump when user presses PageUp and PageDown keys.

Remarks

This value is read by the controller that processes scrolling and selection. The ICompletionUI is just a view that doesn't participate in keyboard scrolling.

GetUI(textView) method # =

Summary

Returns instance of ICompletionUI that will host completion for given ITextView

Returns

Instance of ICompletionUI

Parameters

Name	Type	Description
textView	Microsoft.VisualStudio.Text.Editor.ITextView	Text view that will host the completion. Completion acts on buffers of this view.

Remarks

It is encouraged to reuse the UI over creating new UI each time this method is called.

ImageMoniker # =

Namespace

Microsoft.VisualStudio.Language.Intellisense.Prototype.Definition

Summary

Contains the GUID and ID of the image.

Guid constants # =

Summary

The GUID of the moniker.

Id constants # =

Summary

The ID of the moniker.