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
Public property ActionSets Gets the collection of actions that this session displays.
Public property 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.
Public property IconSource Gets or sets an icon that can be used in the display of this session.
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 State Gets or sets the current state of this session.
Public property TagSpan The span over which the tag should be rendered
Public property TagText Gets or sets the text to be displayed with the tag.
Public property TextView Gets the ITextView in which this IntelliSense session was triggered. (Inherited from IIntellisenseSession.)
Public property Type The type of this smart tag session.

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 ApplicableToSpanChanged Occurs when the ApplicableToSpan property changes.
Public event Dismissed Occurs when the session is dismissed. (Inherited from IIntellisenseSession.)
Public event IconSourceChanged Occurs when the session's icon changes.
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 StateChanged Occurs when the state of this session changes
Public event TagSpanChanged Occurs when the TagSpan property changes.

Top

Examples

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

See Also

Reference

Microsoft.VisualStudio.Language.Intellisense Namespace