CompletionSet Class

Article
04/29/2015

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

This API is not CLS-compliant. The CLS-compliant alternative is [None].

Inheritance Hierarchy

Object
Microsoft.VisualStudio.Package.CompletionSet

Namespace: Microsoft.VisualStudio.Package
Assemblies:   Microsoft.VisualStudio.Package.LanguageService.11.0 (in Microsoft.VisualStudio.Package.LanguageService.11.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.12.0 (in Microsoft.VisualStudio.Package.LanguageService.12.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.9.0 (in Microsoft.VisualStudio.Package.LanguageService.9.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.10.0 (in Microsoft.VisualStudio.Package.LanguageService.10.0.dll)
  Microsoft.VisualStudio.Package.LanguageService (in Microsoft.VisualStudio.Package.LanguageService.dll)

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public Class CompletionSet _
    Implements IVsCompletionSet, IVsCompletionSetEx, IDisposable

[CLSCompliantAttribute(false)]
public class CompletionSet : IVsCompletionSet, 
    IVsCompletionSetEx, IDisposable

[CLSCompliantAttribute(false)]
public ref class CompletionSet : IVsCompletionSet, 
    IVsCompletionSetEx, IDisposable

[<CLSCompliantAttribute(false)>]
type CompletionSet =  
    class 
        interface IVsCompletionSet 
        interface IVsCompletionSetEx 
        interface IDisposable 
    end

public class CompletionSet implements IVsCompletionSet, IVsCompletionSetEx, IDisposable

The CompletionSet type exposes the following members.

Constructors

	Name	Description
	CompletionSet	Initializes a new instance of the CompletionSet class.

Top

Properties

	Name	Description
	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.

Top

Methods

	Name	Description
	Close	Closes the completion list display.
	CompareItems	Compares two strings for the specified number of characters.
	DecreaseFilterLevel	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.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetBestMatch	Determines which item in the list is the best match for the text typed so far by the user.
	GetCompletionItemColor	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	Gets a description for the specified item in the completion list.
	GetDisplayText	Gets the text and image index to display in the completion list for the specified item.
	GetFilterLevel	Gets the current filter level.
	GetFlags	Gets a set of flags specifying the behavior of the completion list.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetImageList	Returns the image list to use for the glyphs in the completion list.
	GetInitialExtent	Gets the initial extent of the text to be completed.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IncreaseFilterLevel	Show in the completion list the members of the specified type.
	Init	Initializes the completion set object.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnAutoComplete	Called after completion text has been committed to the source file.
	OnCommit	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.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

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 Implementers

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.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via