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)

public interface ISignatureHelpBroker

The ISignatureHelpBroker type exposes the following members.

Public methodCreateSignatureHelpSessionCreates a signature help session without starting it.
Public methodDismissAllSessionsDismisses any active signature help sessions in this broker's ITextView.
Public methodGetSessionsGets the list of all signature help sessions for this broker's ITextView.
Public methodIsSignatureHelpActiveDetermines whether signature help is active.
Public methodTriggerSignatureHelp(ITextView)Begins the process of signature help at the position of the caret.
Public methodTriggerSignatureHelp(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:

internal ISignatureHelpBroker m_helpBroker = null;

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

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
© 2015 Microsoft