A specialized subclass of QueryToolTipEventArgs that carries the item for which the tool tip is queried.
Inheritance Hierarchy
Members
Show:
Constructors
Initializes a new instance of the QueryItemToolTipEventArgs<TModelItem> class.
Initializes a new instance of the QueryItemToolTipEventArgs<TModelItem> class.
Parameters
- context: IInputModeContext
- The context to yield the tool tip for.
- queryLocation: Point
- The query location.
- item: TModelItem
- The item for which the tool tip is queried.
Properties
Gets the context for the current event.
Gets the context for the current event.
Gets or sets a value indicating whether this QueryToolTipEventArgs has been handled.
Gets or sets a value indicating whether this QueryToolTipEventArgs has been handled.
Handlers which handle this QueryToolTipEventArgs should always test first, whether this property is set to true and, if so, exit without doing anything.
This property is automatically set to true if the toolTip or toolTipAsync property has been assigned a value.
final
Property Value
true if handled; false otherwise.Defined in
QueryToolTipEventArgs.handledreadonlyfinal
Property Value
The item, which may be
null.Gets the query location in world coordinates.
Gets the query location in world coordinates.
If a non-null value is set, that value will be displayed as tooltip.
This property can be set to either a text string for simple text, or an HTMLElement for rich HTML structures. This allows embedding dynamically rendered components from third-party libraries.
Setting this property will set the handled property to true.
final
Property Value
The tooltip content or
null if no tooltip should be displayed.See Also
Developer's Guide
API
- toolTipAsync
Defined in
QueryToolTipEventArgs.toolTipfinal
Property Value
A Promise providing the tooltip content or
null if no tooltip should be displayed.See Also
API
- toolTip