beautypg.com

Dreamweaver.closedocument(), Dreamweaver.createdocument() – Adobe Dreamweaver API Reference CS5 User Manual

Page 258

background image

253

DREAMWEAVER API REFERENCE

Document

Last updated 8/27/2013

dreamweaver.closeDocument()

Availability
Dreamweaver 2.

Description
Closes the specified document.

Arguments
documentObject

The documentObject argument is the object at the root of a document’s DOM tree (the value that the

dreamweaver.getDocumentDOM()

function returns). If the documentObject argument refers to the active

document, the Document window might not close until the script that calls this function finishes executing.

Returns
Nothing.

dreamweaver.createDocument()

Availability
Dreamweaver 2, enhanced in Dreamweaver 4.

Description
Depending on the argument that you pass to this function, it opens a new document either in the same window or in
a new window. The new document becomes the active document.

Note: This function can be called only from the menus.xml file, a command, or the Property inspector file. If a behavior
action or object tries to call this function, Dreamweaver displays an error message.

Arguments
{bOpenInSameWindow}, {type}

The bOpenInSameWindow argument is a Boolean value that indicates whether to open the new document in the
current window. If the bOpenInSameWindow argument is a value of

false

, if it is omitted, or if the function is

called on the Macintosh, the new document opens in a separate window.

The type argument specifies the type of document to create, as declared in the Dreamweaver
Configuration/DocumentTypes/MMDocumentTypes.xml file as the

id

attribute of the

documenttype

tag. For

example, the type argument could be

"HTML", "ASP-JS", "ASP-VB", "ColdFusion", "CFC", "JSP",

"ASP.NET_VB",

and so on. For a complete list of possible types, see the MMDocumentTypes.xml file. If you do not

specify type, the value defaults to

"HTML"

.

Note: You can extend the MMDocumentTypes file by adding your own document types. For information on extending
document types, see Extending Dreamweaver.

Returns
The document object for the newly created document. This is the same value that the

dreamweaver.getDocumentDOM()

function returns.