Class Window

Classdesc

A basic window that wraps a native HTML window. Provides more fine-grained control over the window state such as the ability to minimize, maximize, restore, etc. By default a window does not show upon instantiation; instead the window's show() method must be invoked manually. The new window appears in the same process as the parent window. It has the ability to listen for window specific events.

Alias

Window

Hideconstructor

Hierarchy

WebContents<OpenFin.WindowEvent>
- Window

Index

Constructors

constructor

Properties

addListener entityType identity wire

Accessors

Methods

animate authenticate blur bringToFront capturePage center close closePopupMenu createWindow disableFrame disableUserMovement dispatchPopupResult emit enableFrame enableUserMovement eventNames executeJavaScript findInPage flash focus focusedWebViewWasChanged getAllFrames getBounds getCurrentViews getInfo getLayout getNativeId getOptions getParentApplication getParentWindow getPrinters getProcessInfo getSharedWorkers getSnapshot getState getWebWindow getZoomLevel hide inspectServiceWorker inspectSharedWorker inspectSharedWorkerById isMainWindow isShowing listenerCount listeners maximize minimize moveBy moveTo navigate navigateBack navigateForward on once prependListener prependOnceListener print reload removeAllListeners removeListener resizeBy resizeTo restore setAsForeground setBounds setZoomLevel show showAt showDeveloperTools showPopupMenu showPopupWindow stopFindInPage stopFlashing stopNavigation updateOptions

Constructors

constructor

new Window(wire: Transport<EntityType>, identity: Identity): Window
Parameters
- wire: Transport<EntityType>
- identity: Identity
Returns Window

Overrides WebContents<OpenFin.WindowEvent>.constructor

Properties

addListener

addListener: (<EventType>(eventType: EventType, listener: EventHandler<OpenFin.WindowEvents.WindowEvent, EventType>, options?: SubscriptionOptions) => Promise<Window>) = ...

Type declaration

- <EventType>(eventType: EventType, listener: EventHandler<OpenFin.WindowEvents.WindowEvent, EventType>, options?: SubscriptionOptions): Promise<Window>
- Type Parameters
  - EventType extends "blurred" | "certificate-selection-shown" | "crashed" | "did-change-theme-color" | "focused" | "navigation-rejected" | "url-changed" | "did-fail-load" | "did-finish-load" | "page-favicon-updated" | "page-title-updated" | "resource-load-failed" | "response-received" | "child-content-blocked" | "child-content-opened-in-browser" | "child-view-created" | "file-download-started" | "file-download-progress" | "file-download-completed" | "hidden" | "hotkey" | "shown" | "view-detached" | "auth-requested" | "begin-user-bounds-changing" | "bounds-changed" | "bounds-changing" | "close-requested" | "closed" | "closing" | "disabled-movement-bounds-changed" | "disabled-movement-bounds-changing" | "embedded" | "end-user-bounds-changing" | "external-process-exited" | "external-process-started" | "initialized" | "layout-initialized" | "layout-ready" | "maximized" | "minimized" | "options-changed" | "performance-report" | "preload-script-state-changed" | "preload-script-state-changing" | "reloaded" | "restored" | "show-requested" | "user-movement-disabled" | "user-movement-enabled" | "will-move" | "will-redirect" | "will-resize" | "view-attached" | "view-blurred" | "view-certificate-selection-shown" | "view-crashed" | "view-did-change-theme-color" | "view-focused" | "view-navigation-rejected" | "view-url-changed" | "view-did-fail-load" | "view-did-finish-load" | "view-page-favicon-updated" | "view-page-title-updated" | "view-resource-load-failed" | "view-response-received" | "view-child-content-blocked" | "view-child-content-opened-in-browser" | "view-child-view-created" | "view-file-download-started" | "view-file-download-progress" | "view-file-download-completed" | "view-created" | "view-destroyed" | "view-hidden" | "view-hotkey" | "view-shown" | "view-target-changed" | "found-in-page" | "certificate-error"
  Parameters
  - eventType: EventType
  - listener: EventHandler<OpenFin.WindowEvents.WindowEvent, EventType>
  - Optional options: SubscriptionOptions
  Returns Promise<Window>

entityType

entityType: string

identity

identity: Identity

wire

wire: Transport<EntityType>

Accessors

me

get me(): Identity
Returns Identity

Inherited from WebContents.me

Methods

animate

animate(transitions: Transition, options: TransitionOptions): Promise<void>
Performs the specified window transitions.

Returns

Tutorial
Window.animate
Parameters
- transitions: Transition
  
  Describes the animations to perform. See the tutorial.
- options: TransitionOptions
  
  Options for the animation. See the tutorial.
Returns Promise<void>

authenticate

authenticate(userName: string, password: string): Promise<void>
Provides credentials to authentication requests

Returns

Tutorial
Window.authenticate
Parameters
- userName: string
  
  userName to provide to the authentication challenge
- password: string
  
  password to provide to the authentication challenge
Returns Promise<void>

blur

blur(): Promise<void>
Removes focus from the window.

Returns

Tutorial
Window.blur

Returns Promise<void>

bringToFront

bringToFront(): Promise<void>
Brings the window to the front of the window stack.

Returns

Tutorial
Window.bringToFront

Returns Promise<void>

capturePage

capturePage(options?: CapturePageOptions): Promise<string>
Parameters
- Optional options: CapturePageOptions
Returns Promise<string>

Inherited from WebContents.capturePage

center

center(): Promise<void>
Centers the window on its current screen.

Returns

Tutorial
Window.center

Returns Promise<void>

close

close(force??: boolean): Promise<void>
closes the window application

Returns

Tutorial
Window.close
Parameters
- Optional force: boolean = false
Returns Promise<void>

closePopupMenu

closePopupMenu(): Promise<void>
Experimental
Closes the window's popup menu, if one exists.

Returns

Tutorial
Window.closePopupMenu

Returns Promise<void>

createWindow

createWindow(options: WindowCreationOptions): Promise<Window>
Opens the developer tools for the service worker context.

Function
inspectServiceWorker

Member Of
Window

Instance

Returns

Tutorial
Window.inspectServiceWorker
Parameters
- options: WindowCreationOptions
Returns Promise<Window>

disableFrame

disableFrame(): Promise<void>
Returns Promise<void>

disableUserMovement

disableUserMovement(): Promise<void>
Prevents a user from changing a window's size/position when using the window's frame.

Returns

Tutorial
Window.disableUserMovement

Returns Promise<void>

dispatchPopupResult

dispatchPopupResult(data: any): Promise<void>
Dispatch a result to the caller of showPopupWindow. If this window isn't currently being shown as a popup, this call will silently fail.

Returns

Tutorial
Window.dispatchPopupResult
Parameters
- data: any
  
  Serializable data to send to the caller window.
Returns Promise<void>

emit

emit<EventType>(eventType: EventType, payload: Extract<EmitterEvent, {
type: EventType;
}>, ...args: any[]): boolean
Type Parameters
- EventType extends string
Parameters
- eventType: EventType
- payload: Extract<EmitterEvent, {
  type: EventType;
  }>
- Rest ...args: any[]
Returns boolean

Inherited from WebContents.emit

enableFrame

enableFrame(): Promise<void>
Returns Promise<void>

enableUserMovement

enableUserMovement(): Promise<void>
Re-enables user changes to a window's size/position when using the window's frame.

Returns

Tutorial
Window.enableUserMovement

Returns Promise<void>

eventNames

eventNames(): (string | symbol)[]
Returns (string | symbol)[]

Inherited from WebContents.eventNames

executeJavaScript

executeJavaScript(code: string): Promise<void>
Parameters
- code: string
Returns Promise<void>

Inherited from WebContents.executeJavaScript

findInPage

findInPage(searchTerm: string, options?: FindInPageOptions): Promise<void>
Parameters
- searchTerm: string
- Optional options: FindInPageOptions
Returns Promise<void>

Inherited from WebContents.findInPage

flash

flash(): Promise<void>
Flashes the window’s frame and taskbar icon until stopFlashing is called or until a focus event is fired.

Returns

Tutorial
Window.flash

Returns Promise<void>

focus

focus(__namedParameters?: {
emitSynthFocused: boolean;
}): Promise<void>
Parameters
- __namedParameters: {
  emitSynthFocused: boolean;
  } = ...
  - emitSynthFocused: boolean
Returns Promise<void>

Inherited from WebContents.focus

focusedWebViewWasChanged

focusedWebViewWasChanged(): Promise<void>
Returns Promise<void>

getAllFrames

getAllFrames(): Promise<FrameInfo[]>
Retrieves an array of frame info objects representing the main frame and any iframes that are currently on the page.

Returns

Tutorial
Window.getAllFrames

Returns Promise<FrameInfo[]>

getBounds

getBounds(): Promise<WindowBounds>
Gets the current bounds (top, bottom, right, left, width, height) of the window.

Returns

Tutorial
Window.getBounds

Returns Promise<WindowBounds>

getCurrentViews

getCurrentViews(): Promise<OpenFin.View[]>
Experimental
Retrieves window's attached views.

Returns

Tutorial
Window.getCurrentViews

Returns Promise<OpenFin.View[]>

getInfo

getInfo(): Promise<WindowInfo>
Gets an information object for the window.

Returns

Tutorial
Window.getInfo

Returns Promise<WindowInfo>

getLayout

getLayout(): Promise<OpenFin.Layout>
Experimental
Retrieves the window's Layout

Returns

Tutorial
Window.getLayout

Returns Promise<OpenFin.Layout>

getNativeId

getNativeId(): Promise<string>
Returns the native OS level Id. In Windows, it will return the Windows handle.

Returns

Tutorial
Window.getNativeId

Returns Promise<string>

getOptions

getOptions(): Promise<WindowOptions>
Gets the current settings of the window.

Returns

Tutorial
Window.getOptions

Returns Promise<WindowOptions>

getParentApplication

getParentApplication(): Promise<OpenFin.Application>
Gets the parent application.

Returns

Tutorial
Window.getParentApplication

Returns Promise<OpenFin.Application>

getParentWindow

getParentWindow(): Promise<Window>
Gets the parent window.

Returns

Tutorial
Window.getParentWindow

Returns Promise<Window>

getPrinters

getPrinters(): Promise<PrinterInfo>
Returns Promise<PrinterInfo>

Inherited from WebContents.getPrinters

getProcessInfo

getProcessInfo(): Promise<EntityProcessDetails>
Returns Promise<EntityProcessDetails>

Inherited from WebContents.getProcessInfo

getSharedWorkers

getSharedWorkers(): Promise<SharedWorkerInfo[]>
Returns Promise<SharedWorkerInfo[]>

Inherited from WebContents.getSharedWorkers

getSnapshot

getSnapshot(area?: Rectangle): Promise<string>
DEPRECATED - please use Window.capturePage. Gets a base64 encoded PNG image of the window or just part a of it.

Returns

Tutorial
Window.capturePage
Parameters
- Optional area: Rectangle
  
  The area of the window to be captured. Omitting it will capture the whole visible window.
Returns Promise<string>

getState

getState(): Promise<"maximized" | "minimized" | "normal">
Gets the current state ("minimized", "maximized", or "normal") of the window.

Returns

Tutorial
Window.getState

Returns Promise<"maximized" | "minimized" | "normal">

getWebWindow

getWebWindow(): Window
Previously called getNativeWindow. Returns the Window Object that represents the web context of the target window. This is the same object that you would get from calling window.open() in a standard web context. The target window needs to be in the same application as the requesting window as well as comply with same-origin policy requirements.

Returns

Tutorial
Window.getWebWindow

Returns Window

getZoomLevel

getZoomLevel(): Promise<number>
Returns Promise<number>

Inherited from WebContents.getZoomLevel

hide

hide(): Promise<void>
Hides the window.

Returns

Tutorial
Window.hide

Returns Promise<void>

inspectServiceWorker

inspectServiceWorker(): Promise<void>
Returns Promise<void>

Inherited from WebContents.inspectServiceWorker

inspectSharedWorker

inspectSharedWorker(): Promise<void>
Returns Promise<void>

Inherited from WebContents.inspectSharedWorker

inspectSharedWorkerById

inspectSharedWorkerById(workerId: string): Promise<void>
Parameters
- workerId: string
Returns Promise<void>

Inherited from WebContents.inspectSharedWorkerById

isMainWindow

isMainWindow(): boolean
Determines if the window is a main window.

Returns

Tutorial
Window.isMainWindow

Returns boolean

isShowing

isShowing(): Promise<boolean>
Determines if the window is currently showing.

Returns

Tutorial
Window.isShowing

Returns Promise<boolean>

listenerCount

listenerCount(type: string | symbol): number
Parameters
- type: string | symbol
Returns number

Inherited from WebContents.listenerCount

listeners

listeners(type: string | symbol): Function[]
Parameters
- type: string | symbol
Returns Function[]

Inherited from WebContents.listeners

maximize

maximize(): Promise<void>
Maximizes the window

Returns

Tutorial
Window.maximize

Returns Promise<void>

minimize

minimize(): Promise<void>
Minimizes the window.

Returns

Tutorial
Window.minimize

Returns Promise<void>

moveBy

moveBy(deltaLeft: number, deltaTop: number, positioningOptions?: PositioningOptions): Promise<void>
Moves the window by a specified amount.

Returns

Tutorial
Window.moveBy
Parameters
- deltaLeft: number
  
  The change in the left position of the window
- deltaTop: number
  
  The change in the top position of the window
- Optional positioningOptions: PositioningOptions
Returns Promise<void>

moveTo

moveTo(left: number, top: number, positioningOptions?: PositioningOptions): Promise<void>
Moves the window to a specified location.

Returns

Tutorial
Window.moveTo
Parameters
- left: number
  
  The left position of the window
- top: number
  
  The top position of the window
- Optional positioningOptions: PositioningOptions
Returns Promise<void>

navigate

navigate(url: string): Promise<void>
Parameters
- url: string
Returns Promise<void>

Inherited from WebContents.navigate

navigateBack

navigateBack(): Promise<void>
Returns Promise<void>

Inherited from WebContents.navigateBack

navigateForward

navigateForward(): Promise<void>
Returns Promise<void>

Inherited from WebContents.navigateForward

on

on<EventType>(eventType: EventType, listener: EventHandler<OpenFin.WindowEvents.WindowEvent, EventType>, options?: SubscriptionOptions): Promise<Window>
Type Parameters
- EventType extends "blurred" | "certificate-selection-shown" | "crashed" | "did-change-theme-color" | "focused" | "navigation-rejected" | "url-changed" | "did-fail-load" | "did-finish-load" | "page-favicon-updated" | "page-title-updated" | "resource-load-failed" | "response-received" | "child-content-blocked" | "child-content-opened-in-browser" | "child-view-created" | "file-download-started" | "file-download-progress" | "file-download-completed" | "hidden" | "hotkey" | "shown" | "view-detached" | "auth-requested" | "begin-user-bounds-changing" | "bounds-changed" | "bounds-changing" | "close-requested" | "closed" | "closing" | "disabled-movement-bounds-changed" | "disabled-movement-bounds-changing" | "embedded" | "end-user-bounds-changing" | "external-process-exited" | "external-process-started" | "initialized" | "layout-initialized" | "layout-ready" | "maximized" | "minimized" | "options-changed" | "performance-report" | "preload-script-state-changed" | "preload-script-state-changing" | "reloaded" | "restored" | "show-requested" | "user-movement-disabled" | "user-movement-enabled" | "will-move" | "will-redirect" | "will-resize" | "view-attached" | "view-blurred" | "view-certificate-selection-shown" | "view-crashed" | "view-did-change-theme-color" | "view-focused" | "view-navigation-rejected" | "view-url-changed" | "view-did-fail-load" | "view-did-finish-load" | "view-page-favicon-updated" | "view-page-title-updated" | "view-resource-load-failed" | "view-response-received" | "view-child-content-blocked" | "view-child-content-opened-in-browser" | "view-child-view-created" | "view-file-download-started" | "view-file-download-progress" | "view-file-download-completed" | "view-created" | "view-destroyed" | "view-hidden" | "view-hotkey" | "view-shown" | "view-target-changed" | "found-in-page" | "certificate-error"
Parameters
- eventType: EventType
- listener: EventHandler<OpenFin.WindowEvents.WindowEvent, EventType>
- Optional options: SubscriptionOptions
Returns Promise<Window>

Inherited from WebContents.on

once

once<EventType>(eventType: EventType, listener: EventHandler<OpenFin.WindowEvents.WindowEvent, EventType>, options?: SubscriptionOptions): Promise<Window>
Type Parameters
- EventType extends "blurred" | "certificate-selection-shown" | "crashed" | "did-change-theme-color" | "focused" | "navigation-rejected" | "url-changed" | "did-fail-load" | "did-finish-load" | "page-favicon-updated" | "page-title-updated" | "resource-load-failed" | "response-received" | "child-content-blocked" | "child-content-opened-in-browser" | "child-view-created" | "file-download-started" | "file-download-progress" | "file-download-completed" | "hidden" | "hotkey" | "shown" | "view-detached" | "auth-requested" | "begin-user-bounds-changing" | "bounds-changed" | "bounds-changing" | "close-requested" | "closed" | "closing" | "disabled-movement-bounds-changed" | "disabled-movement-bounds-changing" | "embedded" | "end-user-bounds-changing" | "external-process-exited" | "external-process-started" | "initialized" | "layout-initialized" | "layout-ready" | "maximized" | "minimized" | "options-changed" | "performance-report" | "preload-script-state-changed" | "preload-script-state-changing" | "reloaded" | "restored" | "show-requested" | "user-movement-disabled" | "user-movement-enabled" | "will-move" | "will-redirect" | "will-resize" | "view-attached" | "view-blurred" | "view-certificate-selection-shown" | "view-crashed" | "view-did-change-theme-color" | "view-focused" | "view-navigation-rejected" | "view-url-changed" | "view-did-fail-load" | "view-did-finish-load" | "view-page-favicon-updated" | "view-page-title-updated" | "view-resource-load-failed" | "view-response-received" | "view-child-content-blocked" | "view-child-content-opened-in-browser" | "view-child-view-created" | "view-file-download-started" | "view-file-download-progress" | "view-file-download-completed" | "view-created" | "view-destroyed" | "view-hidden" | "view-hotkey" | "view-shown" | "view-target-changed" | "found-in-page" | "certificate-error"
Parameters
- eventType: EventType
- listener: EventHandler<OpenFin.WindowEvents.WindowEvent, EventType>
- Optional options: SubscriptionOptions
Returns Promise<Window>

Inherited from WebContents.once

prependListener

prependListener<EventType>(eventType: EventType, listener: EventHandler<OpenFin.WindowEvents.WindowEvent, EventType>, options?: SubscriptionOptions): Promise<Window>
Type Parameters
- EventType extends "blurred" | "certificate-selection-shown" | "crashed" | "did-change-theme-color" | "focused" | "navigation-rejected" | "url-changed" | "did-fail-load" | "did-finish-load" | "page-favicon-updated" | "page-title-updated" | "resource-load-failed" | "response-received" | "child-content-blocked" | "child-content-opened-in-browser" | "child-view-created" | "file-download-started" | "file-download-progress" | "file-download-completed" | "hidden" | "hotkey" | "shown" | "view-detached" | "auth-requested" | "begin-user-bounds-changing" | "bounds-changed" | "bounds-changing" | "close-requested" | "closed" | "closing" | "disabled-movement-bounds-changed" | "disabled-movement-bounds-changing" | "embedded" | "end-user-bounds-changing" | "external-process-exited" | "external-process-started" | "initialized" | "layout-initialized" | "layout-ready" | "maximized" | "minimized" | "options-changed" | "performance-report" | "preload-script-state-changed" | "preload-script-state-changing" | "reloaded" | "restored" | "show-requested" | "user-movement-disabled" | "user-movement-enabled" | "will-move" | "will-redirect" | "will-resize" | "view-attached" | "view-blurred" | "view-certificate-selection-shown" | "view-crashed" | "view-did-change-theme-color" | "view-focused" | "view-navigation-rejected" | "view-url-changed" | "view-did-fail-load" | "view-did-finish-load" | "view-page-favicon-updated" | "view-page-title-updated" | "view-resource-load-failed" | "view-response-received" | "view-child-content-blocked" | "view-child-content-opened-in-browser" | "view-child-view-created" | "view-file-download-started" | "view-file-download-progress" | "view-file-download-completed" | "view-created" | "view-destroyed" | "view-hidden" | "view-hotkey" | "view-shown" | "view-target-changed" | "found-in-page" | "certificate-error"
Parameters
- eventType: EventType
- listener: EventHandler<OpenFin.WindowEvents.WindowEvent, EventType>
- Optional options: SubscriptionOptions
Returns Promise<Window>

Inherited from WebContents.prependListener

prependOnceListener

prependOnceListener<EventType>(eventType: EventType, listener: EventHandler<OpenFin.WindowEvents.WindowEvent, EventType>, options?: SubscriptionOptions): Promise<Window>
Type Parameters
- EventType extends "blurred" | "certificate-selection-shown" | "crashed" | "did-change-theme-color" | "focused" | "navigation-rejected" | "url-changed" | "did-fail-load" | "did-finish-load" | "page-favicon-updated" | "page-title-updated" | "resource-load-failed" | "response-received" | "child-content-blocked" | "child-content-opened-in-browser" | "child-view-created" | "file-download-started" | "file-download-progress" | "file-download-completed" | "hidden" | "hotkey" | "shown" | "view-detached" | "auth-requested" | "begin-user-bounds-changing" | "bounds-changed" | "bounds-changing" | "close-requested" | "closed" | "closing" | "disabled-movement-bounds-changed" | "disabled-movement-bounds-changing" | "embedded" | "end-user-bounds-changing" | "external-process-exited" | "external-process-started" | "initialized" | "layout-initialized" | "layout-ready" | "maximized" | "minimized" | "options-changed" | "performance-report" | "preload-script-state-changed" | "preload-script-state-changing" | "reloaded" | "restored" | "show-requested" | "user-movement-disabled" | "user-movement-enabled" | "will-move" | "will-redirect" | "will-resize" | "view-attached" | "view-blurred" | "view-certificate-selection-shown" | "view-crashed" | "view-did-change-theme-color" | "view-focused" | "view-navigation-rejected" | "view-url-changed" | "view-did-fail-load" | "view-did-finish-load" | "view-page-favicon-updated" | "view-page-title-updated" | "view-resource-load-failed" | "view-response-received" | "view-child-content-blocked" | "view-child-content-opened-in-browser" | "view-child-view-created" | "view-file-download-started" | "view-file-download-progress" | "view-file-download-completed" | "view-created" | "view-destroyed" | "view-hidden" | "view-hotkey" | "view-shown" | "view-target-changed" | "found-in-page" | "certificate-error"
Parameters
- eventType: EventType
- listener: EventHandler<OpenFin.WindowEvents.WindowEvent, EventType>
- Optional options: SubscriptionOptions
Returns Promise<Window>

Inherited from WebContents.prependOnceListener

print

print(options?: WindowPrintOptions): Promise<void>
Prints the contents of the window.

Tutorial
Window.print
Parameters
- options: WindowPrintOptions = ...
  
  Configuration for the print task.
Returns Promise<void>

Overrides WebContents.print

reload

reload(ignoreCache?: boolean): Promise<void>
Parameters
- ignoreCache: boolean = false
Returns Promise<void>

Inherited from WebContents.reload

removeAllListeners

removeAllListeners(eventType?: "blurred" | "certificate-selection-shown" | "crashed" | "did-change-theme-color" | "focused" | "navigation-rejected" | "url-changed" | "did-fail-load" | "did-finish-load" | "page-favicon-updated" | "page-title-updated" | "resource-load-failed" | "response-received" | "child-content-blocked" | "child-content-opened-in-browser" | "child-view-created" | "file-download-started" | "file-download-progress" | "file-download-completed" | "hidden" | "hotkey" | "shown" | "view-detached" | "auth-requested" | "begin-user-bounds-changing" | "bounds-changed" | "bounds-changing" | "close-requested" | "closed" | "closing" | "disabled-movement-bounds-changed" | "disabled-movement-bounds-changing" | "embedded" | "end-user-bounds-changing" | "external-process-exited" | "external-process-started" | "initialized" | "layout-initialized" | "layout-ready" | "maximized" | "minimized" | "options-changed" | "performance-report" | "preload-script-state-changed" | "preload-script-state-changing" | "reloaded" | "restored" | "show-requested" | "user-movement-disabled" | "user-movement-enabled" | "will-move" | "will-redirect" | "will-resize" | "view-attached" | "view-blurred" | "view-certificate-selection-shown" | "view-crashed" | "view-did-change-theme-color" | "view-focused" | "view-navigation-rejected" | "view-url-changed" | "view-did-fail-load" | "view-did-finish-load" | "view-page-favicon-updated" | "view-page-title-updated" | "view-resource-load-failed" | "view-response-received" | "view-child-content-blocked" | "view-child-content-opened-in-browser" | "view-child-view-created" | "view-file-download-started" | "view-file-download-progress" | "view-file-download-completed" | "view-created" | "view-destroyed" | "view-hidden" | "view-hotkey" | "view-shown" | "view-target-changed" | "found-in-page" | "certificate-error"): Promise<Window>
Parameters
- Optional eventType: "blurred" | "certificate-selection-shown" | "crashed" | "did-change-theme-color" | "focused" | "navigation-rejected" | "url-changed" | "did-fail-load" | "did-finish-load" | "page-favicon-updated" | "page-title-updated" | "resource-load-failed" | "response-received" | "child-content-blocked" | "child-content-opened-in-browser" | "child-view-created" | "file-download-started" | "file-download-progress" | "file-download-completed" | "hidden" | "hotkey" | "shown" | "view-detached" | "auth-requested" | "begin-user-bounds-changing" | "bounds-changed" | "bounds-changing" | "close-requested" | "closed" | "closing" | "disabled-movement-bounds-changed" | "disabled-movement-bounds-changing" | "embedded" | "end-user-bounds-changing" | "external-process-exited" | "external-process-started" | "initialized" | "layout-initialized" | "layout-ready" | "maximized" | "minimized" | "options-changed" | "performance-report" | "preload-script-state-changed" | "preload-script-state-changing" | "reloaded" | "restored" | "show-requested" | "user-movement-disabled" | "user-movement-enabled" | "will-move" | "will-redirect" | "will-resize" | "view-attached" | "view-blurred" | "view-certificate-selection-shown" | "view-crashed" | "view-did-change-theme-color" | "view-focused" | "view-navigation-rejected" | "view-url-changed" | "view-did-fail-load" | "view-did-finish-load" | "view-page-favicon-updated" | "view-page-title-updated" | "view-resource-load-failed" | "view-response-received" | "view-child-content-blocked" | "view-child-content-opened-in-browser" | "view-child-view-created" | "view-file-download-started" | "view-file-download-progress" | "view-file-download-completed" | "view-created" | "view-destroyed" | "view-hidden" | "view-hotkey" | "view-shown" | "view-target-changed" | "found-in-page" | "certificate-error"
Returns Promise<Window>

Inherited from WebContents.removeAllListeners

removeListener

removeListener<EventType>(eventType: EventType, listener: EventHandler<OpenFin.WindowEvents.WindowEvent, EventType>, options?: SubscriptionOptions): Promise<Window>
Type Parameters
- EventType extends "blurred" | "certificate-selection-shown" | "crashed" | "did-change-theme-color" | "focused" | "navigation-rejected" | "url-changed" | "did-fail-load" | "did-finish-load" | "page-favicon-updated" | "page-title-updated" | "resource-load-failed" | "response-received" | "child-content-blocked" | "child-content-opened-in-browser" | "child-view-created" | "file-download-started" | "file-download-progress" | "file-download-completed" | "hidden" | "hotkey" | "shown" | "view-detached" | "auth-requested" | "begin-user-bounds-changing" | "bounds-changed" | "bounds-changing" | "close-requested" | "closed" | "closing" | "disabled-movement-bounds-changed" | "disabled-movement-bounds-changing" | "embedded" | "end-user-bounds-changing" | "external-process-exited" | "external-process-started" | "initialized" | "layout-initialized" | "layout-ready" | "maximized" | "minimized" | "options-changed" | "performance-report" | "preload-script-state-changed" | "preload-script-state-changing" | "reloaded" | "restored" | "show-requested" | "user-movement-disabled" | "user-movement-enabled" | "will-move" | "will-redirect" | "will-resize" | "view-attached" | "view-blurred" | "view-certificate-selection-shown" | "view-crashed" | "view-did-change-theme-color" | "view-focused" | "view-navigation-rejected" | "view-url-changed" | "view-did-fail-load" | "view-did-finish-load" | "view-page-favicon-updated" | "view-page-title-updated" | "view-resource-load-failed" | "view-response-received" | "view-child-content-blocked" | "view-child-content-opened-in-browser" | "view-child-view-created" | "view-file-download-started" | "view-file-download-progress" | "view-file-download-completed" | "view-created" | "view-destroyed" | "view-hidden" | "view-hotkey" | "view-shown" | "view-target-changed" | "found-in-page" | "certificate-error"
Parameters
- eventType: EventType
- listener: EventHandler<OpenFin.WindowEvents.WindowEvent, EventType>
- Optional options: SubscriptionOptions
Returns Promise<Window>

Inherited from WebContents.removeListener

resizeBy

resizeBy(deltaWidth: number, deltaHeight: number, anchor: AnchorType, positioningOptions?: PositioningOptions): Promise<void>
Resizes the window by a specified amount.

Returns

Tutorial
Window.resizeBy
Parameters
- deltaWidth: number
  
  The change in the width of the window
- deltaHeight: number
  
  The change in the height of the window
- anchor: AnchorType
  
  Specifies a corner to remain fixed during the resize. Can take the values: "top-left", "top-right", "bottom-left", or "bottom-right". If undefined, the default is "top-left"
- Optional positioningOptions: PositioningOptions
Returns Promise<void>

resizeTo

resizeTo(width: number, height: number, anchor: AnchorType, positioningOptions?: PositioningOptions): Promise<void>
Resizes the window to the specified dimensions.

Returns

Tutorial
Window.resizeTo
Parameters
- width: number
  
  The change in the width of the window
- height: number
  
  The change in the height of the window
- anchor: AnchorType
  
  Specifies a corner to remain fixed during the resize. Can take the values: "top-left", "top-right", "bottom-left", or "bottom-right". If undefined, the default is "top-left"
- Optional positioningOptions: PositioningOptions
Returns Promise<void>

restore

restore(): Promise<void>
Restores the window to its normal state (i.e., unminimized, unmaximized).

Returns

Tutorial
Window.restore

Returns Promise<void>

setAsForeground

setAsForeground(): Promise<void>
Will bring the window to the front of the entire stack and give it focus.

Returns

Tutorial
Window.setAsForeground

Returns Promise<void>

setBounds

setBounds(bounds: Partial<Bounds>, positioningOptions?: PositioningOptions): Promise<void>
Sets the window's size and position.

Property
This is a *

Returns

Tutorial
Window.setBounds
Parameters
- bounds: Partial<Bounds>
- Optional positioningOptions: PositioningOptions
Returns Promise<void>

setZoomLevel

setZoomLevel(level: number): Promise<void>
Parameters
- level: number
Returns Promise<void>

Inherited from WebContents.setZoomLevel

show

show(force??: boolean): Promise<void>
Shows the window if it is hidden.

Returns

Tutorial
Window.show
Parameters
- Optional force: boolean = false
Returns Promise<void>

showAt

showAt(left: number, top: number, force?: boolean): Promise<void>
Shows the window if it is hidden at the specified location. If the toggle parameter is set to true, the window will alternate between showing and hiding.

Returns

Tutorial
Window.showAt
Parameters
- left: number
  
  The left position of the window
- top: number
  
  The right position of the window
- force: boolean = false
  
  Show will be prevented from closing when force is false and ‘show-requested’ has been subscribed to for application’s main window
Returns Promise<void>

showDeveloperTools

showDeveloperTools(): Promise<void>
Returns Promise<void>

Inherited from WebContents.showDeveloperTools

showPopupMenu

showPopupMenu(options: ShowPopupMenuOptions): Promise<MenuResult>
Experimental
Shows a menu on the window. Returns a promise that resolves when the user has either selected an item or closed the menu. (This may take longer than other apis). Resolves to an object with {result: 'clicked', data } where data is the data field on the menu item clicked, or {result 'closed'} when the user doesn't select anything. Calling this method will close previously opened menus.

Returns

Tutorial
Window.showPopupMenu
Parameters
- options: ShowPopupMenuOptions
Returns Promise<MenuResult>

showPopupWindow

showPopupWindow(options: PopupOptions): Promise<PopupResult<any>>
Parameters
- options: PopupOptions
Returns Promise<PopupResult<any>>

Inherited from WebContents.showPopupWindow

stopFindInPage

stopFindInPage(action: string): Promise<void>
Parameters
- action: string
Returns Promise<void>

Inherited from WebContents.stopFindInPage

stopFlashing

stopFlashing(): Promise<void>
Stops the taskbar icon from flashing.

Returns

Tutorial
Window.stopFlashing

Returns Promise<void>

stopNavigation

stopNavigation(): Promise<void>
Returns Promise<void>

Inherited from WebContents.stopNavigation

updateOptions

updateOptions(options: Partial<MutableWindowOptions>): Promise<void>
Updates the window using the passed options. Values that are objects are deep-merged, overwriting only the values that are provided.

Returns

Tutorial
Window.updateOptions
Parameters
- options: Partial<MutableWindowOptions>
  
  Changes a window's options that were defined upon creation. See tutorial
Returns Promise<void>

Class Window

Classdesc

Alias

Hideconstructor

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

wire: Transport<EntityType>

identity: Identity

Returns Window

Properties

addListener

Type declaration

Type Parameters

Parameters

eventType: EventType

listener: EventHandler<OpenFin.WindowEvents.WindowEvent, EventType>

Optional options: SubscriptionOptions

Returns Promise<Window>

entityType

identity

wire

Accessors

me

Returns Identity

Methods

animate

Returns

Tutorial

Parameters

transitions: Transition

options: TransitionOptions

Returns Promise<void>

authenticate

Returns

Tutorial

Parameters

userName: string

password: string

Returns Promise<void>

blur

Returns

Tutorial

Returns Promise<void>

bringToFront

Returns

Tutorial

Returns Promise<void>

capturePage

Parameters

Optional options: CapturePageOptions

Returns Promise<string>

center

Returns

Tutorial

Returns Promise<void>

close

Returns

Tutorial

Parameters

Optional force: boolean = false

Returns Promise<void>

closePopupMenu

Returns

Tutorial

Returns Promise<void>

createWindow

Function

Member Of

Instance

Returns

Tutorial

Parameters

options: WindowCreationOptions

`Optional` options: SubscriptionOptions

`Optional` options: CapturePageOptions

`Optional` force: boolean = false

payload: Extract<EmitterEvent, {
type: EventType;
}>

`Rest` ...args: any[]

`Optional` options: FindInPageOptions

__namedParameters: {
emitSynthFocused: boolean;
} = ...