This site is currently undergoing maintenance, so instances of "RelativityOne" may still be present. You may also experience 404 errors, search disruptions, and temporary style changes.

Last date modified: 2026-Sep-09

Interface: IHighlightListenerActive()

Listener function for the [[ViewHighlights]] active event. This event is fired whenever a highlight is activated or deactivated.

The arguments to this event listener are as follows:

IHighlightListenerActive(highlights, refObject?, ...args?): void

Listener function for the [[ViewHighlights]] active event. This event is fired whenever a highlight is activated or deactivated.

The arguments to this event listener are as follows:

Parameters

• highlights: HighlightMemento[]

The current list of active highlights

• refObject?: any

The first additional argument that was passed in to [[ViewHighlights.onactive]] or [[ViewHighlights.onactiveonce]]

• ...args?: any[]

Additional arguments that were passed in to [[ViewHighlights.onactive]] or [[ViewHighlights.onactiveonce]]

Returns

void

Feedback