Last date modified: 2025-Jul-02

Interface: IApplicationWindow

Instance of a Window created by IWindowService. Provides properties, methods and events to manage a single popup Window.

Extends

Properties

isMain

readonlyisMain: boolean

Indicates if this window is running Review Interface application.


isOpen

readonlyisOpen: boolean

Whether or not this window is open


isRelativityWindow

readonlyisRelativityWindow: boolean

Indicates if this window is running Relativity application.


name

readonlyname: string

Unique Identifier for the Window.


window?

readonlyoptionalwindow: Window

The window reference containing a DOM document.

Methods

close()

close(): boolean

Closes this window if it's open.

Returns

boolean

true if window was closed successfully.


off()

off(eventType, handler?, once?): void

Unregisters an event handler

Parameters

eventType: ApplicationWindowEventType

Event to unregister from

handler?: EventHandler

Event handler function. If not passed in, it removes all event handlers.

once?: boolean

Boolean indicating if the event handler was registered as a one-time event handler (Defaults to false)

Returns

void

Inherited from

IEventEmitter.off


on()

on(eventType, handler): void

Registers an event handler

Parameters

eventType: ApplicationWindowEventType

Event to listen for

handler: EventHandler

Event handler function

Returns

void

Inherited from

IEventEmitter.on


once()

once(eventType, handler): void

Registers an event handler that is only run once

Parameters

eventType: ApplicationWindowEventType

Event to listen for

handler: EventHandler

Event handler function

Returns

void

Inherited from

IEventEmitter.once

Return to top of the page
Feedback