API Reference
Page 2
... Incorporated. Consistent with only those rights as a commitment by any such license, no responsibility or liability for real time or live broadcasts. Adobe® Dreamweaver® CS3 API Reference for Windows® and Macintosh If this guide may be protected under copyright law even if it , is protected under copyright law. MPEG ...
... Incorporated. Consistent with only those rights as a commitment by any such license, no responsibility or liability for real time or live broadcasts. Adobe® Dreamweaver® CS3 API Reference for Windows® and Macintosh If this guide may be protected under copyright law even if it , is protected under copyright law. MPEG ...
API Reference
Page 3
iii Contents Chapter 1: Introduction Background 2 Extending Dreamweaver 2 Additional resources for extension writers 2 New functions in Dreamweaver CS3 2 Removed functions 4 Errata 5 Conventions used in this guide 5 Chapter 2: The file I/O API Accessing configuration folders 6 The file I/O API 6 Chapter 3: The HTTP API How the HTTP ...
iii Contents Chapter 1: Introduction Background 2 Extending Dreamweaver 2 Additional resources for extension writers 2 New functions in Dreamweaver CS3 2 Removed functions 4 Errata 5 Conventions used in this guide 5 Chapter 2: The file I/O API Accessing configuration folders 6 The file I/O API 6 Chapter 3: The HTTP API How the HTTP ...
API Reference
Page 4
iv Chapter 10: The source control integration API How source control integration with Dreamweaver works 85 Adding source control system functionality 85 The source control integration API required functions 85 The source control integration API optional functions 91 Enablers ...
iv Chapter 10: The source control integration API How source control integration with Dreamweaver works 85 Adding source control system functionality 85 The source control integration API required functions 85 The source control integration API optional functions 91 Enablers ...
API Reference
Page 6
...with Fireworks and Flash. The utility APIs contain subsets of related functions that let you perform various supporting tasks when developing Adobe® Dreamweaver® CS3 extensions and adding program code to the Dream- The utility APIs include: • The File I/O API, which lets ... for new or existing server models • The JavaBeans API, which provides access to extend the Dreamweaver Check In/Check Out feature Chapter 1: Introduction The Adobe Dreamweaver CS3 API Reference describes the application programming interfaces (APIs) that let you perform specific types of tasks.
...with Fireworks and Flash. The utility APIs contain subsets of related functions that let you perform various supporting tasks when developing Adobe® Dreamweaver® CS3 extensions and adding program code to the Dream- The utility APIs include: • The File I/O API, which lets ... for new or existing server models • The JavaBeans API, which provides access to extend the Dreamweaver Check In/Check Out feature Chapter 1: Introduction The Adobe Dreamweaver CS3 API Reference describes the application programming interfaces (APIs) that let you perform specific types of tasks.
API Reference
Page 7
...Dreamweaver, HTML, XML, JavaScript programming and, if applicable, C programming. New functions in Dreamweaver CS3...dreamweaver.activateApp()" on page 111 • "dreamweaver.printDocument()" on . The headings designate the chapters and sections that enables you to join the Dreamweaver extensibility newsgroup. Extending Dreamweaver To learn about the Dreamweaver... and so on page 111 DREAMWEAVER CS3 2 API Reference The extensive ...Dreamweaver extensions, see Extending Dreamweaver. If you should also be familiar with other features to the Application chapter. Extending Dreamweaver...
...Dreamweaver, HTML, XML, JavaScript programming and, if applicable, C programming. New functions in Dreamweaver CS3...dreamweaver.activateApp()" on page 111 • "dreamweaver.printDocument()" on . The headings designate the chapters and sections that enables you to join the Dreamweaver extensibility newsgroup. Extending Dreamweaver To learn about the Dreamweaver... and so on page 111 DREAMWEAVER CS3 2 API Reference The extensive ...Dreamweaver extensions, see Extending Dreamweaver. If you should also be familiar with other features to the Application chapter. Extending Dreamweaver...
API Reference
Page 8
.... • "MMXSLT.getXML()" on page 267 Page content The following new Active Content and Code View functions are added to "Workspace" on page 119. DREAMWEAVER CS3 3 API Reference • "dreamweaver.revealDocument()" on page 112 General application functions • "dw.registerIdleHandler()" on page 115 • "dw.revokeIdleHandler()" on page 116 Bridge Communication • "BridgeTalk...
.... • "MMXSLT.getXML()" on page 267 Page content The following new Active Content and Code View functions are added to "Workspace" on page 119. DREAMWEAVER CS3 3 API Reference • "dreamweaver.revealDocument()" on page 112 General application functions • "dw.registerIdleHandler()" on page 115 • "dw.revokeIdleHandler()" on page 116 Bridge Communication • "BridgeTalk...
API Reference
Page 9
DREAMWEAVER CS3 4 API Reference Spry widget insertion • "dom.addJavaScript()" on page 303 • "dom.copyAssets()" on page 304 • "dom.getDefaultAssetFolder()" on page 305 Browser compatibility ....getLayoutNames()" on page 334 • "dw.getLayoutDescriptions()" on page 334 • "dw.getFilesForLayout()" on page 334 Removed functions The following functions are removed from the Dreamweaver CS3 API because the associated features are removed from the product. •...
DREAMWEAVER CS3 4 API Reference Spry widget insertion • "dom.addJavaScript()" on page 303 • "dom.copyAssets()" on page 304 • "dom.getDefaultAssetFolder()" on page 305 Browser compatibility ....getLayoutNames()" on page 334 • "dw.getLayoutDescriptions()" on page 334 • "dw.getFilesForLayout()" on page 334 Removed functions The following functions are removed from the Dreamweaver CS3 API because the associated features are removed from the product. •...
API Reference
Page 10
... both HTML and XML tag and attribute names. • Italic code font indicates replaceable items in the Extensibility section of the Dreamweaver Support Center (www.adobe.com/support/dreamweaver/extend/extending_dwmx_errata). prefix when defining the function and in this guide Typographical conventions The following naming conventions are used in this guide:... line. • Curly braces ({ }) that surround a function argument indicate that a long line of code has been broken across two or more lines. DREAMWEAVER CS3 5 API Reference Errata A current list of known issues can be split.
... both HTML and XML tag and attribute names. • Italic code font indicates replaceable items in the Extensibility section of the Dreamweaver Support Center (www.adobe.com/support/dreamweaver/extend/extending_dwmx_errata). prefix when defining the function and in this guide Typographical conventions The following naming conventions are used in this guide:... line. • Curly braces ({ }) that surround a function argument indicate that a long line of code has been broken across two or more lines. DREAMWEAVER CS3 5 API Reference Errata A current list of known issues can be split.
API Reference
Page 11
Chapter 2: The file I/O API Adobe® Dreamweaver® CS3 includes a C shared library called DWfile, which lets authors of configuration files. This chapter describes the File I/O API and how to use the same mechanism. Similarly, when Dreamweaver reads a configuration file, Dreamweaver searches for it first in the user's Configuration folder and then in the Dreamweaver Configuration folder, your...
Chapter 2: The file I/O API Adobe® Dreamweaver® CS3 includes a C shared library called DWfile, which lets authors of configuration files. This chapter describes the File I/O API and how to use the same mechanism. Similarly, when Dreamweaver reads a configuration file, Dreamweaver searches for it first in the user's Configuration folder and then in the Dreamweaver Configuration folder, your...
API Reference
Page 12
... the location where you want to myconfig_backup.cfg: var fileURL = "file:///c|/Config/myconfig.cfg"; DWfile.createFolder() Availability Dreamweaver 2. DREAMWEAVER CS3 7 API Reference Description This function copies the specified file to create " + folderURL); } DWfile.exists() Availability Dreamweaver 2. Example The following code tries to create a folder called myconfig.cfg to create. var newURL ="file:///c|/Config/myconfig_backup...
... the location where you want to myconfig_backup.cfg: var fileURL = "file:///c|/Config/myconfig.cfg"; DWfile.createFolder() Availability Dreamweaver 2. DREAMWEAVER CS3 7 API Reference Description This function copies the specified file to create " + folderURL); } DWfile.exists() Availability Dreamweaver 2. Example The following code tries to create a folder called myconfig.cfg to create. var newURL ="file:///c|/Config/myconfig_backup...
API Reference
Page 13
... null value. if (DWfile.exists(fileURL)){ alert(fileURL + " exists!"); }else{ alert(fileURL + " does not exist."); } DWfile.getAttributes() Availability Dreamweaver 2. Returns A string that tells the user whether the file exists: var fileURL = "file:///c|/temp/mydata.txt"; Example The following code checks for the... box if the file is read only. • D is folder. • H is hidden. • S is read only: DREAMWEAVER CS3 8 API Reference Description This function tests for the existence of the specified file or folder. Arguments fileURL • The fileURL argument, which ...
... null value. if (DWfile.exists(fileURL)){ alert(fileURL + " exists!"); }else{ alert(fileURL + " does not exist."); } DWfile.getAttributes() Availability Dreamweaver 2. Returns A string that tells the user whether the file exists: var fileURL = "file:///c|/temp/mydata.txt"; Example The following code checks for the... box if the file is read only. • D is folder. • H is hidden. • S is read only: DREAMWEAVER CS3 8 API Reference Description This function tests for the existence of the specified file or folder. Arguments fileURL • The fileURL argument, which ...
API Reference
Page 14
....txt and file2.txt and displays an alert message that have elapsed since some base time. var time1 = DWfile.getModificationDate(file1); DREAMWEAVER CS3 9 API Reference var fileURL = "file:///c|/temp/mydata.txt"; Returns A string that contains a hexadecimal number that represents the number ...of time units and base time is newer than file2"); } DWfile.getCreationDate() Availability Dreamweaver 4. Arguments fileURL • The fileURL argument, which is expressed as a file:// URL, is the file for example, a time unit ...
....txt and file2.txt and displays an alert message that have elapsed since some base time. var time1 = DWfile.getModificationDate(file1); DREAMWEAVER CS3 9 API Reference var fileURL = "file:///c|/temp/mydata.txt"; Returns A string that contains a hexadecimal number that represents the number ...of time units and base time is newer than file2"); } DWfile.getCreationDate() Availability Dreamweaver 4. Arguments fileURL • The fileURL argument, which is expressed as a file:// URL, is the file for example, a time unit ...
API Reference
Page 15
... when the file was created. if (time1 == time2){ alert("file1 has not been modified since some base time. DWfile.getModificationDateObj() Availability Dreamweaver MX. Returns A string that contains a hexadecimal number that represents the number of time units that represents the time when the file was ... function gets the JavaScript Date object that have elapsed since it was created"); }else if (time1 < time2){ alert("file1 was last modified. DREAMWEAVER CS3 10 API Reference • The fileURL argument, which is expressed as a file:// URL, is the file for which you are checking the ...
... when the file was created. if (time1 == time2){ alert("file1 has not been modified since some base time. DWfile.getModificationDateObj() Availability Dreamweaver MX. Returns A string that contains a hexadecimal number that represents the number of time units that represents the time when the file was ... function gets the JavaScript Date object that have elapsed since it was created"); }else if (time1 < time2){ alert("file1 was last modified. DREAMWEAVER CS3 10 API Reference • The fileURL argument, which is expressed as a file:// URL, is the file for which you are checking the ...
API Reference
Page 16
...list of a specified file. var fileMask = "*.txt"; var list = DWfile.listFolder(folderURL + "/" + fileMask, "files"); DWfile.getSize() Availability Dreamweaver MX. Description This function gets the size of all the text (TXT) files in the C:/temp folder and displays the list in bytes, of ...The fileURL argument, which you are checking the size. Description This function gets a list of the contents of the specified folder. DREAMWEAVER CS3 11 API Reference Returns A JavaScript Date object that represents the contents of the specified file. Valid wildcards are asterisks (*), which match...
...list of a specified file. var fileMask = "*.txt"; var list = DWfile.listFolder(folderURL + "/" + fileMask, "files"); DWfile.getSize() Availability Dreamweaver MX. Description This function gets the size of all the text (TXT) files in the C:/temp folder and displays the list in bytes, of ...The fileURL argument, which you are checking the size. Description This function gets a list of the contents of the specified folder. DREAMWEAVER CS3 11 API Reference Returns A JavaScript Date object that represents the contents of the specified file. Valid wildcards are asterisks (*), which match...
API Reference
Page 17
... the file or a null value if the read (fileURL); if (str){ alert(fileURL + " contains: " + str); } DWfile.remove() Availability Dreamweaver 3. Returns A Boolean value: true value if the operation succeeds; Example The following code reads the mydata.txt file and, if it is the file you... is successful, displays an alert message with the contents of the specified file into a string. Description This function deletes the specified file. DREAMWEAVER CS3 12 API Reference DWfile.read -only and the confirm() function to display a Yes/No dialog box to remove. Arguments fileURL • The...
... the file or a null value if the read (fileURL); if (str){ alert(fileURL + " contains: " + str); } DWfile.remove() Availability Dreamweaver 3. Returns A Boolean value: true value if the operation succeeds; Example The following code reads the mydata.txt file and, if it is the file you... is successful, displays an alert message with the contents of the specified file into a string. Description This function deletes the specified file. DREAMWEAVER CS3 12 API Reference DWfile.read -only and the confirm() function to display a Yes/No dialog box to remove. Arguments fileURL • The...
API Reference
Page 18
...getAttributes(selFile).indexOf('R') != -1){ delAnyway = confirm('This file is set as visible (V). if (delAnyway){ DWfile.remove(selFile); } } } DWfile.setAttributes() Availability Dreamweaver MX. The following table describes valid attribute values and their meaning: Attribute Value R W H V Description Read only Writable (overrides R) Hidden Visible (overrides... for the strAttrs string are mutually exclusive. Likewise, if you are also mutually exclusive. DREAMWEAVER CS3 13 API Reference var selFile = document.theForm.menu.options[selIndex].value; DWfile.write() Availability...
...getAttributes(selFile).indexOf('R') != -1){ delAnyway = confirm('This file is set as visible (V). if (delAnyway){ DWfile.remove(selFile); } } } DWfile.setAttributes() Availability Dreamweaver MX. The following table describes valid attribute values and their meaning: Attribute Value R W H V Description Read only Writable (overrides R) Hidden Visible (overrides... for the strAttrs string are mutually exclusive. Likewise, if you are also mutually exclusive. DREAMWEAVER CS3 13 API Reference var selFile = document.theForm.menu.options[selIndex].value; DWfile.write() Availability...
API Reference
Page 19
...")){ alert("Wrote xxx to " + fileURL); } if (DWfile.write(fileURL, "aaa", "append")){ alert("Appended aaa to the file and displays a second alert if the write succeeds. DREAMWEAVER CS3 14 API Reference Description This function writes the specified string to the mydata.txt file and displays an alert message if the write operation succeeds...
...")){ alert("Wrote xxx to " + fileURL); } if (DWfile.write(fileURL, "aaa", "append")){ alert("Appended aaa to the file and displays a second alert if the write succeeds. DREAMWEAVER CS3 14 API Reference Description This function writes the specified string to the mydata.txt file and displays an alert message if the write operation succeeds...
API Reference
Page 20
... for URL arguments is 80. The statusCode property indicates the status of the MMHttp object. possible values are specified in the local file system. Adobe® Dreamweaver® CS3 provides a mechanism to get information from and send information to use it. For functions that return an object, the object has two properties: statusCode...
... for URL arguments is 80. The statusCode property indicates the status of the MMHttp object. possible values are specified in the local file system. Adobe® Dreamweaver® CS3 provides a mechanism to get information from and send information to use it. For functions that return an object, the object has two properties: statusCode...
API Reference
Page 21
... version. This capability is a string that represents the reply from which can be local or remote. MMHttp.clearServerScriptsFolder() Availability Dreamweaver MX. Returns An object that names a particular folder, relative to the Configuration folder on the application server, from the .../Menus folder, removes all its first argument. Example The following code, in Configuration/Connections/Scripts/servermodel/_mmDBScripts folder. DREAMWEAVER CS3 16 API Reference Functions that contains the contents of the deleted scripts. Callback functions let other functions execute while the...
... version. This capability is a string that represents the reply from which can be local or remote. MMHttp.clearServerScriptsFolder() Availability Dreamweaver MX. Returns An object that names a particular folder, relative to the Configuration folder on the application server, from the .../Menus folder, removes all its first argument. Example The following code, in Configuration/Connections/Scripts/servermodel/_mmDBScripts folder. DREAMWEAVER CS3 16 API Reference Functions that contains the contents of the deleted scripts. Callback functions let other functions execute while the...