ISignatureHelpSession Interface

Definition

Namespace:

Microsoft.VisualStudio.Language.Intellisense

Assembly:

Microsoft.VisualStudio.Language.Intellisense.dll

Package:

Microsoft.VisualStudio.Language.Intellisense v17.12.215

Defines an IntelliSense session used for displaying signature help.

public interface class ISignatureHelpSession : Microsoft::VisualStudio::Language::Intellisense::IIntellisenseSession, Microsoft::VisualStudio::Utilities::IPropertyOwner

public interface class ISignatureHelpSession : Microsoft::VisualStudio::Language::Intellisense::IIntellisenseSession, Microsoft::VisualStudio::Utilities::IPropertyOwner

__interface ISignatureHelpSession : Microsoft::VisualStudio::Language::Intellisense::IIntellisenseSession, Microsoft::VisualStudio::Utilities::IPropertyOwner

public interface ISignatureHelpSession : Microsoft.VisualStudio.Language.Intellisense.IIntellisenseSession, Microsoft.VisualStudio.Utilities.IPropertyOwner

type ISignatureHelpSession = interface
    interface IIntellisenseSession
    interface IPropertyOwner

Public Interface ISignatureHelpSession
Implements IIntellisenseSession, IPropertyOwner

Implements

IIntellisenseSession IPropertyOwner

Examples

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

Properties

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

Methods

Collapse()	Collapses the session to an unobtrusive state in which it doesn't get in the way of the user. If the session has no such state, the session will be dismissed. (Inherited from IIntellisenseSession)
Dismiss()	Dismisses the session, causing the presenter to be destroyed and the session to be removed from the session stack. (Inherited from IIntellisenseSession)
GetTriggerPoint(ITextBuffer)	Gets the ITrackingPoint at which this IntelliSense session was triggered in terms of the specified ITextBuffer. (Inherited from IIntellisenseSession)
GetTriggerPoint(ITextSnapshot)	Gets the SnapshotPoint at which this IntelliSense session was triggered in terms of the specified ITextSnapshot. (Inherited from IIntellisenseSession)
Match()	Determines the best matching item in the session and sets the selection to this item. (Inherited from IIntellisenseSession)
Recalculate()	Recalculates the underlying IntelliSense items pertaining to this session, using the same trigger point. (Inherited from IIntellisenseSession)
Start()	Starts the session. (Inherited from IIntellisenseSession)

Events

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