Home » Adobe Manuals » Computer Software » Adobe 38040334 » Manual Viewer

Adobe 38040334 API Reference - Page 242

dreamweaver.getNewDocumentDOM, Returns, Examples, Availability, Description, Arguments

UPC - 883919090467

Add to My Manuals
Save this manual to your list of manuals

Page 242 highlights

DREAMWEAVER CS3 237 API Reference • The sourceDoc argument must be "document", "parent", "parent.frames[number]", "parent.frames['frameName']", or a URL. The sourceDoc value defaults to "document" if you do not supply a value. These argument values have the following meanings: • The document value specifies the document that has focus and contains the current selection. • The parent value specifies the parent frameset (if the currently selected document is in a frame). • The parent.frames[number] and parent.frames['frameName'] values specify a document that is in a particular frame within the frameset that contains the current document. • If the argument is a relative URL, it is relative to the extension file. Note: If the argument is "document", the calling function must be the applyBehavior(), deleteBehavior(), objectTag() function, or any function in a command or Property inspector file that can perform edits to the document. Returns The JavaScript document object at the root of the tree. Examples The following example uses the dreamweaver.getDocumentDOM() function to access the current document: var theDOM = dreamweaver.getDocumentDOM("document"); In the following example, the current document DOM identifies a selection and pastes it at the end of another document: var currentDOM = dreamweaver.getDocumentDOM('document'); currentDOM.setSelection(100,200); currentDOM.clipCopy(); var otherDOM = dreamweaver.openDocument(dreamweaver.¬ getSiteRoot() + "html/foo.htm"); otherDOM.endOfDocument(); otherDOM.clipPaste(); Note: The openDocument() argument is used because DOM methods normally operate only on open documents. Running a function on a document that isn't open causes a Dreamweaver error. The DOM methods that can operate only on the active document or on closed documents indicate this fact in their descriptions. dreamweaver.getNewDocumentDOM() Availability Dreamweaver MX; added documentType argument in Dreamweaver 8. Description Provides access to the editable tree for a new, empty document. This function works in the same way as the getDocumetDOM() function, except that it points to a new document, not an existing one, and does not open the document. Arguments {documentType} • The documentType argument is a string. Its value must be a document type specified in the DocumentTypes.xml file. Returns A pointer to a new, empty document.

Section	Page
Contents	3
Chapter 1: Introduction	6
Background	7
Extending Dreamweaver	7
Additional resources for extension writers	7
New functions in Dreamweaver CS3	7
Removed functions	9
Errata	10
Conventions used in this guide	10
Chapter 2: The file I/O API	11
Accessing configuration folders	11
The file I/O API	11
Chapter 3: The HTTP API	20
How the HTTP API works	20
The HTTP API	21
Chapter 4: The Design Notes API	27
How Design Notes work	27
The Design Notes JavaScript API	28
The Design Notes C API	32
Chapter 5: Fireworks integration	39
The FWLaunch API	39
Chapter 6: Flash integration	46
How Flash elements work	46
Inserting Flash elements	46
The Flash Objects API	47
Chapter 7: The database API	51
How database API functions work	51
Database connection functions	52
Database access functions	64
Chapter 8: The database connectivity API	76
How to develop a new connection type	76
The Connection API	78
The generated include file	80
The definition file for your connection type	82
Chapter 9: The JavaBeans API	84
The JavaBeans API	84
Chapter 10: The source control integration API	89
How source control integration with Dreamweaver works	90
Adding source control system functionality	90
The source control integration API required functions	90
The source control integration API optional functions	96
Enablers	104
Chapter 11: Application	109
External application functions	109
Global application functions	117
Bridge communication functions	122
Chapter 12: Workspace	124
History functions	124
Insert object functions	132
Keyboard functions	135
Menu functions	141
Results window functions	143
Toggle functions	154
Toolbar functions	173
Window functions	178
Code collapse functions	188
Code view toolbar functions	194
Chapter 13: Site	198
Report functions	198
Site functions	199
Chapter 14: Document	232
Conversion functions	232
Command functions	233
File manipulation functions	235
Global document functions	249
Path functions	258
Selection functions	260
String manipulation functions	267
Translation functions	270
XSLT functions	272
Chapter 15: Page content	275
Assets panel functions	275
Behavior functions	285
Clipboard functions	293
Library and template functions	298
Snippets panel functions	303
Spry widget editing functions	306
Inserting Spry widgets functions	308
Browser compatibility check functions	311
Chapter 16: Dynamic documents	319
Server components functions	319
Data source functions	320
Extension Data Manager functions	321
Live data functions	324
Server behavior functions	328
Server model functions	330
Chapter 17: Design	337
CSS layout functions	337
Frame and frameset functions	356
Layer and image map functions	358
Layout environment functions	360
Layout view functions	365
Zoom functions	374
Guide functions and properties	377
Table editing functions	384
Chapter 18: Code	393
Code functions	393
Find and replace functions	397
General editing functions	402
Print function	417
Quick Tag Editor functions	418
Code view functions	420
Tag editor and tag library functions	436
Chapter 19: Enablers	440
Enabler functions	440

Match case Limit results 1 per page

DREAMWEAVER CS3

API Reference

237

•

The

sourceDoc

argument must be

"document"

"parent"

"parent.frames[

number

"parent.frames['

frameName

']"

, or a URL. The

sourceDoc

value defaults to

"document"

if you do not supply

a value. These argument values have the following meanings:

•

The

document

value specifies the document that has focus and contains the current selection.

•

The

parent

value specifies the parent frameset (if the currently selected document is in a frame).

•

The

parent.frames[

number

]

and

parent.frames['

frameName

values specify a document that is in a

particular frame within the frameset that contains the current document.

•

If the argument is a relative URL, it is relative to the extension file.

Note:

If the argument is

"document"

, the calling function must be the

applyBehavior()

deleteBehavior()

objectTag()

function, or any function in a command or Property inspector file that can perform edits to the document.

Returns

The JavaScript document object at the root of the tree.

Examples

The following example uses the

dreamweaver.getDocumentDOM()

function to access the current document:

var theDOM = dreamweaver.getDocumentDOM("document");

In the following example, the current document DOM identifies a selection and pastes it at the end of another

document:

var currentDOM = dreamweaver.getDocumentDOM('document');

currentDOM.setSelection(100,200);

currentDOM.clipCopy();

var otherDOM = dreamweaver.openDocument(dreamweaver.¬

getSiteRoot() + "html/foo.htm");

otherDOM.endOfDocument();

otherDOM.clipPaste();

Note:

The

openDocument()

argument is used because

DOM

methods normally operate only on open documents.

Running a function on a document that isn’t open causes a Dreamweaver error. The

DOM

methods that can operate only

on the active document or on closed documents indicate this fact in their descriptions.

dreamweaver.getNewDocumentDOM()

Availability

Dreamweaver MX; added

documentType

argument in Dreamweaver 8.

Description

Provides access to the editable tree for a new, empty document. This function works in the same way as the

getDoc-

umetDOM()

function, except that it points to a new document, not an existing one, and does not open the document.

Arguments

{documentType}

•

The

documentType

argument is a string. Its value must be a document type specified in the DocumentTypes.xml

file.

Returns

A pointer to a new, empty document.