Interface Window

A window containing a DOM document; the document property points to the DOM document loaded in that window.

interface Window {
    _scheduledLayoutDown?: boolean;
    _window: any;
    active: boolean;
    addHeader: boolean;
    atTop: boolean;
    atTopMost: boolean;
    borderSize: number;
    bordered: boolean;
    bounds: Bounds;
    builtInMenu: boolean;
    caches: CacheStorage;
    canMaximize: boolean;
    canMinimize: boolean;
    canShow: boolean;
    clientHeight: number;
    clientInformation: Navigator;
    clientWidth: number;
    closed: boolean;
    crossOriginIsolated: boolean;
    crypto: Crypto;
    customElements: CustomElementRegistry;
    devToolsUrl: string;
    devicePixelRatio: number;
    doNotCheckLess?: boolean;
    dockAlign: string;
    dockPos: string;
    document: Document;
    event: Event;
    event_activated: ((isActivated, ncArea) => void);
    event_afterInit: (() => void);
    event_closeQuery: ((token) => void);
    event_closed: (() => void);
    event_dragfinished: ((e) => any);
    event_embeddedWindowCreate: (() => void);
    event_focusedcontrol: ((e) => any);
    event_initialized: (() => void);
    event_layoutchange: ((e) => any);
    event_load: (() => void);
    event_mousestatechanged: (() => void);
    event_moved: (() => void);
    event_ready: (() => void);
    event_scriptsLoaded: (() => void);
    event_show: (() => void);
    event_visibilityChanged: ((isMinimized, hidden, state) => void);
    external: External;
    fadeTime: number;
    flat: boolean;
    forceClose: boolean;
    frameElement: Element;
    frames: Window;
    headerClass: any;
    history: History;
    inData: string;
    indexedDB: IDBFactory;
    innerHeight: number;
    innerWidth: number;
    inspectElementSupported: boolean;
    isMainWindow: boolean;
    isMenu: boolean;
    isModal: boolean;
    isSecureContext: boolean;
    layoutLocked: number;
    layoutUpdateNeeded?: boolean;
    length: number;
    localStorage: Storage;
    locationbar: BarProp;
    magnetToScreen: boolean;
    magnetToWindows: boolean;
    maximized: boolean;
    menuJSON: string;
    menubar: BarProp;
    minimized: boolean;
    modalResult: number;
    mouseScreenX?: number;
    mouseScreenY?: number;
    mouseTarget?: EventTarget;
    mouseX?: number;
    mouseY?: number;
    moveable: boolean;
    name: string;
    navigator: Navigator;
    onabort: ((this, ev) => any);
    onafterprint: ((this, ev) => any);
    onanimationcancel: ((this, ev) => any);
    onanimationend: ((this, ev) => any);
    onanimationiteration: ((this, ev) => any);
    onanimationstart: ((this, ev) => any);
    onauxclick: ((this, ev) => any);
    onbeforeinput: ((this, ev) => any);
    onbeforeprint: ((this, ev) => any);
    onbeforeunload: ((this, ev) => any);
    onblur: ((this, ev) => any);
    oncancel: ((this, ev) => any);
    oncanplay: ((this, ev) => any);
    oncanplaythrough: ((this, ev) => any);
    onchange: ((this, ev) => any);
    onclick: ((this, ev) => any);
    onclose: ((this, ev) => any);
    oncontextmenu: ((this, ev) => any);
    oncopy: ((this, ev) => any);
    oncuechange: ((this, ev) => any);
    oncut: ((this, ev) => any);
    ondblclick: ((this, ev) => any);
    ondevicemotion: ((this, ev) => any);
    ondeviceorientation: ((this, ev) => any);
    ondrag: ((this, ev) => any);
    ondragend: ((this, ev) => any);
    ondragenter: ((this, ev) => any);
    ondragleave: ((this, ev) => any);
    ondragover: ((this, ev) => any);
    ondragstart: ((this, ev) => any);
    ondrop: ((this, ev) => any);
    ondurationchange: ((this, ev) => any);
    onemptied: ((this, ev) => any);
    onended: ((this, ev) => any);
    onerror: OnErrorEventHandlerNonNull;
    onfocus: ((this, ev) => any);
    onformdata: ((this, ev) => any);
    ongamepadconnected: ((this, ev) => any);
    ongamepaddisconnected: ((this, ev) => any);
    ongotpointercapture: ((this, ev) => any);
    onhashchange: ((this, ev) => any);
    oninput: ((this, ev) => any);
    oninvalid: ((this, ev) => any);
    onkeydown: ((this, ev) => any);
    onkeypress: ((this, ev) => any);
    onkeyup: ((this, ev) => any);
    onlanguagechange: ((this, ev) => any);
    onload: ((this, ev) => any);
    onloadeddata: ((this, ev) => any);
    onloadedmetadata: ((this, ev) => any);
    onloadstart: ((this, ev) => any);
    onlostpointercapture: ((this, ev) => any);
    onmessage: ((this, ev) => any);
    onmessageerror: ((this, ev) => any);
    onmousedown: ((this, ev) => any);
    onmouseenter: ((this, ev) => any);
    onmouseleave: ((this, ev) => any);
    onmousemove: ((this, ev) => any);
    onmouseout: ((this, ev) => any);
    onmouseover: ((this, ev) => any);
    onmouseup: ((this, ev) => any);
    onoffline: ((this, ev) => any);
    ononline: ((this, ev) => any);
    onorientationchange: ((this, ev) => any);
    onpagehide: ((this, ev) => any);
    onpageshow: ((this, ev) => any);
    onpaste: ((this, ev) => any);
    onpause: ((this, ev) => any);
    onplay: ((this, ev) => any);
    onplaying: ((this, ev) => any);
    onpointercancel: ((this, ev) => any);
    onpointerdown: ((this, ev) => any);
    onpointerenter: ((this, ev) => any);
    onpointerleave: ((this, ev) => any);
    onpointermove: ((this, ev) => any);
    onpointerout: ((this, ev) => any);
    onpointerover: ((this, ev) => any);
    onpointerup: ((this, ev) => any);
    onpopstate: ((this, ev) => any);
    onprogress: ((this, ev) => any);
    onratechange: ((this, ev) => any);
    onrejectionhandled: ((this, ev) => any);
    onreset: ((this, ev) => any);
    onresize: ((this, ev) => any);
    onscroll: ((this, ev) => any);
    onsecuritypolicyviolation: ((this, ev) => any);
    onseeked: ((this, ev) => any);
    onseeking: ((this, ev) => any);
    onselect: ((this, ev) => any);
    onselectionchange: ((this, ev) => any);
    onselectstart: ((this, ev) => any);
    onslotchange: ((this, ev) => any);
    onstalled: ((this, ev) => any);
    onstorage: ((this, ev) => any);
    onsubmit: ((this, ev) => any);
    onsuspend: ((this, ev) => any);
    ontimeupdate: ((this, ev) => any);
    ontoggle: ((this, ev) => any);
    ontouchcancel?: ((this, ev) => any);
    ontouchend?: ((this, ev) => any);
    ontouchmove?: ((this, ev) => any);
    ontouchstart?: ((this, ev) => any);
    ontransitioncancel: ((this, ev) => any);
    ontransitionend: ((this, ev) => any);
    ontransitionrun: ((this, ev) => any);
    ontransitionstart: ((this, ev) => any);
    onunhandledrejection: ((this, ev) => any);
    onunload: ((this, ev) => any);
    onvolumechange: ((this, ev) => any);
    onwaiting: ((this, ev) => any);
    onwebkitanimationend: ((this, ev) => any);
    onwebkitanimationiteration: ((this, ev) => any);
    onwebkitanimationstart: ((this, ev) => any);
    onwebkittransitionend: ((this, ev) => any);
    onwheel: ((this, ev) => any);
    opacity: number;
    opener: any;
    orientation: number;
    origin: string;
    outData: string;
    outerHeight: number;
    outerWidth: number;
    pageXOffset: number;
    pageYOffset: number;
    parent: Window;
    performance: Performance;
    personalbar: BarProp;
    popupMenuWindows: boolean;
    posSaveName: string;
    reloadInProgress: boolean;
    resizeable: boolean;
    rightClickOnImage?: boolean;
    screen: Screen;
    screenLeft: number;
    screenTop: number;
    screenX: number;
    screenY: number;
    scrollX: number;
    scrollY: number;
    scrollbars: BarProp;
    self: Window & typeof globalThis;
    sessionStorage: Storage;
    shape: string;
    shapeColor: number;
    showAsVideoPlayer: boolean;
    speechSynthesis: SpeechSynthesis;
    status: string;
    statusInfo: Promise<any>;
    statusbar: BarProp;
    systemDevicePixelRatio: number;
    textZoomRatio: number;
    thisWindow: SharedWindow;
    title: string;
    toolWindow: boolean;
    toolbar: BarProp;
    top: Window;
    url: string;
    visible: boolean;
    visualViewport: VisualViewport;
    window: Window & typeof globalThis;
    windowIsLoaded: boolean;
    location: Location;
    _(...params): any;
    _alert(...params): void;
    activate(): void;
    addEventListener<K>(type, listener, options?): void;
    addEventListener(type, listener, options?): void;
    alert(message?): void;
    applyWindowStates(...params): void;
    atob(data): string;
    blur(): void;
    btoa(data): string;
    callDialogInit(): void;
    callODS(s): void;
    cancelAnimationFrame(handle): void;
    cancelIdleCallback(handle): void;
    captureEvents(): void;
    clearInterval(id): void;
    clearTimeout(id): void;
    close(): void;
    closeWindow(): void;
    confirm(message?): boolean;
    createImageBitmap(image, options?): Promise<ImageBitmap>;
    createImageBitmap(image, sx, sy, sw, sh, options?): Promise<ImageBitmap>;
    createOwnWindow(URL, params): SharedWindow;
    customMenuItemClick(itemID, customData): void;
    dispatchEvent(event): boolean;
    executeCode(...params): any;
    executeFile(URL): void;
    fetch(input, init?): Promise<Response>;
    focus(): void;
    getAsyncShowToken(): any;
    getClassName(): string;
    getComputedStyle(elt, pseudoElt?): CSSStyleDeclaration;
    getSelection(): Selection;
    getValue(variable): any;
    getValueInWindowContext(Value): any;
    getWindowMonitor(): any;
    handleEmbeddedWindow(...params): Promise<any>;
    hide(): void;
    identifier(): number;
    include(filename): void;
    locked(func): void;
    matchMedia(query): MediaQueryList;
    maximize(): void;
    messageDlg(msg, dlgType, buttons, params, cbk): void;
    minimize(): void;
    moveBy(x, y): void;
    moveTo(x, y): void;
    newStringList(...params): StringList;
    notifyLoaded(): void;
    notifyOnClose(): void;
    notifyOnReady(): void;
    open(url?, target?, features?): Window;
    postMessage(message, targetOrigin, transfer?): void;
    postMessage(message, options?): void;
    preventClose(prevent): void;
    print(): void;
    prompt(message?, _default?): string;
    queueMicrotask(callback): void;
    releaseEvents(): void;
    removeEventListener<K>(type, listener, options?): void;
    removeEventListener(type, listener, options?): void;
    reportError(e): void;
    requestAnimationFrame(callback): number;
    requestIdleCallback(callback, options?): number;
    resizeBy(x, y): void;
    resizeTo(width, height): void;
    restore(): void;
    runCommand(val): Promise<any>;
    runJSCode_callback(...params): void;
    scroll(options?): void;
    scroll(x, y): void;
    scrollBy(options?): void;
    scrollBy(x, y): void;
    scrollTo(options?): void;
    scrollTo(x, y): void;
    setBackgroundColor(clr): void;
    setBounds(Aleft, Atop, Awidth, Aheight): void;
    setClientSize(Awidth, Aheight): void;
    setDock(pos, align): void;
    setInterval(handler, timeout?, ...arguments): number;
    setMoveableArea(data): void;
    setMoveableColor(par): void;
    setSize(Awidth, Aheight): void;
    setTimeout(handler, timeout?, ...arguments): number;
    setValue(variable, Value): void;
    setWindowState(hasBorder, isFlat): void;
    show(): void;
    showDevTools(...params): void;
    showModal(): void;
    stop(): void;
    structuredClone(value, options?): any;
    updateDevicePixelRatio(): void;
    updateMenu(Value): void;
    [index: number]: Window;
}

Hierarchy (view full)

  • EventTarget
  • AnimationFrameProvider
  • GlobalEventHandlers
  • WindowEventHandlers
  • WindowLocalStorage
  • WindowOrWorkerGlobalScope
  • WindowSessionStorage
  • SharedWindow
    • Window

Indexable

[index: number]: Window

Properties

_scheduledLayoutDown? _window active addHeader atTop atTopMost borderSize bordered bounds builtInMenu caches canMaximize canMinimize canShow clientHeight clientInformation clientWidth closed crossOriginIsolated crypto customElements devToolsUrl devicePixelRatio doNotCheckLess? dockAlign dockPos document event event_dragfinished event_focusedcontrol event_layoutchange external fadeTime flat forceClose frameElement frames headerClass history inData indexedDB innerHeight innerWidth inspectElementSupported isMainWindow isMenu isModal isSecureContext layoutLocked layoutUpdateNeeded? length localStorage locationbar magnetToScreen magnetToWindows maximized menuJSON menubar minimized modalResult mouseScreenX? mouseScreenY? mouseTarget? mouseX? mouseY? moveable name navigator onabort onafterprint onanimationcancel onanimationend onanimationiteration onanimationstart onauxclick onbeforeinput onbeforeprint onbeforeunload onblur oncancel oncanplay oncanplaythrough onchange onclick onclose oncontextmenu oncopy oncuechange oncut ondblclick ondevicemotion ondeviceorientation ondrag ondragend ondragenter ondragleave ondragover ondragstart ondrop ondurationchange onemptied onended onerror onfocus onformdata ongamepadconnected ongamepaddisconnected ongotpointercapture onhashchange oninput oninvalid onkeydown onkeypress onkeyup onlanguagechange onload onloadeddata onloadedmetadata onloadstart onlostpointercapture onmessage onmessageerror onmousedown onmouseenter onmouseleave onmousemove onmouseout onmouseover onmouseup onoffline ononline onorientationchange onpagehide onpageshow onpaste onpause onplay onplaying onpointercancel onpointerdown onpointerenter onpointerleave onpointermove onpointerout onpointerover onpointerup onpopstate onprogress onratechange onrejectionhandled onreset onresize onscroll onsecuritypolicyviolation onseeked onseeking onselect onselectionchange onselectstart onslotchange onstalled onstorage onsubmit onsuspend ontimeupdate ontoggle ontouchcancel? ontouchend? ontouchmove? ontouchstart? ontransitioncancel ontransitionend ontransitionrun ontransitionstart onunhandledrejection onunload onvolumechange onwaiting onwebkitanimationend onwebkitanimationiteration onwebkitanimationstart onwebkittransitionend onwheel opacity opener orientation origin outData outerHeight outerWidth pageXOffset pageYOffset parent performance personalbar popupMenuWindows posSaveName reloadInProgress resizeable rightClickOnImage? screen screenLeft screenTop screenX screenY scrollX scrollY scrollbars self sessionStorage shape shapeColor showAsVideoPlayer speechSynthesis status statusInfo statusbar systemDevicePixelRatio textZoomRatio thisWindow title toolWindow toolbar top url visible visualViewport window windowIsLoaded

Accessors

location

Methods

_ _alert activate addEventListener alert applyWindowStates atob blur btoa callDialogInit callODS cancelAnimationFrame cancelIdleCallback captureEvents clearInterval clearTimeout close closeWindow confirm createImageBitmap createOwnWindow customMenuItemClick dispatchEvent executeCode executeFile fetch focus getAsyncShowToken getClassName getComputedStyle getSelection getValue getValueInWindowContext getWindowMonitor handleEmbeddedWindow hide identifier include locked matchMedia maximize messageDlg minimize moveBy moveTo newStringList notifyLoaded notifyOnClose notifyOnReady open postMessage preventClose print prompt queueMicrotask releaseEvents removeEventListener reportError requestAnimationFrame requestIdleCallback resizeBy resizeTo restore runCommand runJSCode_callback scroll scrollBy scrollTo setBackgroundColor setBounds setClientSize setDock setInterval setMoveableArea setMoveableColor setSize setTimeout setValue setWindowState show showDevTools showModal stop structuredClone updateDevicePixelRatio updateMenu

Events

event_activated event_afterInit event_closeQuery event_closed event_embeddedWindowCreate event_initialized event_load event_mousestatechanged event_moved event_ready event_scriptsLoaded event_show event_visibilityChanged

Properties

Optional _scheduledLayoutDown

_scheduledLayoutDown?: boolean

Undocumented

_window

_window: any

Undocumented

active

active: boolean

Gets active state of the window

addHeader

addHeader: boolean

Undocumented

atTop

atTop: boolean

Gets/Sets window at top

atTopMost

atTopMost: boolean

Gets/Sets window at most top (over all windows)

borderSize

borderSize: number

Undocumented

bordered

bordered: boolean

Gets/Sets border of the window

bounds

bounds: Bounds

Get Bounds class of the window

builtInMenu

builtInMenu: boolean

Gets bool value whether menu can be built in window (Windows system) or need to be created outside of window (OSX)

Readonly caches

caches: CacheStorage

Available only in secure contexts.

canMaximize

canMaximize: boolean

Window can be maximized

canMinimize

canMinimize: boolean

Window can be minimized

canShow

canShow: boolean

Undocumented

clientHeight

clientHeight: number

Gets/Sets window's client height

Readonly clientInformation

clientInformation: Navigator

Deprecated

This is a legacy alias of navigator.

clientWidth

clientWidth: number

Gets/Sets window's client width

Readonly closed

closed: boolean

Returns true if the window has been closed, false otherwise.

Readonly crossOriginIsolated

crossOriginIsolated: boolean

Undocumented

Readonly crypto

crypto: Crypto

Undocumented

Readonly customElements

customElements: CustomElementRegistry

Defines a new custom element, mapping the given name to the given constructor as an autonomous custom element.

devToolsUrl

devToolsUrl: string

Undocumented

Readonly devicePixelRatio

devicePixelRatio: number

Undocumented

Optional doNotCheckLess

doNotCheckLess?: boolean

Undocumented

dockAlign

dockAlign: string

Gets align of the docked window. Available values are 'begin', 'middle', 'end'.

dockPos

dockPos: string

Gets position of the window where to dock by default. Available values are 'top', 'bottom', 'left', 'right'.

Readonly document

document: Document

Undocumented

Readonly event

event: Event

Deprecated

event_dragfinished

event_dragfinished: ((e) => any)

Type declaration

Undocumented

event_focusedcontrol

event_focusedcontrol: ((e) => any)

Type declaration

    • (e): any

    • Parameters

      • e: CustomEvent<any>

      Returns any

Undocumented

event_layoutchange

event_layoutchange: ((e) => any)

Type declaration

    • (e): any

    • Parameters

      • e: CustomEvent<any>

      Returns any

Undocumented

Readonly external

external: External

Deprecated

fadeTime

fadeTime: number

Gets/Sets fade in-out time of the window in ms.

flat

flat: boolean

Gets/Sets window style to flat. This style is used for notifications dialogs or maximized video window.

forceClose

forceClose: boolean

Undocumented

Readonly frameElement

frameElement: Element

Undocumented

Readonly frames

frames: Window

Undocumented

headerClass

headerClass: any

Undocumented

Readonly history

history: History

Undocumented

inData

inData: string

Undocumented

Readonly indexedDB

indexedDB: IDBFactory

Undocumented

Readonly innerHeight

innerHeight: number

Undocumented

Readonly innerWidth

innerWidth: number

Undocumented

inspectElementSupported

inspectElementSupported: boolean

Undocumented

isMainWindow

isMainWindow: boolean

Undocumented

isMenu

isMenu: boolean

Undocumented

isModal

isModal: boolean

Undocumented

Readonly isSecureContext

isSecureContext: boolean

Undocumented

layoutLocked

layoutLocked: number

Undocumented

Optional layoutUpdateNeeded

layoutUpdateNeeded?: boolean

Undocumented

Readonly length

length: number

Undocumented

Readonly localStorage

localStorage: Storage

Undocumented

Readonly locationbar

locationbar: BarProp

Returns true if the location bar is visible; otherwise, returns false.

magnetToScreen

magnetToScreen: boolean

Undocumented

magnetToWindows

magnetToWindows: boolean

Undocumented

maximized

maximized: boolean

Gets maximized state of the window

menuJSON

menuJSON: string

Undocumented

Readonly menubar

menubar: BarProp

Returns true if the menu bar is visible; otherwise, returns false.

minimized

minimized: boolean

Gets minimized state of the window

modalResult

modalResult: number

Gets/Sets result of modal window (window will close automatically when value is set)

Optional mouseScreenX

mouseScreenX?: number

Undocumented

Optional mouseScreenY

mouseScreenY?: number

Undocumented

Optional mouseTarget

mouseTarget?: EventTarget

Undocumented

Optional mouseX

mouseX?: number

Undocumented

Optional mouseY

mouseY?: number

Undocumented

moveable

moveable: boolean

Gets/Sets whether window can be moved

name

name: string

Undocumented

Readonly navigator

navigator: Navigator

Undocumented

onabort

onabort: ((this, ev) => any)

Fires when the user aborts the download.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: UIEvent

        The event.

      Returns any

onafterprint

onafterprint: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: WindowEventHandlers
      • ev: Event

      Returns any

Undocumented

onanimationcancel

onanimationcancel: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

Undocumented

onanimationend

onanimationend: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

Undocumented

onanimationiteration

onanimationiteration: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

Undocumented

onanimationstart

onanimationstart: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

Undocumented

onauxclick

onauxclick: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

Undocumented

onbeforeinput

onbeforeinput: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: InputEvent

      Returns any

Undocumented

onbeforeprint

onbeforeprint: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: WindowEventHandlers
      • ev: Event

      Returns any

Undocumented

onbeforeunload

onbeforeunload: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: WindowEventHandlers
      • ev: BeforeUnloadEvent

      Returns any

Undocumented

onblur

onblur: ((this, ev) => any)

Fires when the object loses the input focus.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: FocusEvent

        The focus event.

      Returns any

oncancel

oncancel: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Undocumented

oncanplay

oncanplay: ((this, ev) => any)

Occurs when playback is possible, but would require further buffering.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

oncanplaythrough

oncanplaythrough: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Undocumented

onchange

onchange: ((this, ev) => any)

Fires when the contents of the object or selection have changed.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onclick

onclick: ((this, ev) => any)

Fires when the user clicks the left mouse button on the object

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

      Returns any

onclose

onclose: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Undocumented

oncontextmenu

oncontextmenu: ((this, ev) => any)

Fires when the user clicks the right mouse button in the client area, opening the context menu.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

      Returns any

oncopy

oncopy: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: ClipboardEvent

      Returns any

Undocumented

oncuechange

oncuechange: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Undocumented

oncut

oncut: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: ClipboardEvent

      Returns any

Undocumented

ondblclick

ondblclick: ((this, ev) => any)

Fires when the user double-clicks the object.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

      Returns any

ondevicemotion

ondevicemotion: ((this, ev) => any)

Available only in secure contexts.

Type declaration

    • (this, ev): any

    • Parameters

      • this: Window
      • ev: DeviceMotionEvent

      Returns any

ondeviceorientation

ondeviceorientation: ((this, ev) => any)

Available only in secure contexts.

Type declaration

    • (this, ev): any

    • Parameters

      • this: Window
      • ev: DeviceOrientationEvent

      Returns any

ondrag

ondrag: ((this, ev) => any)

Fires on the source object continuously during a drag operation.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

        The event.

      Returns any

ondragend

ondragend: ((this, ev) => any)

Fires on the source object when the user releases the mouse at the close of a drag operation.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

        The event.

      Returns any

ondragenter

ondragenter: ((this, ev) => any)

Fires on the target element when the user drags the object to a valid drop target.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

        The drag event.

      Returns any

ondragleave

ondragleave: ((this, ev) => any)

Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

        The drag event.

      Returns any

ondragover

ondragover: ((this, ev) => any)

Fires on the target element continuously while the user drags the object over a valid drop target.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

        The event.

      Returns any

ondragstart

ondragstart: ((this, ev) => any)

Fires on the source object when the user starts to drag a text selection or selected object.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

        The event.

      Returns any

ondrop

ondrop: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

      Returns any

Undocumented

ondurationchange

ondurationchange: ((this, ev) => any)

Occurs when the duration attribute is updated.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onemptied

onemptied: ((this, ev) => any)

Occurs when the media element is reset to its initial state.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onended

onended: ((this, ev) => any)

Occurs when the end of playback is reached.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event

      Returns any

onerror

onerror: OnErrorEventHandlerNonNull

Fires when an error occurs during object loading.

Param: ev

The event.

onfocus

onfocus: ((this, ev) => any)

Fires when the object receives focus.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: FocusEvent

        The event.

      Returns any

onformdata

onformdata: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: FormDataEvent

      Returns any

Undocumented

ongamepadconnected

ongamepadconnected: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: WindowEventHandlers
      • ev: GamepadEvent

      Returns any

Undocumented

ongamepaddisconnected

ongamepaddisconnected: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: WindowEventHandlers
      • ev: GamepadEvent

      Returns any

Undocumented

ongotpointercapture

ongotpointercapture: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

Undocumented

onhashchange

onhashchange: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: WindowEventHandlers
      • ev: HashChangeEvent

      Returns any

Undocumented

oninput

oninput: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Undocumented

oninvalid

oninvalid: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Undocumented

onkeydown

onkeydown: ((this, ev) => any)

Fires when the user presses a key.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: KeyboardEvent

        The keyboard event

      Returns any

onkeypress

onkeypress: ((this, ev) => any)

Fires when the user presses an alphanumeric key.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: KeyboardEvent

        The event.

      Returns any

Deprecated

onkeyup

onkeyup: ((this, ev) => any)

Fires when the user releases a key.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: KeyboardEvent

        The keyboard event

      Returns any

onlanguagechange

onlanguagechange: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: WindowEventHandlers
      • ev: Event

      Returns any

Undocumented

onload

onload: ((this, ev) => any)

Fires immediately after the browser loads the object.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onloadeddata

onloadeddata: ((this, ev) => any)

Occurs when media data is loaded at the current playback position.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onloadedmetadata

onloadedmetadata: ((this, ev) => any)

Occurs when the duration and dimensions of the media have been determined.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onloadstart

onloadstart: ((this, ev) => any)

Occurs when Internet Explorer begins looking for media data.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onlostpointercapture

onlostpointercapture: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

Undocumented

onmessage

onmessage: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: WindowEventHandlers
      • ev: MessageEvent<any>

      Returns any

Undocumented

onmessageerror

onmessageerror: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: WindowEventHandlers
      • ev: MessageEvent<any>

      Returns any

Undocumented

onmousedown

onmousedown: ((this, ev) => any)

Fires when the user clicks the object with either mouse button.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

      Returns any

onmouseenter

onmouseenter: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

Undocumented

onmouseleave

onmouseleave: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

Undocumented

onmousemove

onmousemove: ((this, ev) => any)

Fires when the user moves the mouse over the object.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

      Returns any

onmouseout

onmouseout: ((this, ev) => any)

Fires when the user moves the mouse pointer outside the boundaries of the object.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

      Returns any

onmouseover

onmouseover: ((this, ev) => any)

Fires when the user moves the mouse pointer into the object.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

      Returns any

onmouseup

onmouseup: ((this, ev) => any)

Fires when the user releases a mouse button while the mouse is over the object.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

      Returns any

onoffline

onoffline: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: WindowEventHandlers
      • ev: Event

      Returns any

Undocumented

ononline

ononline: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: WindowEventHandlers
      • ev: Event

      Returns any

Undocumented

onorientationchange

onorientationchange: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

Deprecated

onpagehide

onpagehide: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: WindowEventHandlers
      • ev: PageTransitionEvent

      Returns any

Undocumented

onpageshow

onpageshow: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: WindowEventHandlers
      • ev: PageTransitionEvent

      Returns any

Undocumented

onpaste

onpaste: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: ClipboardEvent

      Returns any

Undocumented

onpause

onpause: ((this, ev) => any)

Occurs when playback is paused.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onplay

onplay: ((this, ev) => any)

Occurs when the play method is requested.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onplaying

onplaying: ((this, ev) => any)

Occurs when the audio or video has started playing.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onpointercancel

onpointercancel: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

Undocumented

onpointerdown

onpointerdown: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

Undocumented

onpointerenter

onpointerenter: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

Undocumented

onpointerleave

onpointerleave: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

Undocumented

onpointermove

onpointermove: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

Undocumented

onpointerout

onpointerout: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

Undocumented

onpointerover

onpointerover: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

Undocumented

onpointerup

onpointerup: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

Undocumented

onpopstate

onpopstate: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: WindowEventHandlers
      • ev: PopStateEvent

      Returns any

Undocumented

onprogress

onprogress: ((this, ev) => any)

Occurs to indicate progress while downloading media data.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: ProgressEvent<EventTarget>

        The event.

      Returns any

onratechange

onratechange: ((this, ev) => any)

Occurs when the playback rate is increased or decreased.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onrejectionhandled

onrejectionhandled: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: WindowEventHandlers
      • ev: PromiseRejectionEvent

      Returns any

Undocumented

onreset

onreset: ((this, ev) => any)

Fires when the user resets a form.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onresize

onresize: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: UIEvent

      Returns any

Undocumented

onscroll

onscroll: ((this, ev) => any)

Fires when the user repositions the scroll box in the scroll bar on the object.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onsecuritypolicyviolation

onsecuritypolicyviolation: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: SecurityPolicyViolationEvent

      Returns any

Undocumented

onseeked

onseeked: ((this, ev) => any)

Occurs when the seek operation ends.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onseeking

onseeking: ((this, ev) => any)

Occurs when the current playback position is moved.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onselect

onselect: ((this, ev) => any)

Fires when the current selection changes.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onselectionchange

onselectionchange: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Undocumented

onselectstart

onselectstart: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Undocumented

onslotchange

onslotchange: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Undocumented

onstalled

onstalled: ((this, ev) => any)

Occurs when the download has stopped.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onstorage

onstorage: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: WindowEventHandlers
      • ev: StorageEvent

      Returns any

Undocumented

onsubmit

onsubmit: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: SubmitEvent

      Returns any

Undocumented

onsuspend

onsuspend: ((this, ev) => any)

Occurs if the load operation has been intentionally halted.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

ontimeupdate

ontimeupdate: ((this, ev) => any)

Occurs to indicate the current playback position.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

ontoggle

ontoggle: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Undocumented

Optional ontouchcancel

ontouchcancel?: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

Undocumented

Optional ontouchend

ontouchend?: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

Undocumented

Optional ontouchmove

ontouchmove?: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

Undocumented

Optional ontouchstart

ontouchstart?: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

Undocumented

ontransitioncancel

ontransitioncancel: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

Undocumented

ontransitionend

ontransitionend: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

Undocumented

ontransitionrun

ontransitionrun: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

Undocumented

ontransitionstart

ontransitionstart: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

Undocumented

onunhandledrejection

onunhandledrejection: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: WindowEventHandlers
      • ev: PromiseRejectionEvent

      Returns any

Undocumented

onunload

onunload: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: WindowEventHandlers
      • ev: Event

      Returns any

Undocumented

onvolumechange

onvolumechange: ((this, ev) => any)

Occurs when the volume is changed, or playback is muted or unmuted.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onwaiting

onwaiting: ((this, ev) => any)

Occurs when playback stops because the next frame of a video resource is not available.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onwebkitanimationend

onwebkitanimationend: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Deprecated

This is a legacy alias of onanimationend.

onwebkitanimationiteration

onwebkitanimationiteration: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Deprecated

This is a legacy alias of onanimationiteration.

onwebkitanimationstart

onwebkitanimationstart: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Deprecated

This is a legacy alias of onanimationstart.

onwebkittransitionend

onwebkittransitionend: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Deprecated

This is a legacy alias of ontransitionend.

onwheel

onwheel: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: WheelEvent

      Returns any

Undocumented

opacity

opacity: number

Gets/Sets opacity of the window in percentage (0=transparent to 100=opaque, default is 100)

opener

opener: any

Undocumented

Readonly orientation

orientation: number

Deprecated

Readonly origin

origin: string

Undocumented

outData

outData: string

Undocumented

Readonly outerHeight

outerHeight: number

Undocumented

Readonly outerWidth

outerWidth: number

Undocumented

Readonly pageXOffset

pageXOffset: number

Deprecated

This is a legacy alias of scrollX.

Readonly pageYOffset

pageYOffset: number

Deprecated

This is a legacy alias of scrollY.

Readonly parent

parent: Window

Refers to either the parent WindowProxy, or itself.

It can rarely be null e.g. for contentWindow of an iframe that is already removed from the parent.

Readonly performance

performance: Performance

Undocumented

Readonly personalbar

personalbar: BarProp

Returns true if the personal bar is visible; otherwise, returns false.

popupMenuWindows

popupMenuWindows: boolean

Shape of the window used when semi-transparent window need to be shown. if set to true. It's supposed to be a name of the PNG file with alpha.

posSaveName

posSaveName: string

Gets/Sets name for window's position and size save

reloadInProgress

reloadInProgress: boolean

Undocumented

resizeable

resizeable: boolean

Gets/Sets whether window can resize

Optional rightClickOnImage

rightClickOnImage?: boolean

Undocumented

Readonly screen

screen: Screen

Undocumented

Readonly screenLeft

screenLeft: number

Undocumented

Readonly screenTop

screenTop: number

Undocumented

Readonly screenX

screenX: number

Undocumented

Readonly screenY

screenY: number

Undocumented

Readonly scrollX

scrollX: number

Undocumented

Readonly scrollY

scrollY: number

Undocumented

Readonly scrollbars

scrollbars: BarProp

Returns true if the scrollbars are visible; otherwise, returns false.

Readonly self

self: Window & typeof globalThis

Undocumented

Readonly sessionStorage

sessionStorage: Storage

Undocumented

shape

shape: string

Undocumented

shapeColor

shapeColor: number

Undocumented

showAsVideoPlayer

showAsVideoPlayer: boolean

Undocumented

Readonly speechSynthesis

speechSynthesis: SpeechSynthesis

Undocumented

status

status: string

Deprecated

statusInfo

statusInfo: Promise<any>

Undocumented

Readonly statusbar

statusbar: BarProp

Returns true if the status bar is visible; otherwise, returns false.

systemDevicePixelRatio

systemDevicePixelRatio: number

Undocumented

textZoomRatio

textZoomRatio: number

Undocumented

thisWindow

thisWindow: SharedWindow

Undocumented

title

title: string

Gets/Sets title of the window (visible in the caption bar).

toolWindow

toolWindow: boolean

Gets/Sets tool window style

Readonly toolbar

toolbar: BarProp

Returns true if the toolbar is visible; otherwise, returns false.

Readonly top

top: Window

Undocumented

url

url: string

Get's URL of the window.

visible

visible: boolean

Get window visibility

Readonly visualViewport

visualViewport: VisualViewport

Undocumented

Readonly window

window: Window & typeof globalThis

Undocumented

windowIsLoaded

windowIsLoaded: boolean

Undocumented

Accessors

location

  • get location(): Location

  • Returns Location

  • set location(href): void

  • Parameters

    • href: string | Location

    Returns void

Methods

_

  • _(...params): any

  • Translates string to current language

    Parameters

    • Rest ...params: any[]

    Returns any

    string

_alert

  • _alert(...params): void

  • Parameters

    • Rest ...params: any[]

    Returns void

    Undocumented

activate

  • activate(): void

  • Makes window active.

    Returns void

addEventListener

  • addEventListener<K>(type, listener, options?): void

  • Type Parameters

    • K extends keyof WindowEventMap

    Parameters

    • type: K
    • listener: ((this, ev) => any)
        • (this, ev): any

        • Parameters

          Returns any

    • Optional options: boolean | AddEventListenerOptions

    Returns void

    Undocumented

  • addEventListener(type, listener, options?): void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optional options: boolean | AddEventListenerOptions

    Returns void

    Undocumented

alert

  • alert(message?): void

  • Parameters

    • Optional message: any

    Returns void

    Undocumented

applyWindowStates

  • applyWindowStates(...params): void

  • Parameters

    • Rest ...params: any[]

    Returns void

    Undocumented

atob

  • atob(data): string

  • Parameters

    • data: string

    Returns string

    Undocumented

blur

  • blur(): void

  • Returns void

    Undocumented

btoa

  • btoa(data): string

  • Parameters

    • data: string

    Returns string

    Undocumented

callDialogInit

callODS

  • callODS(s): void

  • Send debug string to log

    Parameters

    • s: string

    Returns void

cancelAnimationFrame

  • cancelAnimationFrame(handle): void

  • Parameters

    • handle: number

    Returns void

    Undocumented

cancelIdleCallback

  • cancelIdleCallback(handle): void

  • Parameters

    • handle: number

    Returns void

    Undocumented

captureEvents

  • captureEvents(): void

  • Returns void

    Deprecated

clearInterval

  • clearInterval(id): void

  • Parameters

    • id: number

    Returns void

    Undocumented

clearTimeout

  • clearTimeout(id): void

  • Parameters

    • id: number

    Returns void

    Undocumented

close

  • close(): void

  • Closes the window.

    Returns void

closeWindow

  • closeWindow(): void

  • Close window

    Returns void

confirm

  • confirm(message?): boolean

  • Parameters

    • Optional message: string

    Returns boolean

    Undocumented

createImageBitmap

  • createImageBitmap(image, options?): Promise<ImageBitmap>

  • Parameters

    • image: ImageBitmapSource
    • Optional options: ImageBitmapOptions

    Returns Promise<ImageBitmap>

    Undocumented

  • createImageBitmap(image, sx, sy, sw, sh, options?): Promise<ImageBitmap>

  • Parameters

    • image: ImageBitmapSource
    • sx: number
    • sy: number
    • sw: number
    • sh: number
    • Optional options: ImageBitmapOptions

    Returns Promise<ImageBitmap>

    Undocumented

createOwnWindow

  • createOwnWindow(URL, params): SharedWindow

  • Create child window with current window is set as parent

    Parameters

    • URL: string

      URL to open in new window

    • params: any

      Parameters to create window (left, top, width, height)

    Returns SharedWindow

    TSharedWindow

customMenuItemClick

  • customMenuItemClick(itemID, customData): void

  • Parameters

    • itemID: number
    • customData: number

    Returns void

    Undocumented

dispatchEvent

  • dispatchEvent(event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    Parameters

    • event: Event

    Returns boolean

executeCode

  • executeCode(...params): any

  • Executes the given JS code in the target HTML window.

    Parameters

    • Rest ...params: any[]

    Returns any

    variant

executeFile

  • executeFile(URL): void

  • Exceutes the given JS script in the target HTML window.

    Parameters

    • URL: string

      URL of script to be executed

    Returns void

fetch

  • fetch(input, init?): Promise<Response>

  • Parameters

    • input: URL | RequestInfo
    • Optional init: RequestInit

    Returns Promise<Response>

    Undocumented

focus

  • focus(): void

  • Moves the focus to the window's browsing context, if any.

    Returns void

getAsyncShowToken

  • getAsyncShowToken(): any

  • Get async show token (to override default show mechanism). Call this token once dialog is prepared and can be shown.

    Returns any

getClassName

  • getClassName(): string

  • Gets class name of the object.

    Returns string

getComputedStyle

  • getComputedStyle(elt, pseudoElt?): CSSStyleDeclaration

  • Parameters

    • elt: Element
    • Optional pseudoElt: string

    Returns CSSStyleDeclaration

    Undocumented

getSelection

  • getSelection(): Selection

  • Returns Selection

    Undocumented

getValue

  • getValue(variable): any

  • Parameters

    • variable: string

    Returns any

    Undocumented

getValueInWindowContext

getWindowMonitor

handleEmbeddedWindow

  • handleEmbeddedWindow(...params): Promise<any>

  • Create/Update/Delete embedded window with custom content.

    Parameters

    • Rest ...params: any[]

    Returns Promise<any>

hide

  • hide(): void

  • Hide window

    Returns void

identifier

  • identifier(): number

  • Returns number

    Undocumented

include

  • include(filename): void

  • Include script to current window

    Parameters

    • filename: string

      Name of script file

    Returns void

locked

  • locked(func): void

  • Call defined method with locked data so user can access them.

    Parameters

    • func: (() => any)

      Method to call

        • (): any

        • Returns any

    Returns void

matchMedia

  • matchMedia(query): MediaQueryList

  • Parameters

    • query: string

    Returns MediaQueryList

    Undocumented

maximize

  • maximize(): void

  • Maximize window

    Returns void

messageDlg

  • messageDlg(msg, dlgType, buttons, params, cbk): void

  • Shows standard message dialog.

    Parameters

    • msg: string

      Text of the message.

    • dlgType: string

      Message dialog type: 'warning', 'error', 'information', 'confirmation' or 'help'

    • buttons: any

      Array of buttons. Each button could be defined by its string ID or by object (Buttons.addBtn | for structure see parameter params of addBtn method)
      Possible button id's: 'btnYes', 'btnNo', 'btnOK', 'btnCancel', 'btnAbort', 'btnRetry', 'btnIgnore', 'btnAll', 'btnNoToAll', 'btnYesToAll', 'btnHelp', 'btnClose' or some custom.

    • params: any

      Object with other params. Possible attributes:
      title: window caption.
      defaultButton: id of default button.
      chbCaption: caption of checkbox.
      checked: initial state of checkbox.

    • cbk: any

      Callback function, that receives the result value (object with buttonID and checked attributes).

    Returns void

    Example

    messageDlg('Some message.', 'information', ['btnOK', 'btnCancel', {btnID:'btnHelp', caption:'Custom help'}], 'btnOK', function (result) {
    alert("Result received: " + result);
    });

minimize

  • minimize(): void

  • Minimize window

    Returns void

moveBy

  • moveBy(x, y): void

  • Parameters

    • x: number
    • y: number

    Returns void

    Undocumented

moveTo

  • moveTo(x, y): void

  • Parameters

    • x: number
    • y: number

    Returns void

    Undocumented

newStringList

notifyLoaded

notifyOnClose

notifyOnReady

open

  • open(url?, target?, features?): Window

  • Parameters

    • Optional url: string | URL
    • Optional target: string
    • Optional features: string

    Returns Window

    Undocumented

postMessage

  • postMessage(message, targetOrigin, transfer?): void

  • Posts a message to the given window. Messages can be structured objects, e.g. nested objects and arrays, can contain JavaScript values (strings, numbers, Date objects, etc), and can contain certain data objects such as File Blob, FileList, and ArrayBuffer objects.

    Objects listed in the transfer member of options are transferred, not just cloned, meaning that they are no longer usable on the sending side.

    A target origin can be specified using the targetOrigin member of options. If not provided, it defaults to "/". This default restricts the message to same-origin targets only.

    If the origin of the target window doesn't match the given target origin, the message is discarded, to avoid information leakage. To send the message to the target regardless of origin, set the target origin to "*".

    Throws a "DataCloneError" DOMException if transfer array contains duplicate objects or if message could not be cloned.

    Parameters

    • message: any
    • targetOrigin: string
    • Optional transfer: Transferable[]

    Returns void

  • postMessage(message, options?): void

  • Parameters

    • message: any
    • Optional options: WindowPostMessageOptions

    Returns void

    Undocumented

preventClose

  • preventClose(prevent): void

  • Parameters

    • prevent: boolean

    Returns void

    Undocumented

print

  • print(): void

  • Returns void

    Undocumented

prompt

  • prompt(message?, _default?): string

  • Parameters

    • Optional message: string
    • Optional _default: string

    Returns string

    Undocumented

queueMicrotask

  • queueMicrotask(callback): void

  • Parameters

    • callback: VoidFunction

    Returns void

    Undocumented

releaseEvents

  • releaseEvents(): void

  • Returns void

    Deprecated

removeEventListener

  • removeEventListener<K>(type, listener, options?): void

  • Type Parameters

    • K extends keyof WindowEventMap

    Parameters

    • type: K
    • listener: ((this, ev) => any)
        • (this, ev): any

        • Parameters

          Returns any

    • Optional options: boolean | EventListenerOptions

    Returns void

    Undocumented

  • removeEventListener(type, listener, options?): void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optional options: boolean | EventListenerOptions

    Returns void

    Undocumented

reportError

  • reportError(e): void

  • Parameters

    • e: any

    Returns void

    Undocumented

requestAnimationFrame

  • requestAnimationFrame(callback): number

  • Parameters

    • callback: FrameRequestCallback

    Returns number

    Undocumented

requestIdleCallback

  • requestIdleCallback(callback, options?): number

  • Parameters

    • callback: IdleRequestCallback
    • Optional options: IdleRequestOptions

    Returns number

    Undocumented

resizeBy

  • resizeBy(x, y): void

  • Parameters

    • x: number
    • y: number

    Returns void

    Undocumented

resizeTo

  • resizeTo(width, height): void

  • Parameters

    • width: number
    • height: number

    Returns void

    Undocumented

restore

  • restore(): void

  • Restore window

    Returns void

runCommand

  • runCommand(val): Promise<any>

  • Parameters

    • val: any

    Returns Promise<any>

    Undocumented

runJSCode_callback

  • runJSCode_callback(...params): void

  • Parameters

    • Rest ...params: any[]

    Returns void

    Undocumented

scroll

  • scroll(options?): void

  • Parameters

    • Optional options: ScrollToOptions

    Returns void

    Undocumented

  • scroll(x, y): void

  • Parameters

    • x: number
    • y: number

    Returns void

    Undocumented

scrollBy

  • scrollBy(options?): void

  • Parameters

    • Optional options: ScrollToOptions

    Returns void

    Undocumented

  • scrollBy(x, y): void

  • Parameters

    • x: number
    • y: number

    Returns void

    Undocumented

scrollTo

  • scrollTo(options?): void

  • Parameters

    • Optional options: ScrollToOptions

    Returns void

    Undocumented

  • scrollTo(x, y): void

  • Parameters

    • x: number
    • y: number

    Returns void

    Undocumented

setBackgroundColor

  • setBackgroundColor(clr): void

  • Parameters

    • clr: string

    Returns void

    Undocumented

setBounds

  • setBounds(Aleft, Atop, Awidth, Aheight): void

  • Set bounds of the window

    Parameters

    • Aleft: number
    • Atop: number
    • Awidth: number
    • Aheight: number

    Returns void

setClientSize

  • setClientSize(Awidth, Aheight): void

  • Sets window client size

    Parameters

    • Awidth: number
    • Aheight: number

    Returns void

setDock

  • setDock(pos, align): void

  • Parameters

    • pos: string
    • align: string

    Returns void

    Undocumented

setInterval

  • setInterval(handler, timeout?, ...arguments): number

  • Parameters

    • handler: TimerHandler
    • Optional timeout: number
    • Rest ...arguments: any[]

    Returns number

    Undocumented

setMoveableArea

  • setMoveableArea(data): void

  • Parameters

    • data: any

    Returns void

    Undocumented

setMoveableColor

  • setMoveableColor(par): void

  • Parameters

    • par: any

    Returns void

    Undocumented

setSize

  • setSize(Awidth, Aheight): void

  • Sets window size

    Parameters

    • Awidth: number
    • Aheight: number

    Returns void

setTimeout

  • setTimeout(handler, timeout?, ...arguments): number

  • Parameters

    • handler: TimerHandler
    • Optional timeout: number
    • Rest ...arguments: any[]

    Returns number

    Undocumented

setValue

  • setValue(variable, Value): void

  • Parameters

    • variable: string
    • Value: any

    Returns void

    Undocumented

setWindowState

  • setWindowState(hasBorder, isFlat): void

  • Parameters

    • hasBorder: boolean
    • isFlat: boolean

    Returns void

    Undocumented

show

  • show(): void

  • Show window

    Returns void

showDevTools

  • showDevTools(...params): void

  • Parameters

    • Rest ...params: any[]

    Returns void

    Undocumented

showModal

  • showModal(): void

  • Show window as modal dialog

    Returns void

stop

  • stop(): void

  • Cancels the document load.

    Returns void

structuredClone

  • structuredClone(value, options?): any

  • Parameters

    • value: any
    • Optional options: StructuredSerializeOptions

    Returns any

    Undocumented

updateDevicePixelRatio

updateMenu

  • updateMenu(Value): void

  • Parameters

    • Value: string

    Returns void

    Undocumented

Events

event_activated

event_activated: ((isActivated, ncArea) => void)

Event is called when window become active

See App.listen

Type declaration

    • (isActivated, ncArea): void

    • Parameters

      • isActivated: boolean
      • ncArea: boolean

      Returns void

event_afterInit

event_afterInit: (() => void)

Event is called after the dialog's init function is called

See App.listen

Type declaration

    • (): void

    • Returns void

event_closeQuery

event_closeQuery: ((token) => void)

Event is called when browser is going to close

See App.listen

Type declaration

    • (token): void

    • Parameters

      Returns void

event_closed

event_closed: (() => void)

Event is called when browser is closed

See App.listen

Type declaration

    • (): void

    • Returns void

event_embeddedWindowCreate

event_embeddedWindowCreate: (() => void)

Event is called when embedded window is created

See App.listen

Type declaration

    • (): void

    • Returns void

event_initialized

event_initialized: (() => void)

Event is called when window is initialized and ready to use context

See App.listen

Type declaration

    • (): void

    • Returns void

event_load

event_load: (() => void)

Event is called when page is loaded into memory

See App.listen

Type declaration

    • (): void

    • Returns void

event_mousestatechanged

event_mousestatechanged: (() => void)

Event is called when any mouse event is raised (move, down, up...)

See App.listen

Type declaration

    • (): void

    • Returns void

event_moved

event_moved: (() => void)

Event is called when window is moved to new location

See App.listen

Type declaration

    • (): void

    • Returns void

event_ready

event_ready: (() => void)

Event is called when DCOM is finished

See App.listen

Type declaration

    • (): void

    • Returns void

event_scriptsLoaded

event_scriptsLoaded: (() => void)

Event is called when all scripts are loaded

See App.listen

Type declaration

    • (): void

    • Returns void

event_show

event_show: (() => void)

Event is called when window is shown

See App.listen

Type declaration

    • (): void

    • Returns void

event_visibilityChanged

event_visibilityChanged: ((isMinimized, hidden, state) => void)

Event is called when window's visibility was changed (e.g. window gets hidden or minimized)

See App.listen

Type declaration

    • (isMinimized, hidden, state): void

    • Parameters

      • isMinimized: boolean

        new window state is 'minimized'

      • hidden: boolean

        window is going to hide

      • state: any

        window state

      Returns void

Download
Forum
Support
Addons
Develop

Settings

Member Visibility

Theme

© 2000-2024 Ventis Media Inc.Generated using TypeDoc