Class SharedWindow

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

SharedWindow

Hierarchy (view full)

BaseSharedWindow
- SharedWindow
  - Window

Indexable

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

Index

Constructors

constructor

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

Constructors

constructor

new SharedWindow(): SharedWindow
Returns SharedWindow
Inherited from BaseSharedWindow.constructor

Properties

_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)

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

clientWidth

clientWidth: number

Gets/Sets window's client width

devToolsUrl

devToolsUrl: string

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'.

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

headerClass

headerClass: any

Undocumented

inData

inData: string

Undocumented

inspectElementSupported

inspectElementSupported: boolean

Undocumented

isMainWindow

isMainWindow: boolean

Undocumented

isMenu

isMenu: boolean

Undocumented

isModal

isModal: boolean

Undocumented

magnetToScreen

magnetToScreen: boolean

Undocumented

magnetToWindows

magnetToWindows: boolean

Undocumented

maximized

maximized: boolean

Gets maximized state of the window

menuJSON

menuJSON: string

Undocumented

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)

moveable

moveable: boolean

Gets/Sets whether window can be moved

opacity

opacity: number

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

outData

outData: string

Undocumented

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

shape

shape: string

Undocumented

shapeColor

shapeColor: number

Undocumented

showAsVideoPlayer

showAsVideoPlayer: boolean

Undocumented

statusInfo

statusInfo: Promise<any>

Undocumented

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

url

url: string

Get's URL of the window.

visible

visible: boolean

Get window visibility

windowIsLoaded

windowIsLoaded: boolean

Undocumented

Methods

_

_(...params): any
Translates string to current language
Parameters
- Rest ...params: any[]
Returns any
string
- Defined in src/types/Native.ts:2433

_alert

_alert(...params): void
Parameters
- Rest ...params: any[]
Returns void
Undocumented
- Defined in src/types/Native.ts:2479

activate

activate(): void
Makes window active.

Returns void
- Defined in src/types/Native.ts:2187

applyWindowStates

applyWindowStates(...params): void
Parameters
- Rest ...params: any[]
Returns void
Undocumented
- Defined in src/types/Native.ts:2131

callDialogInit

callDialogInit(): void
Returns void
Undocumented
- Defined in src/types/Native.ts:2135

callODS

callODS(s): void
Send debug string to log
Parameters
- s: string
Returns void
- Defined in src/types/Native.ts:2439

closeWindow

closeWindow(): void
Close window

Returns void
- Defined in src/types/Native.ts:2405

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
- Defined in src/types/Native.ts:2361

customMenuItemClick

customMenuItemClick(itemID, customData): void
Parameters
- itemID: number
- customData: number
Returns void
Undocumented
- Defined in src/types/Native.ts:2136

executeCode

executeCode(...params): any
Executes the given JS code in the target HTML window.
Parameters
- Rest ...params: any[]
Returns any
variant
- Defined in src/types/Native.ts:2176

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
- Defined in src/types/Native.ts:2182

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
- Defined in src/types/Native.ts:2153

getClassName

getClassName(): string
Gets class name of the object.

Returns string
Inherited from BaseSharedWindow.getClassName
- Defined in src/types/Native.ts:198

getValue

getValue(variable): any
Parameters
- variable: string
Returns any
Undocumented
- Defined in src/types/Native.ts:2467

getValueInWindowContext

getValueInWindowContext(Value): any
Parameters
- Value: any
Returns any
Undocumented
- Defined in src/types/Native.ts:2465

getWindowMonitor

getWindowMonitor(): any
Returns any
Undocumented
- Defined in src/types/Native.ts:2144

handleEmbeddedWindow

handleEmbeddedWindow(...params): Promise<any>
Create/Update/Delete embedded window with custom content.
Parameters
- Rest ...params: any[]
Returns Promise<any>
- Defined in src/types/Native.ts:2446

hide

hide(): void
Hide window

Returns void
- Defined in src/types/Native.ts:2410

identifier

identifier(): number
Returns number
Undocumented
- Defined in src/types/Native.ts:2137

include

include(filename): void
Include script to current window
Parameters
- filename: string
  Name of script file
Returns void
- Defined in src/types/Native.ts:2426

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
Inherited from BaseSharedWindow.locked
- Defined in src/types/Native.ts:192

maximize

maximize(): void
Maximize window

Returns void
- Defined in src/types/Native.ts:2394

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);
});
```
- Defined in src/types/Native.ts:2500

minimize

minimize(): void
Minimize window

Returns void
- Defined in src/types/Native.ts:2389

newStringList

newStringList(...params): StringList
Create new SharedStringList.
Parameters
- Rest ...params: any[]
Returns StringList
SharedStringList
- Defined in src/types/Native.ts:2477

notifyLoaded

notifyLoaded(): void
Returns void
Undocumented
- Defined in src/types/Native.ts:2141

notifyOnClose

notifyOnClose(): void
Returns void
Undocumented
- Defined in src/types/Native.ts:2469

notifyOnReady

notifyOnReady(): void
Returns void
Undocumented
- Defined in src/types/Native.ts:2468

preventClose

preventClose(prevent): void
Parameters
- prevent: boolean
Returns void
Undocumented
- Defined in src/types/Native.ts:2478

restore

restore(): void
Restore window

Returns void
- Defined in src/types/Native.ts:2399

runCommand

runCommand(val): Promise<any>
Parameters
- val: any
Returns Promise<any>
Undocumented
- Defined in src/types/Native.ts:2464

runJSCode_callback

runJSCode_callback(...params): void
Parameters
- Rest ...params: any[]
Returns void
Undocumented
- Defined in src/types/Native.ts:2143

setBackgroundColor

setBackgroundColor(clr): void
Parameters
- clr: string
Returns void
Undocumented
- Defined in src/types/Native.ts:2142

setBounds

setBounds(Aleft, Atop, Awidth, Aheight): void
Set bounds of the window
Parameters
- Aleft: number
- Atop: number
- Awidth: number
- Aheight: number
Returns void
- Defined in src/types/Native.ts:2370

setClientSize

setClientSize(Awidth, Aheight): void
Sets window client size
Parameters
- Awidth: number
- Aheight: number
Returns void
- Defined in src/types/Native.ts:2384

setDock

setDock(pos, align): void
Parameters
- pos: string
- align: string
Returns void
Undocumented
- Defined in src/types/Native.ts:2134

setMoveableArea

setMoveableArea(data): void
Parameters
- data: any
Returns void
Undocumented
- Defined in src/types/Native.ts:2164

setMoveableColor

setMoveableColor(par): void
Parameters
- par: any
Returns void
Undocumented
- Defined in src/types/Native.ts:2140

setSize

setSize(Awidth, Aheight): void
Sets window size
Parameters
- Awidth: number
- Aheight: number
Returns void
- Defined in src/types/Native.ts:2377

setValue

setValue(variable, Value): void
Parameters
- variable: string
- Value: any
Returns void
Undocumented
- Defined in src/types/Native.ts:2466

setWindowState

setWindowState(hasBorder, isFlat): void
Parameters
- hasBorder: boolean
- isFlat: boolean
Returns void
Undocumented
- Defined in src/types/Native.ts:2462

show

show(): void
Show window

Returns void
- Defined in src/types/Native.ts:2415

showDevTools

showDevTools(...params): void
Parameters
- Rest ...params: any[]
Returns void
Undocumented
- Defined in src/types/Native.ts:2470

showModal

showModal(): void
Show window as modal dialog

Returns void
- Defined in src/types/Native.ts:2420

updateDevicePixelRatio

updateDevicePixelRatio(): void
Returns void
Undocumented
- Defined in src/types/Native.ts:2130

updateMenu

updateMenu(Value): void
Parameters
- Value: string
Returns void
Undocumented
- Defined in src/types/Native.ts:2353

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
  - token: CloseToken
  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

Class SharedWindow

Hierarchy (view full)

Indexable

Index

Constructors

Properties

Methods

Events

Constructors

constructor

Returns SharedWindow

Properties

_window

Undocumented

active

addHeader

Undocumented

atTop

atTopMost

borderSize

Undocumented

bordered

bounds

builtInMenu

canMaximize

canMinimize

canShow

Undocumented

clientHeight

clientWidth

devToolsUrl

Undocumented

dockAlign

dockPos

fadeTime

flat

forceClose

Undocumented

headerClass

Undocumented

inData

Undocumented

inspectElementSupported

Undocumented

isMainWindow

Undocumented

isMenu

Undocumented

isModal

Undocumented

magnetToScreen

Undocumented

magnetToWindows

Undocumented

maximized

menuJSON

Undocumented

minimized

modalResult

moveable

opacity

outData

Undocumented

popupMenuWindows

posSaveName

reloadInProgress

Undocumented

resizeable

shape

Undocumented

shapeColor

Undocumented

showAsVideoPlayer

Undocumented

statusInfo

Undocumented

systemDevicePixelRatio

Undocumented

textZoomRatio

Undocumented