CompletionSet Class

 
clsCompliantAlternativeNone

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

Namespace:   Microsoft.VisualStudio.Package
Assembly:  Microsoft.VisualStudio.Package.LanguageService.14.0 (in Microsoft.VisualStudio.Package.LanguageService.14.0.dll)

System.Object
  Microsoft.VisualStudio.Package.CompletionSet

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

NameDescription
System_CAPS_pubmethodCompletionSet(ImageList, Source)

Initializes a new instance of the CompletionSet class.

NameDescription
System_CAPS_pubpropertyDeclarations

Gets or sets the Declarations object this completion set uses.

System_CAPS_pubpropertyIsCommitted

Gets whether any text has been committed to the source file.

System_CAPS_pubpropertyIsDisplayed

Gets whether the completion list is currently displayed.

System_CAPS_pubpropertyOnCommitText

Gets the text that is to be committed to the source file.

NameDescription
System_CAPS_pubmethodClose()

Closes the completion list display.

System_CAPS_pubmethodCompareItems(String, String, Int32, Int32)

Compares two strings for the specified number of characters.

System_CAPS_pubmethodDecreaseFilterLevel(Int32)

Changes the level of the internal filter list and updates it, showing common items.

System_CAPS_pubmethodDismiss()

Called when the completion list is no longer needed.

System_CAPS_pubmethodDispose()

Deallocates any resources just before the CompletionSet object is destroyed.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetBestMatch(String, Int32, Int32, UInt32)

Determines which item in the list is the best match for the text typed so far by the user.

System_CAPS_pubmethodGetCompletionItemColor(Int32, UInt32, UInt32)

Gets the foreground and background colors for a selected item.

System_CAPS_pubmethodGetCount()

Gets the number of items that can be displayed in the completion list.

System_CAPS_pubmethodGetDescriptionText(Int32, String)

Gets a description for the specified item in the completion list.

System_CAPS_pubmethodGetDisplayText(Int32, String, Int32[])

Gets the text and image index to display in the completion list for the specified item.

System_CAPS_pubmethodGetFilterLevel(Int32)

Gets the current filter level.

System_CAPS_pubmethodGetFlags()

Gets a set of flags specifying the behavior of the completion list.

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetImageList(IntPtr)

Returns the image list to use for the glyphs in the completion list.

System_CAPS_pubmethodGetInitialExtent(Int32, Int32, Int32)

Gets the initial extent of the text to be completed.

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodIncreaseFilterLevel(Int32)

Show in the completion list the members of the specified type.

System_CAPS_pubmethodInit(IVsTextView, Declarations, Boolean)

Initializes the completion set object.

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodOnAutoComplete()

Called after completion text has been committed to the source file.

System_CAPS_pubmethodOnCommit(String, Int32, Int32, UInt16, String)

Gets the text to be inserted into the source file if the specified character is a commit character.

System_CAPS_pubmethodOnCommitComplete()

Called after the text has been committed.

System_CAPS_pubmethodToString()

(Inherited from Object.)

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.

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

Return to top
Show: