ISmartTagBroker Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Caution
This API is deprecated in this version of the Visual Studio SDK, and will be retired in a future version. To find out more about the replacement API, Light Bulb, refer to http://go.microsoft.com/fwlink/?LinkId=394601.
Defines a smart tag broker, which is responsible for triggering smart tags. Components call methods on the broker in order to trigger smart tags.Smart tags are deprecated in favor of light bulbs. See ILightBulbBroker for a replacement.
public interface class ISmartTagBrokerpublic interface class ISmartTagBroker__interface ISmartTagBroker[System.Obsolete("This API is deprecated in this version of the Visual Studio SDK, and will be retired in a future version. To find out more about the replacement API, Light Bulb, refer to http://go.microsoft.com/fwlink/?LinkId=394601.")]
public interface ISmartTagBroker[<System.Obsolete("This API is deprecated in this version of the Visual Studio SDK, and will be retired in a future version. To find out more about the replacement API, Light Bulb, refer to http://go.microsoft.com/fwlink/?LinkId=394601.")>]
type ISmartTagBroker = interfacePublic Interface ISmartTagBroker- Attributes
Remarks
To create a smart tag session, use CreateSmartTagSession(ITextView, SmartTagType, ITrackingPoint, SmartTagState), 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(ISmartTagSession, IList<SmartTagActionSet>) the smart tag source can return actions that will be added to the ActionSets. ISmartTagSources 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 doesn't get any actions or an applicability span, then the session will be immediately dismissed.
Methods
| CreateSmartTagSession(ITextView, SmartTagType, ITrackingPoint, SmartTagState) |
Creates a smart tag session for smart tags of the specified type at the specified location.Smart tags are deprecated in favor of light bulbs. See ILightBulbBroker for a replacement. |
| GetSessions(ITextView) |
Gets the list of currently-active smart tag sessions for the specified text view.Smart tags are deprecated in favor of light bulbs. See ILightBulbBroker for a replacement. |
| IsSmartTagActive(ITextView) |
Determines whether a smart tag is active.Smart tags are deprecated in favor of light bulbs. See ILightBulbBroker for a replacement. |