Window handling management and an extension of the DOM 'window' object.

SharedWindow

Hierarchy (view full)

Indexable

[key: `on${string}`]: any

Constructors

Properties

_window: any

Undocumented

active: boolean

Gets active state of the window

addHeader: boolean

Undocumented

atTop: boolean

Gets/Sets window at top

atTopMost: boolean

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

borderSize: number

Undocumented

bordered: boolean

Gets/Sets border of the window

bounds: Bounds

Get Bounds class of the window

builtInMenu: boolean

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

canMaximize: boolean

Window can be maximized

canMinimize: boolean

Window can be minimized

canShow: boolean

Undocumented

clientHeight: number

Gets/Sets window's client height

clientWidth: number

Gets/Sets window's client width

devToolsUrl: string

Undocumented

dockAlign: string

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

dockPos: string

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

fadeTime: number

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

flat: boolean

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

forceClose: boolean

Undocumented

headerClass: any

Undocumented

inData: string

Undocumented

inspectElementSupported: boolean

Undocumented

isMainWindow: boolean

Undocumented

isMenu: boolean

Undocumented

isModal: boolean

Undocumented

magnetToScreen: boolean

Undocumented

magnetToWindows: boolean

Undocumented

maximized: boolean

Gets maximized state of the window

menuJSON: string

Undocumented

minimized: boolean

Gets minimized state of the window

modalResult: number

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

moveable: boolean

Gets/Sets whether window can be moved

opacity: number

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

outData: string

Undocumented

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: string

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

reloadInProgress: boolean

Undocumented

resizeable: boolean

Gets/Sets whether window can resize

shape: string

Undocumented

shapeColor: number

Undocumented

showAsVideoPlayer: boolean

Undocumented

statusInfo: Promise<any>

Undocumented

systemDevicePixelRatio: number

Undocumented

textZoomRatio: number

Undocumented

thisWindow: SharedWindow

Undocumented

title: string

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

toolWindow: boolean

Gets/Sets tool window style

url: string

Get's URL of the window.

visible: boolean

Get window visibility

windowIsLoaded: boolean

Undocumented

Methods

  • Translates string to current language

    Parameters

    • Rest ...params: any[]

    Returns any

    string

  • Parameters

    • Rest ...params: any[]

    Returns void

    Undocumented

  • Makes window active.

    Returns void

  • Parameters

    • Rest ...params: any[]

    Returns void

    Undocumented

  • Returns void

    Undocumented

  • Send debug string to log

    Parameters

    • s: string

    Returns void

  • Close window

    Returns void

  • 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

  • Parameters

    • itemID: number
    • customData: number

    Returns void

    Undocumented

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

    Parameters

    • Rest ...params: any[]

    Returns any

    variant

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

    Parameters

    • URL: string

      URL of script to be executed

    Returns void

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

    Returns any

  • Gets class name of the object.

    Returns string

  • Parameters

    • variable: string

    Returns any

    Undocumented

  • Parameters

    • Value: any

    Returns any

    Undocumented

  • Returns any

    Undocumented

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

    Parameters

    • Rest ...params: any[]

    Returns Promise<any>

  • Hide window

    Returns void

  • Returns number

    Undocumented

  • Include script to current window

    Parameters

    • filename: string

      Name of script file

    Returns void

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

    Parameters

    • func: (() => any)

      Method to call

        • (): any
        • Returns any

    Returns void

  • Maximize window

    Returns 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 window

    Returns void

  • Create new SharedStringList.

    Parameters

    • Rest ...params: any[]

    Returns StringList

    SharedStringList

  • Returns void

    Undocumented

  • Returns void

    Undocumented

  • Returns void

    Undocumented

  • Parameters

    • prevent: boolean

    Returns void

    Undocumented

  • Restore window

    Returns void

  • Parameters

    • val: any

    Returns Promise<any>

    Undocumented

  • Parameters

    • Rest ...params: any[]

    Returns void

    Undocumented

  • Parameters

    • clr: string

    Returns void

    Undocumented

  • Set bounds of the window

    Parameters

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

    Returns void

  • Sets window client size

    Parameters

    • Awidth: number
    • Aheight: number

    Returns void

  • Parameters

    • pos: string
    • align: string

    Returns void

    Undocumented

  • Parameters

    • data: any

    Returns void

    Undocumented

  • Parameters

    • par: any

    Returns void

    Undocumented

  • Sets window size

    Parameters

    • Awidth: number
    • Aheight: number

    Returns void

  • Parameters

    • variable: string
    • Value: any

    Returns void

    Undocumented

  • Parameters

    • hasBorder: boolean
    • isFlat: boolean

    Returns void

    Undocumented

  • Show window

    Returns void

  • Parameters

    • Rest ...params: any[]

    Returns void

    Undocumented

  • Show window as modal dialog

    Returns void

  • Returns void

    Undocumented

  • Parameters

    • Value: string

    Returns void

    Undocumented

Events

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: (() => void)

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

See App.listen

Type declaration

    • (): void
    • Returns void

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: (() => void)

Event is called when browser is closed

See App.listen

Type declaration

    • (): void
    • Returns void

event_embeddedWindowCreate: (() => void)

Event is called when embedded window is created

See App.listen

Type declaration

    • (): void
    • Returns void

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: (() => void)

Event is called when page is loaded into memory

See App.listen

Type declaration

    • (): void
    • Returns void

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: (() => void)

Event is called when window is moved to new location

See App.listen

Type declaration

    • (): void
    • Returns void

event_ready: (() => void)

Event is called when DCOM is finished

See App.listen

Type declaration

    • (): void
    • Returns void

event_scriptsLoaded: (() => void)

Event is called when all scripts are loaded

See App.listen

Type declaration

    • (): void
    • Returns void

event_show: (() => void)

Event is called when window is shown

See App.listen

Type declaration

    • (): void
    • Returns void

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