ISmartTagBroker Interface

Defines a smart tag broker, which is responsible for triggering smart tags. Components call methods on the broker in order to trigger smart tags.

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

Syntax

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

The ISmartTagBroker type exposes the following members.

Methods

  Name Description
Public method CreateSmartTagSession Creates a smart tag session for smart tags of the specified type at the specified location.
Public method GetSessions Gets the list of currently-active smart tag sessions for the specified text view.
Public method IsSmartTagActive Determines whether a smart tag is active.

Top

Remarks

To create a smart tag session, use CreateSmartTagSession, add some context data into the session's property bag, and call Start.

During the Start call, the session is calculated for the first time, and in AugmentSmartTagSession the smart tag source can return actions to be added to the ActionSets. ISmartTagSource objects should also set the ApplicableToSpan property based on the context data that was earlier added to the session's property bag. If, during any smart tag session calculation, the session does not get actions or an applicability span, the session will be immediately dismissed.

See Also

Reference

Microsoft.VisualStudio.Language.Intellisense Namespace