CompletionSet Class

Definition

Namespace:

Microsoft.VisualStudio.Package

Assembly:

Microsoft.VisualStudio.Package.LanguageService.15.0.dll

Package:

Microsoft.VisualStudio.Package.LanguageService.15.0 v17.12.40392

Important

This API is not CLS-compliant.

Represents an IntelliSense completion list that is displayed in the current text view.

public ref class CompletionSet : IDisposable, Microsoft::VisualStudio::TextManager::Interop::IVsCompletionSet, Microsoft::VisualStudio::TextManager::Interop::IVsCompletionSetEx

public class CompletionSet : IDisposable, Microsoft.VisualStudio.TextManager.Interop.IVsCompletionSet, Microsoft.VisualStudio.TextManager.Interop.IVsCompletionSetEx

type CompletionSet = class
    interface IVsCompletionSet
    interface IVsCompletionSetEx
    interface IDisposable

Public Class CompletionSet
Implements IDisposable, IVsCompletionSet, IVsCompletionSetEx

Inheritance

Object

CompletionSet

Implements

IVsCompletionSet IVsCompletionSetEx IDisposable

Remarks

Visual Studio manages the actual display of the completion list while this class manages what is displayed in the completion list and what happens when the user commits to an entry in that list.

Notes to Inheritors

This class implements everything needed to interact with the Declarations class and to provide suitable default behavior for each method so that there is typically no need for you to implement a derived version of the CompletionSet class.

Notes to Callers

An instance of this class is returned from the CreateCompletionSet() method in the Source class. The CreateCompletionSet() method is typically called from the Source class constructor. The CompletionSet object is then used in handling a completion operation that may optionally require displaying a completion list. Visual Studio interacts with the CompletionSet class through the IVsCompletionSet interface to implement the IntelliSense completion list.

Constructors

CompletionSet(ImageList, Source)

Initializes a new instance of the CompletionSet class.

Properties

Declarations	Gets or sets the Declarations object this completion set uses.
IsCommitted	Gets whether any text has been committed to the source file.
IsDisplayed	Gets whether the completion list is currently displayed.
OnCommitText	Gets the text that is to be committed to the source file.

Methods

Close()	Closes the completion list display.
CompareItems(String, String, Int32, Int32)	Compares two strings for the specified number of characters.
DecreaseFilterLevel(Int32)	Changes the level of the internal filter list and updates it, showing common items.
Dismiss()	Called when the completion list is no longer needed.
Dispose()	Deallocates any resources just before the CompletionSet object is destroyed.
GetBestMatch(String, Int32, Int32, UInt32)	Determines which item in the list is the best match for the text typed so far by the user.
GetCompletionItemColor(Int32, UInt32, UInt32)	Gets the foreground and background colors for a selected item.
GetCount()	Gets the number of items that can be displayed in the completion list.
GetDescriptionText(Int32, String)	Gets a description for the specified item in the completion list.
GetDisplayText(Int32, String, Int32[])	Gets the text and image index to display in the completion list for the specified item.
GetFilterLevel(Int32)	Gets the current filter level.
GetFlags()	Gets a set of flags specifying the behavior of the completion list.
GetImageList(IntPtr)	Returns the image list to use for the glyphs in the completion list.
GetInitialExtent(Int32, Int32, Int32)	Gets the initial extent of the text to be completed.
IncreaseFilterLevel(Int32)	Show in the completion list the members of the specified type.
Init(IVsTextView, Declarations, Boolean)	Initializes the completion set object.
OnAutoComplete()	Called after completion text has been committed to the source file.
OnCommit(String, Int32, Int32, UInt16, String)	Gets the text to be inserted into the source file if the specified character is a commit character.
OnCommitComplete()	Called after the text has been committed.