AboutSupportDeveloper GuideVersion 41.134.100.117

Interface ChildWindowCreatedEvent

Generated when a child Window is created.

interface ChildWindowCreatedEvent {
    childOptions: WindowOptions;
    disposition:
        | "other"
        | "default"
        | "foreground-tab"
        | "background-tab"
        | "new-window"
        | "popup";
    features: string;
    frameName: string;
    name: string;
    parsedFeatures: Partial<WindowOptions>;
    rule: ContentCreationRule<ContentCreationBehavior>;
    topic: string;
    type: "child-window-created";
    url: string;
    uuid: string;
}

Properties

childOptions disposition features frameName name parsedFeatures rule topic type url uuid

Properties

childOptions

childOptions: WindowOptions

The options the child Window was created with.

disposition

disposition:
    | "other"
    | "default"
    | "foreground-tab"
    | "background-tab"
    | "new-window"
    | "popup"

The reported disposition of the content creation request.

Remarks

  • default - The default behavior of the browser.
  • foreground-tab - The content is loaded in a new tab in the foreground. This is the default behavior for window.open() or a link with target=_blank.
  • background-tab - The content is loaded in a new tab in the background. This is the default behavior when clicking on a link with the ctrl or cmd key pressed.
  • new-window - The content is loaded in a new window. This is the default behavior when clicking on a link with the shift key pressed.
  • popup - The content is loaded in a popup window. This is the result of passing popup features to window.open().
  • other - The content is loaded in some other way.

features

features: string

The features string passed to window.open()

frameName

frameName: string

The frame name passed to window.open()

name

name: string

parsedFeatures

parsedFeatures: Partial<WindowOptions>

The features string passed to window.open() converted to OpenFin window options

rule

rule: ContentCreationRule<ContentCreationBehavior>

The rule which triggered this event. May be undefined on child-window-created where no rule corresponds to the child Window creation.

Note: It is only defined if the rules engine found a match for a user-supplied rule, not in the case of an api call or the default behavior.

topic

topic: string

The "kebab-case" classname of the emitter that raised the event.

Remarks

OpenFin.Frame is represented as iframe.

type

type: "child-window-created"

The type of event that was raised. Equal to the typename of the event payload in "kebab case".

Remarks

Guaranteed to be unique within each topic, but can be repeated between topics (e.g. WebContentsEvents.CrashedEvent and ApplicationEvents.CrashedEvent).

url

url: string

The absolute url which triggered this event.

uuid

uuid: string

Settings

On This Page

Properties
""