open method

Opens a document for writing.

Note Can also be used to behave like the open method of the window object if the url, name, features, and replace parameters are specified using the following syntax:

var retval = document.open(url, name, features, replace);

Refer to the window.open reference for usage.

Document Object Model (DOM) Level 2 HTML Specification, Section 1.5

HTML5 A vocabulary and associated APIs for HTML and XHTML, Section 3.4.1

Syntax

var retval = document.open(url, name, features, replace);

Parameters

url [in, optional]

C++	String that specifies the a MIME type for the document. Note If this method is used instead of window.open, this parameter specifies the URL of the document to display. If no URL is specified, a new window with about:blank is displayed.
JavaScript	Specifies a MIME type for the document.

text/html: Default. Currently the only MIME type supported for this method.

name [in, optional]

Type: String

Note The following applies only if this method is used instead of window.open.

String that specifies the name of the window. This name is used as the value for the TARGET attribute on a form or an anchor element.

_blank: The url is loaded into a new, unnamed window.
_parent: The url is loaded into the current frame's parent. If the frame has no parent, this value acts as the value _self.
_self: The current document is replaced with the specified url.
_top: The loaded url replaces any framesets that might be loaded. If there are no framesets defined, this value acts as the value _self.

features [in, optional]

Type: String

Note The following applies only if this method is used instead of window.open.

String that contains a list of items separated by commas. Each item consists of an option and a value, separated by an equals sign (for example, "fullscreen=yes, toolbar=yes"). The following values are supported.

channelmode = { yes | no | 1 | 0 }

Specifies whether to display the window in theater mode. The default is no.

Internet Explorer 7. channelmode = { yes | 1 } overrides height, width, top, and left values. When active, the Navigation Bar is hidden and the Title Bar is visible. The Channel Band is no longer supported in Internet Explorer 7.

In Internet Explorer 6, channelmode = { yes | 1 } displays the Channel Band in theater mode.

fullscreen = { yes | no | 1 | 0 }

Specifies whether to display the browser in full-screen mode. The default is no. Use full-screen mode carefully. Because this mode hides the browser's title bar and menus, always provide a button or other visual clue to help the user close the window. ALT+F4 closes the new window.

Internet Explorer 7. A window in full-screen mode doesn't need to be in theater mode.

In Internet Explorer 6, a window in full-screen mode must also be in theater mode (channelmode).

height = number

Sets the height of the window in pixels. The minimum value is 150, and specifies the minimum height of the browser content area.

In Internet Explorer 6, the minimum height value is 100.

left = number

Specifies the left position, in pixels. This value is relative to the upper-left corner of the screen. The value must be greater than or equal to 0.

location = { yes | no | 1 | 0 }

Specifies whether to display the Navigation Bar. The default is yes.

In Internet Explorer 6, location specifies whether to display the Address Bar.

The Back, Forward, and Stop commands are now located in the Navigation Bar.

In Internet Explorer 6, the navigation commands were located in the toolbar.

menubar = { yes | no | 1 | 0 }

Specifies whether to display the Menu Bar. The default is yes.

Internet Explorer 7. By default, the menu bar is hidden unless revealed by the ALT key. menubar = { no | 0 } prohibits the Menu Bar from appearing even when the ALT key is pressed.

The combination of menubar = { no | 0 } and toolbar = { no | 0 } hides the toolbar and disables any additional third-party user interfaces.

resizable = { yes | no | 1 | 0 }

Specifies whether to display resize handles at the corners of the window. The default is yes.

Internet Explorer 7. resizable = { no | 0 } disables tabs in a new window.

scrollbars = { yes | no | 1 | 0 }

Specifies whether to display horizontal and vertical scroll bars. The default is yes.

status = { yes | no | 1 | 0 }

Specifies whether to add a Status Bar at the bottom of the window. The default is yes.

toolbar = { yes | no | 1 | 0 }

Internet Explorer 7. Specifies whether to display the browser Command Bar, making buttons such as Favorites Center, Add to Favorites, and Tools available. The default is yes.

The combination of menubar = { no | 0 } and toolbar = { no | 0 } turns off the toolbar and any additional third-party user interfaces.

In Internet Explorer 6, the toolbar sFeatures specifies whether to display the browser toolbar, making buttons such as Back, Forward, and Stop available.

top = number

Specifies the top position, in pixels. This value is relative to the upper-left corner of the screen. The value must be greater than or equal to 0.

width = number

Sets the width of the window in pixels. The minimum value is 250, and specifies the minimum width of the browsers content area.

In Internet Explorer 6, the minimum height value is 100.

replace [in, optional]

C++	Boolean that specifies whether the existing entry for the document is replaced in the history list. Note If this method is used instead of window.open, this parameter specifies whether the url creates a new entry or replaces the current entry in the window's history list. This parameter only takes effect if the url is loaded into the same window.
JavaScript	Specifies whether the existing entry for the document is replaced in the history list.

true: url replaces the current document in the history list.
false: url creates a new entry in the history list.
replace: Replaces the current document in the history list.

Return value

Type: Object

Returns a reference to the new document object. Use this reference to access properties and methods of the document.

Standards information

Document Object Model (DOM) Level 2 HTML Specification, Section 1.5
HTML5 A vocabulary and associated APIs for HTML and XHTML, Section 3.4.1

Remarks

When a function fired by an event on any object calls the open method, the window.open method is implied.


<script type="text/javascript">
function myOpen() {
    open('about:blank');}
</script>
<body onclick="myOpen();">
Click this page and window.open() is called.
</body>

Examples

The following example shows how to use the open method to replace the current document with a new document and display the HTML markup contained in the variable sMarkup.

JavaScript


<html>
<head>
<title>First Document</title>
<script type="text/javascript">
function replace(){
    var oNewDoc = document.open("text/html", "replace");
    var sMarkup = "<html><head><title>New Document</title></head><body>Hello, world</body></html>";
    oNewDoc.write(sMarkup);
    oNewDoc.close();
}
</script>
</head>
<body>
<h1>I just want to say</h1><br>
<!--Button will call the replace function and replace the current page with a new one-->
<input type ="button" value = "Finish Sentence" onclick="replace();">
</body>
</html>