ISmartTagSession Interface
Defines a smart tag session, which encapsulates all the information about a particular invocation of the smart tag system.
Namespace: Microsoft.VisualStudio.Language.Intellisense
Assembly: Microsoft.VisualStudio.Language.Intellisense (in Microsoft.VisualStudio.Language.Intellisense.dll)
Syntax
'Declaration
Public Interface ISmartTagSession _
Inherits IIntellisenseSession, IPropertyOwner
public interface ISmartTagSession : IIntellisenseSession,
IPropertyOwner
public interface class ISmartTagSession : IIntellisenseSession,
IPropertyOwner
type ISmartTagSession =
interface
interface IIntellisenseSession
interface IPropertyOwner
end
public interface ISmartTagSession extends IIntellisenseSession, IPropertyOwner
The ISmartTagSession type exposes the following members.
Properties
Name | Description | |
---|---|---|
ActionSets | Gets the collection of actions that this session displays. | |
ApplicableToSpan | Gets or sets the span to which this session is applicable in the text buffer. This is used to position any popups that are rendered by smart tag presenters. | |
IconSource | Gets or sets an icon that can be used in the display of this session. | |
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 | Gets the collection of properties controlled by the property owner. (Inherited from IPropertyOwner.) | |
State | Gets or sets the current state of this session. | |
TagSpan | The span over which the tag should be rendered | |
TagText | Gets or sets the text to be displayed with the tag. | |
TextView | Gets the ITextView in which this IntelliSense session was triggered. (Inherited from IIntellisenseSession.) | |
Type | The type of this smart tag session. |
Top
Methods
Name | Description | |
---|---|---|
Collapse | Reduces the session to a minimized state. 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 for 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.) |
Top
Events
Name | Description | |
---|---|---|
ApplicableToSpanChanged | Occurs when the ApplicableToSpan property changes. | |
Dismissed | Occurs when the session is dismissed. (Inherited from IIntellisenseSession.) | |
IconSourceChanged | Occurs when the session's icon changes. | |
PresenterChanged | Occurs when the IntelliSense presenter for this session changes. (Inherited from IIntellisenseSession.) | |
Recalculated | Occurs when the session is recalculated. (Inherited from IIntellisenseSession.) | |
StateChanged | Occurs when the state of this session changes | |
TagSpanChanged | Occurs when the TagSpan property changes. |
Top
Examples
For an example of the use of this interface, see Walkthrough: Displaying SmartTags.