ISignatureHelpSession Interface

Defines an IntelliSense session used for displaying signature help.

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

Syntax

'Declaration
Public Interface ISignatureHelpSession _
    Inherits IIntellisenseSession, IPropertyOwner
public interface ISignatureHelpSession : IIntellisenseSession, 
    IPropertyOwner
public interface class ISignatureHelpSession : IIntellisenseSession, 
    IPropertyOwner
type ISignatureHelpSession =  
    interface 
        interface IIntellisenseSession 
        interface IPropertyOwner 
    end
public interface ISignatureHelpSession extends IIntellisenseSession, IPropertyOwner

The ISignatureHelpSession type exposes the following members.

Properties

  Name Description
Public property IsDismissed Determines whether the session is dismissed. (Inherited from IIntellisenseSession.)
Public property Presenter Gets the IIntellisensePresenter that is used to render IntelliSense for this session. (Inherited from IIntellisenseSession.)
Public property Properties Gets the collection of properties controlled by the property owner. (Inherited from IPropertyOwner.)
Public property SelectedSignature Gets the signature that is currently selected from among the set of valid signatures.
Public property Signatures Gets the set of valid signatures for this session.
Public property TextView Gets the ITextView in which this IntelliSense session was triggered. (Inherited from IIntellisenseSession.)

Top

Methods

  Name Description
Public method Collapse Reduces the session to a minimized state. If the session has no such state, the session will be dismissed. (Inherited from IIntellisenseSession.)
Public method Dismiss Dismisses the session, causing the presenter to be destroyed and the session to be removed from the session stack. (Inherited from IIntellisenseSession.)
Public method GetTriggerPoint(ITextBuffer) Gets the ITrackingPoint at which this IntelliSense session was triggered for the specified ITextBuffer. (Inherited from IIntellisenseSession.)
Public method GetTriggerPoint(ITextSnapshot) Gets the SnapshotPoint at which this IntelliSense session was triggered in terms of the specified ITextSnapshot. (Inherited from IIntellisenseSession.)
Public method Match Determines the best matching item in the session and sets the selection to this item. (Inherited from IIntellisenseSession.)
Public method Recalculate Recalculates the underlying IntelliSense items pertaining to this session, using the same trigger point. (Inherited from IIntellisenseSession.)
Public method Start Starts the session. (Inherited from IIntellisenseSession.)

Top

Events

  Name Description
Public event Dismissed Occurs when the session is dismissed. (Inherited from IIntellisenseSession.)
Public event PresenterChanged Occurs when the IntelliSense presenter for this session changes. (Inherited from IIntellisenseSession.)
Public event Recalculated Occurs when the session is recalculated. (Inherited from IIntellisenseSession.)
Public event SelectedSignatureChanged Occurs when the SelectedSignature property changes.

Top

Examples

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

See Also

Reference

Microsoft.VisualStudio.Language.Intellisense Namespace