flash.html

# HTMLWindowCreateOptions - AS3

Package | flash.html
Class | public class HTMLWindowCreateOptions
Inheritance | HTMLWindowCreateOptions Object

Runtime Versions: | AIR 1.0

This class defines the options that can be specified when JavaScript running in an HTMLLoader object tries to create a new HTML window by calling the `window.open()` method.

This class defines the properties and methods that correspond to options in the `features` parameter passed to the `window.open()` method in JavaScript.

For example, JavaScript in an HTML document (in an HTMLLoader object) can include the following call to `window.open()`, in which the `features` parameter (the third parameter) lists a number of options:

Copy

    window.open("http://www.adobe.com", "AdobeWindow", "scrollbars=1,menubar=1,location=0,status=0")

You use the HTMLWindowCreateOptions class in overriding the `createWindow()` method of a subclass of the HTMLHost class. The HTMLLoader object passes an HTMLWindowCreateOptions object as the `windowCreateOptions` parameter of the `createWindow()` method of the HTMLHost object.

Related API Elements

HTMLHost#createWindow()

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | fullscreen : Boolean = false Specifies whether the window should be full screen. | HTMLWindowCreateOptions
|  | height : Number = NaN Specifies the desired initial height of the new window. | HTMLWindowCreateOptions
|  | locationBarVisible : Boolean = false Whether a location bar should be displayed. | HTMLWindowCreateOptions
|  | menuBarVisible : Boolean = false Specifies whether a menu bar should be displayed. | HTMLWindowCreateOptions
|  | resizable : Boolean = false Specifies whether the window should be resizable. | HTMLWindowCreateOptions
|  | scrollBarsVisible : Boolean = true Specifies whether scrollbars should be displayed. | HTMLWindowCreateOptions
|  | statusBarVisible : Boolean = false Specifies whether a status bar should be displayed. | HTMLWindowCreateOptions
|  | toolBarVisible : Boolean = false Specifies whether a toolbar bar should be displayed. | HTMLWindowCreateOptions
|  | width : Number = NaN Specifies the desired initial width of the new window. | HTMLWindowCreateOptions
|  | x : Number = NaN Specifies the desired initial x position of the new window on the screen. | HTMLWindowCreateOptions
|  | y : Number = NaN Specifies the desired initial y position of the new window on the screen. | HTMLWindowCreateOptions

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns the string representation of the specified object. | Object
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Property Detail

### fullscreen

property

`public var fullscreen:Boolean = false`

Runtime Versions: | AIR 1.0

Specifies whether the window should be full screen. This property is set to `true` if the `features` string of the JavaScript call to the `window.open()` method includes `"fullscreen"`, `"fullscreen=1"`, or `"fullscreen=y"`.

### height

property

`public var height:Number = NaN`

Runtime Versions: | AIR 1.0

Specifies the desired initial height of the new window. This is set to the `height` value in the `features` string of the JavaScript call to the `window.open()` method. If the value is `NaN`, the default when no `height` value is specified in the `features` string, then a default window height is used.

### locationBarVisible

property

`public var locationBarVisible:Boolean = false`

Runtime Versions: | AIR 1.0

Whether a location bar should be displayed. This property is set to `true` if the `features` string of the JavaScript call to the `window.open()` method includes `"location"`, `"location=1"`, or `"location=y"`.

### menuBarVisible

property

`public var menuBarVisible:Boolean = false`

Runtime Versions: | AIR 1.0

Specifies whether a menu bar should be displayed. This property is set to `true` if the `features` string of the JavaScript call to the `window.open()` method includes `"menubar"`, `"menubar=1"`, or `"menubar=y"`.

### resizable

property

`public var resizable:Boolean = false`

Runtime Versions: | AIR 1.0

Specifies whether the window should be resizable. This property is set to `true` if the `features` string of the JavaScript call to the `window.open()` method includes `"resizable"`, `"resizable=1"`, or `"resizable=y"`.

### scrollBarsVisible

property

`public var scrollBarsVisible:Boolean = true`

Runtime Versions: | AIR 1.0

Specifies whether scrollbars should be displayed. This property is set to `true` if the `features` string of JavaScript call to the `window.open()` method includes `"scrollbars"`, `"scrollbars=1"`, or `"scrollbars=y"`.

### statusBarVisible

property

`public var statusBarVisible:Boolean = false`

Runtime Versions: | AIR 1.0

Specifies whether a status bar should be displayed. This property is set to `true` if the `features` string of the JavaScript call to the `window.open()` method includes `"status"`, `"status=1"`, or `"status=y"`.

### toolBarVisible

property

`public var toolBarVisible:Boolean = false`

Runtime Versions: | AIR 1.0

Specifies whether a toolbar bar should be displayed. This property is set to `true` if the `features` string of the JavaScript call to the `window.open()` method includes `"toolbar"`, `"toolbar=1"`, or `"toolbar=y"`.

### width

property

`public var width:Number = NaN`

Runtime Versions: | AIR 1.0

Specifies the desired initial width of the new window. This is set to the `width` value in the `features` string of the JavaScript call to the `window.open()` method. If the value is `NaN`, the default when no `width` value is specified in the `features` string, then a default window width is used.

### x

property

`public var x:Number = NaN`

Runtime Versions: | AIR 1.0

Specifies the desired initial x position of the new window on the screen. This is set to the value specified for `left` or `screenX` in the `features` string of the JavaScript call to the `window.open()` method. If the value is `NaN`, the default when no `left` or `screenX` value is specified in the `features` string, then a default window x position is used.

### y

property

`public var y:Number = NaN`

Runtime Versions: | AIR 1.0

Specifies the desired initial y position of the new window on the screen. This is set to the value specified for `top` or `screenY` in the `features` string of the JavaScript call to the `window.open()` method. If the value is `NaN`, the default when no `left` or `screenX` value is specified in the `features` string, then a default window x position is used.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00