Last date modified: 2025-Jul-02

Interface: IHighlightListenerClick()

Listener function for the [[ViewHighlights]] click event. This event is fired whenever a highlight is clicked.

The arguments to this event listener are as follows:

IHighlightListenerClick(highlight, isActive, refObject?, ...args?): void

Listener function for the [[ViewHighlights]] click event. This event is fired whenever a highlight is clicked.

The arguments to this event listener are as follows:

Parameters

highlight: HighlightMemento

The affected [[HighlightMemento]] object

isActive: boolean

Whether the affected highlight is now active

refObject?: any

The first additional argument that was passed in to [[ViewHighlights.onclick]] or [[ViewHighlights.onclickonce]]

• ...args?: any[]

Additional arguments that were passed in to [[ViewHighlights.onclick]] or [[ViewHighlights.onclickonce]]

Returns

void

Return to top of the page
Feedback