C

UpdatePopoverEventArgs

Show Usages
Event data of the PopoverDescriptor.update event.

See Also

API

PopoverUpdateReason, update

Members

Show:

Constructors

UpdatePopoverEventArgs

(
context: IInputModeContext
queryLocation: Point
popover: PopoverDescriptor
reason: PopoverUpdateReason
)
Initializes a new instance of the UpdatePopoverEventArgs class.

Parameters

context: IInputModeContext
The context of the query.
queryLocation: Point
conversion
The query location. Typically, the location of the pointer.
popover: PopoverDescriptor
The popover descriptor.
reason: PopoverUpdateReason
conversion
The reason that caused the event to be triggered.

Properties

content

: any
Gets or sets the content to use.

If a non-null value is set, that value will be displayed as popover.

Setting this property will set the handled property to true.

final

Property Value

The tooltip content or null if no tooltip should be displayed.

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 content property is reassigned.

final

Property Value

true if handled; false otherwise.

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 of the popover. Note that changing the PopoverDescriptor.behavior is not supported on requery.
readonlyfinal

queryLocation

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

Property Value

The requery location.

reason

: PopoverUpdateReason
readonly
Gets the reason why the PopoverDescriptor.update event was raised.
readonlyfinal

See Also

Developer's Guide

showPopover

: boolean
Gets or sets whether the popover should be open/closed after the event.

The initial value depends on the configured popover behavior and context.

Setting this property will automatically set the QueryToolTipEventArgs.handled.

final

See Also

Developer's Guide