Share via


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)

Syntax

'Declaration
Public Interface ISignatureHelpBroker
public interface ISignatureHelpBroker
public interface class ISignatureHelpBroker
type ISignatureHelpBroker =  interface end
public interface ISignatureHelpBroker

The ISignatureHelpBroker type exposes the following members.

Methods

  Name Description
Public method CreateSignatureHelpSession Creates a signature help session without starting it.
Public method DismissAllSessions Dismisses any active signature help sessions in this broker's ITextView.
Public method GetSessions Gets the list of all signature help sessions for this broker's ITextView.
Public method IsSignatureHelpActive Determines whether signature help is active.
Public method TriggerSignatureHelp(ITextView) Begins the process of signature help at the position of the caret.
Public method TriggerSignatureHelp(ITextView, ITrackingPoint, Boolean) Starts the process of signature help at the specified point.

Top

Remarks

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;

Examples

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

See Also

Reference

Microsoft.VisualStudio.Language.Intellisense Namespace