C

QueryItemToolTipEventArgs<TModelItem>

Show Usages
A specialized subclass of QueryToolTipEventArgs that carries the item for which the tool tip is queried.

Remarks

Type Parameters

TModelItem

The type of the model .

See Also

Developer's Guide

Members

Show:

Constructors

QueryItemToolTipEventArgs

(
context: IInputModeContext
queryLocation: Point
popover: PopoverDescriptor
item: TModelItem
)
Initializes a new instance of the QueryItemToolTipEventArgs<TModelItem> class.

Parameters

context: IInputModeContext
The context to yield the tool tip for.
queryLocation: Point
conversion
The query location.
popover: PopoverDescriptor
The popover descriptor.
item: TModelItem
The item for which the tool tip is queried.

Properties

context

: IInputModeContext
readonly
Gets the context for the current event.
readonlyfinal

Property Value

The context.

handled

: boolean
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.

See Also

Developer's Guide

item

: TModelItem
readonly
Gets the item for which the tool tip is queried.
readonlyfinal

Property Value

The item, which may be null.

popover

: PopoverDescriptor
readonly
Gets the popover descriptor.
The descriptor holds information about the popover that shows the contents. During event handling, code can modify the properties of the descriptor to change the appearance and type of the popover.
readonlyfinal

See Also

Developer's Guide

queryLocation

: Point
readonly
Gets the query location in world coordinates.
readonlyfinal

Property Value

The query location.

toolTip

: any
Gets or sets the tooltip content to use.

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

toolTipAsync

: Promise<any>
Gets or sets a Promise<T> that provides the tooltip content to use.

If a non-null value is set, its provided value will be displayed when the Promise<T> resolves.

Setting this property will set the handled property to true.

final

Property Value

A Promise providing the tooltip content or null if no tooltip should be displayed.

See Also

API
toolTip