ISignatureHelpBroker Interface
TOC
Collapse the table of content
Expand the table of content

ISignatureHelpBroker Interface

 

Defines the signature help broker, which is the primary component of the signature help process.

Namespace:   Microsoft.VisualStudio.Language.Intellisense
Assembly:  Microsoft.VisualStudio.Language.Intellisense (in Microsoft.VisualStudio.Language.Intellisense.dll)

No code example is currently available or this language may not be supported.

NameDescription
System_CAPS_pubmethodCreateSignatureHelpSession(ITextView, ITrackingPoint, Boolean)

Creates a signature help session without starting it.

System_CAPS_pubmethodDismissAllSessions(ITextView)

Dismisses any active signature help sessions in this broker's ITextView.

System_CAPS_pubmethodGetSessions(ITextView)

Gets the list of all signature help sessions for this broker's ITextView.

System_CAPS_pubmethodIsSignatureHelpActive(ITextView)

Determines whether signature help is active.

System_CAPS_pubmethodTriggerSignatureHelp(ITextView)

Begins the process of signature help at the position of the caret.

System_CAPS_pubmethodTriggerSignatureHelp(ITextView, ITrackingPoint, Boolean)

Starts the process of signature help at the specified point.

The broker is responsible for handling each signature help session from beginning to end. IntelliSense controllers request this broker to trigger or dismiss signature help. The broker can also be used by other components to determine the state of signature help or to trigger the process.

This should be imported as follows:

[Import]
internal ISignatureHelpBroker m_helpBroker = null;

For an example of the use of this interface, see Walkthrough: Displaying Signature Help.

Return to top
Show:
© 2016 Microsoft