CompletionItem Class

Definition

Namespace:

Microsoft.VisualStudio.Language.Intellisense.AsyncCompletion.Data

Assembly:

Microsoft.VisualStudio.Language.dll

Package:

Microsoft.VisualStudio.Language v17.11.260

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

public ref class CompletionItem sealed : Microsoft::VisualStudio::Utilities::IPropertyOwner, System::ComponentModel::INotifyPropertyChanged

[System.Diagnostics.DebuggerDisplay("{DisplayText}")]
public sealed class CompletionItem : Microsoft.VisualStudio.Utilities.IPropertyOwner, System.ComponentModel.INotifyPropertyChanged

[<System.Diagnostics.DebuggerDisplay("{DisplayText}")>]
type CompletionItem = class
    interface IPropertyOwner
    interface INotifyPropertyChanged

Public NotInheritable Class CompletionItem
Implements INotifyPropertyChanged, IPropertyOwner

Inheritance

Object

CompletionItem

Attributes

DebuggerDisplayAttribute

Implements

IPropertyOwner INotifyPropertyChanged

Constructors

CompletionItem(String, IAsyncCompletionSource, ImageElement, ImmutableArray<CompletionFilter>, String, String, String, String, ImmutableArray<ImageElement>)	Creates a completion item, allowing customization of all of its properties as of Visual Studio 16.0
CompletionItem(String, IAsyncCompletionSource, ImageElement, ImmutableArray<CompletionFilter>, String, String, String, String, String, ImmutableArray<ImageElement>, ImmutableArray<Char>, SnapshotSpan, Boolean, Boolean)	Creates a completion item, allowing customization of all of its properties as of Visual Studio 16.8
CompletionItem(String, IAsyncCompletionSource, ImageElement, ImmutableArray<CompletionFilter>, String, String, String, String, String, ImmutableArray<ImageElement>)	Creates a completion item, allowing customization of all of its properties as of Visual Studio 16.1
CompletionItem(String, IAsyncCompletionSource, ImageElement, ImmutableArray<CompletionFilter>, String)	Creates a completion item whose displayText, InsertText, SortText and FilterText are all the same, there is an image, filters, suffix, and there are no attribute images associated with this item.
CompletionItem(String, IAsyncCompletionSource, ImageElement, ImmutableArray<CompletionFilter>)	Creates a completion item whose DisplayText, InsertText, SortText and FilterText are all the same, there is an image, filters, and there are no suffix nor attribute images associated with this item.
CompletionItem(String, IAsyncCompletionSource, ImageElement)	Creates a completion item whose DisplayText, InsertText, SortText and FilterText are all the same, there is an image, and there are no filter, suffix nor attribute images associated with this item.
CompletionItem(String, IAsyncCompletionSource, SnapshotSpan)	Creates a completion item pertinent to applicableToSpan, whose DisplayText, InsertText, SortText and FilterText are all the same, and there are no icon, filter, suffix nor attribute icons associated with this item.
CompletionItem(String, IAsyncCompletionSource)	Creates a completion item whose DisplayText, InsertText, SortText and FilterText are all the same, and there are no icon, filter, suffix nor attribute icons associated with this item.

Properties

ApplicableToSpan	Span replaced with InsertText when this item is committed.
AttributeIcons	Additional images to display in the UI. Usually, these images are displayed on the far right side of the UI.
AutomationText	Text used by narrator and other automation tools
CommitCharacters	Characters which commit this item, if pressed while this item is selected.
DisplayText	Text used in the UI
Filters	ImmutableArray of references to CompletionFilters applicable to this item
FilterText	Text used by IAsyncCompletionItemManager when matching against the applicable span
Icon	Image displayed in the UI
InsertText	Text inserted when completing this item
IsCommittedAsSnippet	Whether InsertText should be formatted as a snippet during the commit operation.
IsPreselected	When set, completion will try to select this item.
Properties	The collection of properties controlled by the property owner. See Properties
SortText	Text used by IAsyncCompletionItemManager when sorting against other items
Source	Reference to the instance that will provide tooltip and custom commit method. This should be the same instance as the one that created this CompletionItem
Suffix	Additional text to display in the UI, after DisplayText. This text has less emphasis than DisplayText and is usually right-aligned.

Methods

ToString()

Events

PropertyChanged