Adobe 38040334 API Reference
Adobe 38040334 - Dreamweaver CS3 - PC Manual
 |
UPC - 883919090467
View all Adobe 38040334 manuals
Add to My Manuals
Save this manual to your list of manuals |
Adobe 38040334 manual content summary:
- Adobe 38040334 | API Reference - Page 1
ADOBE® DREAMWEAVER® CS3 API REFERENCE - Adobe 38040334 | API Reference - Page 2
, ColdFusion, Creative Suite, Director, Dreamweaver, Fireworks, Flash, FlashPaper, HomeSite, JRun, Photoshop, Shockwave, and Version Cue are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States. ActiveX, Microsoft, and Windows are either registered trademarks - Adobe 38040334 | API Reference - Page 3
Dreamweaver 2 Additional resources for extension writers 2 New functions in Dreamweaver CS3 2 Removed functions 4 Errata 5 Conventions used in this guide FWLaunch API 34 Chapter 6: Flash integration How Flash elements work 41 Inserting Flash elements 41 The Flash Objects API 42 Chapter 7: - Adobe 38040334 | API Reference - Page 4
iv Chapter 10: The source control integration API How source control integration with Dreamweaver works 85 Adding source control system functions 130 Menu functions 136 Results window functions 138 Toggle functions 149 Toolbar functions 168 Window functions 173 Code collapse functions 183 - Adobe 38040334 | API Reference - Page 5
Frame and frameset functions 351 Layer and image map functions 353 Layout environment functions 355 Layout view functions 360 Zoom functions 369 Guide functions and properties 372 Table editing functions 379 Chapter 18: Code Code functions 388 Find and replace functions 392 General editing - Adobe 38040334 | API Reference - Page 6
API Reference describes the application programming interfaces (APIs) that let you perform various supporting tasks when developing Adobe® Dreamweaver® CS3 extensions and adding program code to your Dreamweaver web pages. These APIs include the main JavaScript API, which provides access to much of - Adobe 38040334 | API Reference - Page 7
extensibility newsgroup. You can access the website for this newsgroup at www.adobe.com/support/dreamweaver/extend/form/. New functions in Dreamweaver CS3 The following new functions are added to the Dreamweaver CS3 JavaScript API. The headings designate the chapters and sections that contain the - Adobe 38040334 | API Reference - Page 8
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.bringToFront()" on page 117 • "Bridgetalk. - Adobe 38040334 | 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 check issues • "elem.getComputedStyleProp()" on page 306 • "window.getDeclaredStyle()" on page 307 • "dom. - Adobe 38040334 | API Reference - Page 10
DREAMWEAVER CS3 5 API Reference Errata A current list of known issues can be found in the Extensibility section of the Dreamweaver Support Center (www.adobe.com/support/dreamweaver/extend/extending_dwmx_errata). Conventions used in this guide Typographical conventions The following typographical - Adobe 38040334 | 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 the JavaScript interpreter in Dreamweaver, see "C-Level Extensibility" in Extending Dreamweaver. Accessing configuration folders On Microsoft Windows 2000 and Windows XP, and Mac OS - Adobe 38040334 | API Reference - Page 12
DREAMWEAVER CS3 7 API Reference Description This function copies the specified file to a new location. Arguments Config/myconfig_backup.cfg"; DWfile.copy(fileURL, newURL); DWfile.createFolder() Availability Dreamweaver 2. Description This function creates a folder at the specified location. Arguments - Adobe 38040334 | API Reference - Page 13
DREAMWEAVER CS3 8 API Reference Description This function tests for the existence of the exists!"); }else{ alert(fileURL + " does not exist."); } DWfile.getAttributes() Availability Dreamweaver 2. Description This function gets the attributes of the specified file or folder. Arguments fileURL - Adobe 38040334 | API Reference - Page 14
DREAMWEAVER CS3 9 API Reference var fileURL = "file:///c|/temp/mydata.txt"; var str = DWfile.getAttributes(fileURL); if (str && (str.indexOf("R") != -1)){ alert(fileURL + " is read only!"); } DWfile.getModificationDate() Availability Dreamweaver is platform-dependent; in Windows, for example, a time - Adobe 38040334 | API Reference - Page 15
DREAMWEAVER CS3 10 API Reference • The fileURL argument, which is expressed as a file:// URL, is have elapsed since some base time. The exact meaning of time units and base time is platform-dependent; in Windows, for example, a time unit is 100ns, and the base time is January 1st, 1600. Example You - Adobe 38040334 | API Reference - Page 16
DREAMWEAVER CS3 11 API Reference Returns A JavaScript Date object that represents the date and time when the specified file was last modified. DWfile.getSize() Availability Dreamweaver MX. Description This function gets the size of a specified file. Arguments fileURL • The fileURL argument, which is - Adobe 38040334 | API Reference - Page 17
DREAMWEAVER CS3 12 API Reference DWfile.read() Availability Dreamweaver 2. Description This function reads the contents ){ alert(fileURL + " contains: " + str); } DWfile.remove() Availability Dreamweaver 3. Description This function deletes the specified file. Arguments fileURL • The fileURL argument - Adobe 38040334 | API Reference - Page 18
CS3 13 API Reference var selFile = document.theForm.menu.options[selIndex].value; if (DWfile.getAttributes(selFile).indexOf('R') != -1){ delAnyway = confirm('This file is read-only. Delete anyway?'); if (delAnyway){ DWfile.remove(selFile); } } } DWfile.setAttributes() Availability Dreamweaver - Adobe 38040334 | API Reference - Page 19
DREAMWEAVER CS3 14 API Reference Description This function writes the specified string to the specified file. If the specified file does not yet exist, it is created. - Adobe 38040334 | API Reference - Page 20
in the local file system. Adobe® Dreamweaver® CS3 provides a mechanism to get information 404: Requested URL not found • 405: Server does not support requested method • 500: Unknown server error • 503: for your server, check with your Internet service provider or system administrator. The value of - Adobe 38040334 | API Reference - Page 21
DREAMWEAVER CS3 16 API Reference Functions that return an object also have a callback version. Callback functions let other functions execute while the web server processes an HTTP request. This capability is useful if you are making multiple HTTP requests from Dreamweaver. The callback version of a - Adobe 38040334 | API Reference - Page 22
DREAMWEAVER CS3 17 API Reference MMHttp.clearTemp() Description This function deletes all the files in the Configuration/Temp folder, which is located in the Dreamweaver application folder. Arguments None. Returns Nothing. Example The following code, when saved in a file within the Configuration/ - Adobe 38040334 | API Reference - Page 23
DREAMWEAVER CS3 18 API Reference Returns An object that represents the reply from the file handle • 7: Cannot remove current working folder • 8: No more folder entries • 9: Error setting file pointer • 10: Hardware error • 11: Sharing violation • 12: Lock violation • 13: Disk full • 14: End of file - Adobe 38040334 | API Reference - Page 24
DREAMWEAVER CS3 19 API Reference • The callbackFunction argument is the name of the JavaScript function to call when the HTTP request is complete. • The URL argument is an absolute URL on a web server; if http:// is omitted from the URL, Dreamweaver assumes HTTP protocol. • The prompt argument, - Adobe 38040334 | API Reference - Page 25
DREAMWEAVER CS3 20 API Reference Arguments callbackFunc, URL, {serverScriptsFolder} • The callbackFunc argument is the JavaScript function to call when the HTTP request is complete. • The URL argument is an absolute URL on a web server; if http:// is omitted from the URL, Dreamweaver assumes HTTP - Adobe 38040334 | API Reference - Page 26
DREAMWEAVER CS3 21 API Reference 1 The myScripts.cfm file in the Configuration/DeployScripts folder on the local computer is copied to another folder named DeployScripts, which is a subfolder of the root folder on the ultraqa8 website. To deploy the files, Dreamweaver uses the protocol specified in - Adobe 38040334 | API Reference - Page 27
Chapter 4: The Design Notes API Adobe® Dreamweaver® CS3, Fireworks, and Flash give web designers and developers a way not visible in the Site panel, but they appear in the Finder (Macintosh) or Windows Explorer. A Design Notes filename comprises the main filename plus the .mno extension. For example - Adobe 38040334 | API Reference - Page 28
DREAMWEAVER CS3 23 API Reference - Adobe 38040334 | API Reference - Page 29
DREAMWEAVER CS3 24 API Reference MMNotes.get() Description This function gets the value of the specified key in the specified Design Notes file. Arguments fileHandle, keyName • The - Adobe 38040334 | API Reference - Page 30
DREAMWEAVER CS3 25 API Reference var noteHandle = MMNotes.open(dw.getDocumentDOM().URL); var theKeys = MMNotes.getKeys(noteHandle); var noteString = ""; var theValue = ""; for (var i=0; i < theKeys.length; i++){ theValue = MMNotes. - Adobe 38040334 | API Reference - Page 31
DREAMWEAVER CS3 26 API Reference Arguments None. Returns A string that contains the version number. MMNotes.localURLToFilePath() Description This function converts the specified file:// URL to a local drive - Adobe 38040334 | API Reference - Page 32
DREAMWEAVER CS3 27 API Reference • The fileHandle argument is the file handle that the MMNotes. not necessary to call these C functions directly if you use the MMNotes shared library in Dreamweaver because the JavaScript versions of the functions call them. This section contains descriptions of the - Adobe 38040334 | API Reference - Page 33
DREAMWEAVER CS3 28 API Reference void CloseNotesFile() Description This function closes the specified Design Notes file and saves any changes. If all key/value pairs are removed from the Design Note file, Dreamweaver deletes it. Dreamweaver deletes the _notes folder when the last Design Notes file - Adobe 38040334 | API Reference - Page 34
DREAMWEAVER CS3 29 API Reference Example The following code gets the value of the comments key in the Design Notes file that is associated with the welcome. - Adobe 38040334 | API Reference - Page 35
DREAMWEAVER CS3 30 API Reference • The noteHandle argument is the file handle that OpenNotesFile() returns. • The keyBufArray[64] argument is the buffer array where the keys are - Adobe 38040334 | API Reference - Page 36
DREAMWEAVER CS3 31 API Reference BOOL GetVersionName() Description This function gets the version name Boolean value: true indicates the operation is successful; false otherwise. Dreamweaver stores "Dreamweaver" in versionNameBuf argument. BOOL GetVersionNum() Description This function gets the - Adobe 38040334 | API Reference - Page 37
DREAMWEAVER CS3 32 API Reference FileHandle OpenNotesFile() Description This function opens the Design Notes file that is associated with the specified file or creates one if none - Adobe 38040334 | API Reference - Page 38
the name of the key. • The value argument is a string that contains the value. Returns A Boolean value: true indicates the operation is successful; false otherwise. DREAMWEAVER CS3 33 API Reference - Adobe 38040334 | API Reference - Page 39
API documented in Extending Fireworks. For general information on how C libraries interact with the JavaScript interpreter in Adobe® Dreamweaver® CS3, see Extending Dreamweaver for details on C-level extensibility. The FWLaunch API The FWLaunch object lets extensions open Fireworks, perform - Adobe 38040334 | API Reference - Page 40
DREAMWEAVER CS3 35 API Reference FWLaunch.bringFWToFront() Availability Dreamweaver 3, Fireworks 3. Description This function brings Fireworks to the front if it is running. Arguments None. Returns Nothing. FWLaunch.execJsInFireworks() Availability Dreamweaver 3, Fireworks 3. Description This - Adobe 38040334 | API Reference - Page 41
DREAMWEAVER CS3 36 API Reference window // and let the user know we got an error window.close(); alert("An error occurred."); }else{ // got a valid response! alert("Nice to meet you, " + response); window.close(); } doneFlag = true; } } } FWLaunch.mayLaunchFireworks() Availability Dreamweaver - Adobe 38040334 | API Reference - Page 42
DREAMWEAVER CS3 37 API Reference Description This function determines whether it is possible to open a Fireworks optimization session. Arguments None. Returns A Boolean value that indicates whether the platform is Windows or the Macintosh; if it is the Macintosh, the value indicates if another - Adobe 38040334 | API Reference - Page 43
DREAMWEAVER CS3 38 API Reference Arguments {versionNumber} • The versionNumber argument is an optional return new Array("Prompt", "promptInFireworks()", "Cancel", ¬ "readyToCancel()", "Close","window.close()"); } var gCancelClicked = false; var gProgressTrackerCookie = null; function readyToCancel - Adobe 38040334 | API Reference - Page 44
a useful one, since not all functions in // Fireworks return a string, but we know this one does, // so we can show the user what we got. window.close(); FWLaunch.bringDWToFront();// bring Dreamweaver to the front alert("Nice to meet you, " + response + "!"); } } } DREAMWEAVER CS3 39 API Reference - Adobe 38040334 | API Reference - Page 45
the prompt() ¬ function. When you click Prompt, Fireworks comes forward and ¬ asks you to enter a value into a dialog box. That value is then ¬ returned to Dreamweaver and displayed in an alert. - Adobe 38040334 | API Reference - Page 46
Chapter 6: Flash integration Adobe® Dreamweaver® CS3 provides support for Flash elements as well as continuing support for the Flash Object API, which leverages the Flash Generator Template file to create new Flash objects. This chapter describes ways of working with Flash elements (SWC files), and - Adobe 38040334 | API Reference - Page 47
DREAMWEAVER CS3 42 API Reference file that is already installed in the Configuration/ in the object definition file to add available Flash elements to a document. When the user selects the Flash element object, Dreamweaver unpacks the SWC file, which contains Flash content (SWF file) and a file that - Adobe 38040334 | API Reference - Page 48
DREAMWEAVER CS3 43 API Reference SWFFile.createFile() Description This function generates a new Flash Object file with the the values are what you want to specify for those parameters. For Dreamweaver to recognize a SWF file as a Flash object, the first parameter must be "dwType". Its value should - Adobe 38040334 | API Reference - Page 49
DREAMWEAVER CS3 44 API Reference • "initGeneratorFailed" means the Generator cannot be initialized. • "outOfMemory" means there is insufficient memory to complete the operation. • "unknownError" means an unknown error occurred. Example The following JavaScript creates a Flash object file of type " - Adobe 38040334 | API Reference - Page 50
DREAMWEAVER CS3 45 API Reference if ( SWFFile.getObjectType("file:///MyMac/test.swf") == "myType" ){ alert ("This is a myType object."); }else{ alert ("This is not a myType object."); } SWFFile.readFile() Description This function reads a Flash Object file. Arguments fileName • The fileName - Adobe 38040334 | API Reference - Page 51
web applications, not at runtime when the web application is deployed. You can use these functions in any extension. In fact, the Adobe® Dreamweaver® CS3 server behavior, data format, and data sources APIs all use these database functions. The functions described in this chapter are grouped into - Adobe 38040334 | API Reference - Page 52
DREAMWEAVER CS3 47 API Reference function getDynamicBindings(ss) { var serverModel = dw.getDocumentDOM(). database, see "Database access functions" on page 59. MMDB.deleteConnection() Availability Dreamweaver MX. Description This function deletes the named database connection. Arguments connName • - Adobe 38040334 | API Reference - Page 53
DREAMWEAVER CS3 48 API Reference Returns Nothing. Example The following example deletes a database connection: function clickedDelete() { var selectedObj = dw.serverComponents.getSelectedNode(); if (selectedObj && selectedObj.objectType=="Connection") { var - Adobe 38040334 | API Reference - Page 54
DREAMWEAVER CS3 49 API Reference Property name type string dsn driver username password that was used to create the connection Note: These properties are the standard ones that Dreamweaver implements. Developers can define their connection types and add new properties to this standard set or - Adobe 38040334 | API Reference - Page 55
DREAMWEAVER CS3 50 API Reference MMDB.getConnectionName() Availability Dreamweaver UltraDev 1. Description This function gets the getConnectionName ¬ ("dsn=EmpDB;uid=;pwd="); MMDB.getConnectionString() Availability Dreamweaver UltraDev 1. Description This function gets the connection string that - Adobe 38040334 | API Reference - Page 56
DREAMWEAVER CS3 51 API Reference • The connName argument is a connection name that is specified in the Connection Manager. It identifies the connection string that Dreamweaver should use to make a database connection to a live data source. Returns A connection string that corresponds to the named - Adobe 38040334 | API Reference - Page 57
DREAMWEAVER CS3 52 API Reference var DEFAULT_DRIVER = "COM.ibm.db2.jdbc.app.DB2Driver"; var DEFAULT_TEMPLATE = "jdbc:db2:[database name]"; Dreamweaver has a dialog box for each driver/URL template pair. In summary, Dreamweaver UltraDev 4 developers need to add a new entry to the XML, and Dreamweaver - Adobe 38040334 | API Reference - Page 58
DREAMWEAVER CS3 53 API Reference Example The statement MMDB.getPassword ("EmpDB"); might return "joessecret". MMDB.getRDSPassword() Availability Dreamweaver UltraDev 4. Description This function gets the Remote Development Services (RDS) password (for use with ColdFusion connections). Arguments None - Adobe 38040334 | API Reference - Page 59
DREAMWEAVER CS3 54 API Reference • The urlParams argument, which is optional, is a string that a connection name that is specified in the Connection Manager. It identifies the connection string that Dreamweaver should use to make a database connection to a live data source. Returns A user name - Adobe 38040334 | API Reference - Page 60
DREAMWEAVER CS3 55 API Reference MMDB.hasConnectionWithName() Availability Dreamweaver UltraDev 4. Description This function determines RDS login information; false otherwise. MMDB.needToRefreshColdFusionDsnList() Availability Dreamweaver MX. Description This function tells the Connection Manager to - Adobe 38040334 | API Reference - Page 61
DREAMWEAVER CS3 56 API Reference MMDB.popupConnection() Availability Dreamweaver MX. Description This function starts a list consists of connRec and the Boolean value bDuplicate, the popupConnection() function makes Dreamweaver open the Connection dialog box in duplicate mode. In this mode, the name - Adobe 38040334 | API Reference - Page 62
RDS user name. Returns Nothing. MMDB.showColdFusionAdmin() Availability Dreamweaver MX. Description This function displays the ColdFusion Administrator dialog Administrator dialog box appears. MMDB.showConnectionMgrDialog() Availability Dreamweaver UltraDev 1. Description This function displays the - Adobe 38040334 | API Reference - Page 63
DREAMWEAVER CS3 58 API Reference MMDB.showOdbcDialog() Availability Dreamweaver UltraDev 4 (Windows only). Description This function displays the user cancelled the dialog box. MMDB.showRestrictDialog() Availability Dreamweaver UltraDev 4. Description This function displays the Restrict dialog box. - Adobe 38040334 | API Reference - Page 64
DREAMWEAVER CS3 59 API Reference Returns An object that contains the new values in the catalog and schema properties. If either property is not defined, it indicates that the user cancelled the dialog box. MMDB.testConnection() Availability Dreamweaver UltraDev 4. Description This function tests - Adobe 38040334 | API Reference - Page 65
DREAMWEAVER CS3 60 API Reference • Stored procedures often require parameters. There are two a connection name that is specified in the Connection Manager. It identifies the connection string that Dreamweaver should use to make a database connection to a live data source. • The statement argument - Adobe 38040334 | API Reference - Page 66
DREAMWEAVER CS3 61 API Reference • The statement argument is the SQL SELECT statement to The connName argument is the connection name. This value identifies the connection containing the string that Dreamweaver should use to make a database connection to a live data source. • The tableName argument - Adobe 38040334 | API Reference - Page 67
DREAMWEAVER CS3 62 API Reference for (i = 0; i < columnNameObjs.length; i++) { var columnObj = columnNameObjs[i]; var columnName name that is specified in the Connection Manager. It identifies the connection string that Dreamweaver should use to make a database connection to a live data source. • The - Adobe 38040334 | API Reference - Page 68
DREAMWEAVER CS3 63 API Reference • The tableName argument is the name of the table for is a connection name that is specified in the Connection Manager. It identifies the connection string that Dreamweaver should use to make a database connection to a live data source. Returns An array of procedure - Adobe 38040334 | API Reference - Page 69
DREAMWEAVER CS3 64 API Reference Example The following code gets a list of procedures: var procObjects = MMDB.getProcedures( name that is specified in the Connection Manager. It identifies the connection string that Dreamweaver should use to make a database connection to a live data source. • - Adobe 38040334 | API Reference - Page 70
DREAMWEAVER CS3 65 API Reference MMDB.getSPColumnListNamedParams() Availability Dreamweaver UltraDev 1. Description This function gets a list of result set columns that are generated by a call to the specified stored procedure. Arguments connName, statement, paramNameArray, paramValuesArray • - Adobe 38040334 | API Reference - Page 71
DREAMWEAVER CS3 66 API Reference • The connName argument is a connection name that is specified in the Connection Manager. It identifies the connection string that Dreamweaver should use to make a database connection to a live data source. • The procName argument is the name of the procedure. - Adobe 38040334 | API Reference - Page 72
DREAMWEAVER CS3 67 API Reference Returns A comma-delimited string that contains the list date. For salary, the direction is in and the data type is date. MMDB.getTables() Availability Dreamweaver UltraDev 1. Description This function gets a list of all the tables that are defined for the specified - Adobe 38040334 | API Reference - Page 73
DREAMWEAVER CS3 68 API Reference • The connName argument is a connection name that is specified in the Connection Manager. It identifies the connection string that Dreamweaver should use to make a database connection to a live data source. Returns An array of view objects where each object has three - Adobe 38040334 | API Reference - Page 74
DREAMWEAVER CS3 69 API Reference MMDB.showSPResultset() Availability Dreamweaver UltraDev 1. Description This function displays a that is specified in the Connection Manager. It identifies the connection string that Dreamweaver should use to make a database connection to a live data source. • - Adobe 38040334 | API Reference - Page 75
DREAMWEAVER CS3 70 API Reference • The paramValuesArray argument is an array that contains a list of design-time parameter test values. Returns This function returns an error if - Adobe 38040334 | API Reference - Page 76
can create new connection types and corresponding dialog boxes for new or existing server models for Adobe® Dreamweaver® CS3. Then, when a user sets up a site to start building pages, he or Configuration/Connections/server-model/platform folder (where the platform is either Windows or Macintosh). - Adobe 38040334 | API Reference - Page 77
DREAMWEAVER CS3 72 API Reference For example, the default ADO connection dialog box for an ASP JavaScript document on a Windows platform is stored in the ASP_Js/Win folder and is named Connection_ado_conn_string.htm. Note: At runtime, Dreamweaver dynamically builds the list of connection types that - Adobe 38040334 | API Reference - Page 78
DREAMWEAVER CS3 73 API Reference The Connection API To create a new type of connection, contents of a file match the criteria for a valid connection, findConnection() returns a connection object. Dreamweaver then lists all the connection objects in the Database Explorer panel. When the user opens a - Adobe 38040334 | API Reference - Page 79
DREAMWEAVER CS3 74 API Reference Property name type string dsn driver username password designtimeString designtimeDsn designtimeDriver designtimeUsername designtimePassword designtimeType usesDesigntimeInfo useHTTP includePattern variables catalog schema filename Description - Adobe 38040334 | API Reference - Page 80
DREAMWEAVER CS3 75 API Reference Description Dreamweaver calls this function to initialize the dialog box data for defining a connection when the user edits an existing connection. This process lets Dreamweaver use it. The following sections illustrate some sample include files that applyConnection - Adobe 38040334 | API Reference - Page 81
DREAMWEAVER CS3 76 API Reference ASP JavaScript The ASP and JavaScript include file should be named MyConnection1.asp, where MyConnection1 is the name of the connection. The - Adobe 38040334 | API Reference - Page 82
DREAMWEAVER CS3 77 API Reference - Adobe 38040334 | API Reference - Page 83
DREAMWEAVER CS3 78 API Reference - Adobe 38040334 | API Reference - Page 84
starts Java introspection calls for JavaBeans support. These functions get class names, methods, properties, and events from the JavaBeans, which can appear in the Dreamweaver user interface (UI). To use these JavaScript functions and let Adobe® Dreamweaver® CS3 access your JavaBeans, the JavaBeans - Adobe 38040334 | API Reference - Page 85
DREAMWEAVER CS3 80 API Reference MMJB.getClassesFromPackage() Availability Dreamweaver UltraDev 4. Description This function reads all the JavaBeans classes from the package. Arguments packageName.pathName • The packageName.pathName argument is the path to the package. - Adobe 38040334 | API Reference - Page 86
DREAMWEAVER CS3 81 API Reference MMJB.getIndexedProperties() Availability Dreamweaver UltraDev 4, enhanced in Dreamweaver MX. Description Introspects the JavaBeans class and returns its indexed properties, which are design patterns that behave the same way as collections. Arguments packageName. - Adobe 38040334 | API Reference - Page 87
DREAMWEAVER CS3 82 API Reference Arguments packageName.className, {packagePath} • The packageName.className an empty array. MMJB.getReadProperties() Availability Dreamweaver MX. Description Gets read-only properties for JavaBeans that support get accessor calls. Arguments packageName.className, - Adobe 38040334 | API Reference - Page 88
DREAMWEAVER CS3 83 API Reference Returns A string array of write-only properties associated with className; an error returns an empty array. - Adobe 38040334 | API Reference - Page 89
Chapter 10: The source control integration API The source control integration API lets you write shared libraries to extend the Adobe® Dreamweaver® CS3 Check In/Check Out feature using source control systems (such as Sourcesafe or CVS). Your libraries must support a minimum set of API functions for - Adobe 38040334 | API Reference - Page 90
If the source control system does not support Design Notes and the user wants to use this feature, Dreamweaver transports Design Note (MNO) files to Windows, when the user right-clicks a file, the History menu item is one of the items on the menu. If a user selects the History menu item, Dreamweaver - Adobe 38040334 | API Reference - Page 91
DREAMWEAVER CS3 86 API Reference • The name argument is the name of the connectionData, const char siteName[64] • The connectionData argument is a handle to the data that the agent wants Dreamweaver to pass to it when calling other API functions. • The siteName argument is a string that points to - Adobe 38040334 | API Reference - Page 92
integer that indicates the length of the name of the root folder. If the function returns < 0, Dreamweaver considers it an error and tries to retrieve the error message from the DLL, if supported. bool SCS_GetRootFolder() Description This function returns the name of the root folder. Arguments void - Adobe 38040334 | API Reference - Page 93
that indicates the number of items in the current folder. If the function returns < 0, Dreamweaver considers it an error and tries to retrieve the error message from the DLL, if supported. bool SCS_GetFolderList() Description This function returns a list of files and folders in the passed-in - Adobe 38040334 | API Reference - Page 94
DREAMWEAVER CS3 89 API Reference Returns A Boolean value: true if successful; false otherwise. int numItems • The connectionData argument is a pointer to the agent's data that passed into Dreamweaver during the Connect() call. • The localPathList argument is the list of local filenames or folder - Adobe 38040334 | API Reference - Page 95
DREAMWEAVER CS3 90 API Reference • The connectionData argument is a pointer to the agent's data that passed into Dreamweaver during the Connect() call. argument is a pointer to the agent's data that passed into Dreamweaver during the Connect() call. • The remotePathList argument is a list - Adobe 38040334 | API Reference - Page 96
DREAMWEAVER CS3 91 API Reference bool SCS_ItemExists() Description This function determines whether a file or folder exists on the server. Arguments void *connectionData, const char *remotePath • The connectionData argument is a pointer to the agent's data that passed into Dreamweaver during the - Adobe 38040334 | API Reference - Page 97
DREAMWEAVER CS3 92 API Reference Returns A Boolean value: true if successful; false otherwise. retrieve the error message from the DLL, if supported. bool SCS_GetNewFeatures() Description This function returns a list of menu items to add to the Dreamweaver main and context menus. For example, the - Adobe 38040334 | API Reference - Page 98
DREAMWEAVER CS3 93 API Reference • The enablerList argument is populated by the DLL; it specifies the routines in the DLL to call when Dreamweaver needs to determine whether the corresponding menu item is enabled. • The numNewFeatures argument is the number of items being added by the DLL; this - Adobe 38040334 | API Reference - Page 99
DREAMWEAVER CS3 94 API Reference • The successList argument is a list of Boolean values that are populated by the DLL to let Dreamweaver know which of the corresponding files are checked in successfully. • The numItems argument is the number of items in each list. Returns A Boolean value: true - Adobe 38040334 | API Reference - Page 100
DREAMWEAVER CS3 95 API Reference • The successList argument is a list of Boolean values that are populated by the DLL to let Dreamweaver know which returns < 0, Dreamweaver considers it an error and tries to retrieve the error message from the DLL, if supported. bool SCS_GetFileCheckoutList() - Adobe 38040334 | API Reference - Page 101
DREAMWEAVER CS3 96 API Reference int SCS_GetErrorMessageLength() Description This function returns char *remotePath • The connectionData argument is a pointer to the agent's data that passed into Dreamweaver during the Connect() call. • The remotePath argument is the remote file or folder path that - Adobe 38040334 | API Reference - Page 102
DREAMWEAVER CS3 97 API Reference Returns An integer that indicates the number of Design Notes that are associated with this file. If the function returns < 0, Dreamweaver considers it an error and tries to retrieve the error message from the DLL, if supported. int SCS_GetMaxNoteLength() Description - Adobe 38040334 | API Reference - Page 103
DREAMWEAVER CS3 98 API Reference bool SCS_SetDesignNotes() Description This function stores the key-value pairs in the meta information for the specified file or folder. This replaces the set of meta information for the file. If it is unsupported by the source control system, Dreamweaver stores - Adobe 38040334 | API Reference - Page 104
Returns A Boolean value: true if successful; false otherwise. DREAMWEAVER CS3 99 API Reference Enablers If the optional enablers are not supported by the source control system or the application is not connected to the server, Dreamweaver determines when the menu items are enabled, based on the - Adobe 38040334 | API Reference - Page 105
DREAMWEAVER CS3 100 API Reference • The connectionData argument is a pointer to the agent's data that passed into Dreamweaver during the Connect() call. • The remotePathList argument is a list of remote filenames or folder paths to check out. • The localPathList argument is a mirrored list of - Adobe 38040334 | API Reference - Page 106
DREAMWEAVER CS3 101 API Reference bool SCS_CanUndoCheckout() Description This function returns whether the *remotePath • The connectionData argument is a pointer to the agent's data that passed into Dreamweaver during the Connect() call. • The remotePath argument is a list of remote filenames or - Adobe 38040334 | API Reference - Page 107
DREAMWEAVER CS3 102 API Reference Returns A Boolean value: true if successful; false renamed. Returns A Boolean value: true if successful; false otherwise. bool SCS_BeforeGet() Description Dreamweaver calls this function before getting or checking out one or more files. This function lets your - Adobe 38040334 | API Reference - Page 108
DREAMWEAVER CS3 103 API Reference • The *connectionData argument is a pointer to the agent's data that passed into Dreamweaver during the Connect() call. Returns A Boolean value: true if successful; false otherwise. Example To get a group of files, Dreamweaver makes calls to the DLL in the following - Adobe 38040334 | API Reference - Page 109
Adobe® Dreamweaver® CS3 interaction with other applications or Dreamweaver operations independent of individual documents (setting preferences, exiting Dreamweaver functions handle operations that are related to applications, such as Adobe® Flash®, and to the browsers and external editors that are - Adobe 38040334 | API Reference - Page 110
DREAMWEAVER CS3 105 API Reference Note: Some browsers cannot locate the file if the URL contains an anchor, such as "Configuration/ExtensionHelp/browseHelp.htm#helpyou". • The browser argument, which was added in Dreamweaver 3, specifies a browser. This argument can be the name of a browser, as - Adobe 38040334 | API Reference - Page 111
DREAMWEAVER CS3 106 API Reference dreamweaver.getExtensionEditorList() Availability Dreamweaver Adobe/Fireworks 3/Fireworks 3.exe" dreamweaver.getExternalTextEditor() Availability Dreamweaver path. dreamweaver.getFlashPath() Availability Dreamweaver MX. Description Gets the full path to the Flash MX - Adobe 38040334 | API Reference - Page 112
DREAMWEAVER CS3 107 API Reference Returns An array that contains two elements. Element [0] is a string that contains the name of the Flash MX editor. Element [1] is a string that contains the path to the Flash application on the local computer, which is expressed as a file:// URL. If Flash is not - Adobe 38040334 | API Reference - Page 113
DREAMWEAVER CS3 108 API Reference dreamweaver.getSecondaryBrowser() Availability Dreamweaver 3. Description Gets the path to , the following XML code maps the book ID for Dreamweaver Help to the filenames that contains help on both the Windows and Macintosh operating systems: - Adobe 38040334 | API Reference - Page 114
DREAMWEAVER CS3 109 API Reference The help.map file maps a help content ID to a specific help book. Dreamweaver uses the help. js file maps a help content ID to an HTML page in a specific help book. Dreamweaver uses the helpDoc.js file when it calls help from JavaScript. Arguments bookID • The bookID - Adobe 38040334 | API Reference - Page 115
:// URL. • The appURL argument is the path to the application with which to open the file, which is expressed as a file:// URL. Returns Nothing. dreamweaver.validateFlash() Availability Dreamweaver MX. Description Determines whether Flash MX (or a later version) is installed on the local computer. - Adobe 38040334 | API Reference - Page 116
111 API Reference Arguments None. Returns A Boolean value: true if Flash MX (or a later version) is installed on the local computer; false otherwise. dom.insertFiles() Availability Dreamweaver CS3. Description Inserts one or more files into the current document at the current insertion point or in - Adobe 38040334 | API Reference - Page 117
name of the file to print, expressed as a URL. Returns Nothing dreamweaver.revealDocument() Availability Dreamweaver CS3. Description Gives Dreamweaver the operating-system focus and, if the specified file is open in Dreamweaver, brings it to the foreground. Arguments: fileName fileName is a string - Adobe 38040334 | API Reference - Page 118
DREAMWEAVER CS3 113 API Reference beep(){ if(confirm("Is your order complete?") { dreamweaver.beep(); alert("Click OK to submit your order"); } } dreamweaver.getShowDialogsOnInsert() Availability Dreamweaver 3. Description Checks whether the Show Dialog When Inserting Objects option is turned on in - Adobe 38040334 | API Reference - Page 119
DREAMWEAVER CS3 114 API Reference dreamweaver.showDynamicDataDialog() Availability Dreamweaver UltraDev 1. Description they appear exactly as when the user clicked OK to create this string. Dreamweaver passes this string to the inspectDynamicDataRef() function to determine if the string matches - Adobe 38040334 | API Reference - Page 120
DREAMWEAVER CS3 115 API Reference dreamweaver.showPreferencesDialog() Availability Dreamweaver 3. Added the strCategory argument in Dreamweaver . The function shows the Tag Chooser dialog box on top of all other Dreamweaver windows. If the dialog box is not visible, the function opens it, brings - Adobe 38040334 | API Reference - Page 121
causes the system to beep once every 5 seconds: dw.registerIdleHandler("acme_beep_task", function() { dw.beep();}, 5); dw.revokeIdleHandler() Availability Dreamweaver CS3. Description This function removes an idle task previously spawned by the registerIdleHandler()function. The intention is to - Adobe 38040334 | API Reference - Page 122
Send the script to bridge and give it 10 sec to launch before assuming an error. bt.target = "bridge"; bt.body = script; result = bt.send(10); } if (result) BridgeTalk.bringToFront('bridge'); Bridgetalk.send() Availability Dreamweaver CS3. Description Establishes communications with the Bridge - Adobe 38040334 | API Reference - Page 123
= success, False = fail). Example result = bridgeTalk.send(10); BridgeTalk.suppressStartupScreen() Availability Dreamweaver CS3. Description Searches the launch options for -nostartupscreen to determine whether to suppressthe modal windows after startup. Returns A Boolean value indicating whether to - Adobe 38040334 | API Reference - Page 124
create or operate on an element of the Adobe® Dreamweaver® CS3 workspace. They perform tasks such as redoing steps Menu functions" on page 136 • "Results window functions" on page 138 • "Toggle functions" on page 149 • "Toolbar functions" on page 168 • "Window functions" on page 173 • "Code collapse - Adobe 38040334 | API Reference - Page 125
.getRedoText() Availability Dreamweaver 3. Description Gets the text that is associated with the editing operation that will be redone if the user selects Edit > Redo or presses Control+Y (Windows) or Command+Y (Macintosh). Arguments None. Returns A string that contains the text that is associated - Adobe 38040334 | API Reference - Page 126
in the active document. Arguments None. Returns Nothing. Enabler See "dreamweaver.canPlayRecordedCommand()" on page 449. dreamweaver.redo() Availability Dreamweaver 3. Description Redoes the step that was most recently undone in the active Document window, dialog box, floating panel, or Site panel. - Adobe 38040334 | API Reference - Page 127
DREAMWEAVER CS3 122 API Reference Arguments None. Returns Nothing. Enabler See "dreamweaver.canRedo()" on page 449. dreamweaver.startRecording() Availability Dreamweaver 3. Description Starts recording steps in the active document; the previously recorded command is immediately discarded. Arguments - Adobe 38040334 | API Reference - Page 128
DREAMWEAVER CS3 123 API Reference Description Undoes the previous step in the Document window, dialog box, floating panel, or Site panel that has focus. Arguments None. Returns Nothing. Enabler See "dom.canUndo()" on page 444. dreamweaver.historyPalette.clearSteps() Availability Dreamweaver 3. - Adobe 38040334 | API Reference - Page 129
DREAMWEAVER CS3 124 API Reference dreamweaver.historyPalette.getSelectedSteps() Availability Dreamweaver 3. Description Determines which portion of the History panel is selected. Arguments None. Returns An array that contains the position indices of all the selected steps. - Adobe 38040334 | API Reference - Page 130
DREAMWEAVER CS3 125 API Reference Arguments arrayOfIndices • The arrayOfIndices argument following example are selected in the History panel, a call to the dreamweaver.historyPalette.getStepsAsJavaScript(dw.historyPalette.getSelectedSteps()) function returns "dw.getDocumentDOM().insertText('Hey - Adobe 38040334 | API Reference - Page 131
DREAMWEAVER CS3 126 API Reference • The arrayOfIndices argument is an array of position indices in the History panel. Returns A string that contains the JavaScript that corresponds to the specified history steps. Example A call to dreamweaver.historyPalette.replaySteps([0,2,3]) function plays the - Adobe 38040334 | API Reference - Page 132
DREAMWEAVER CS3 127 API Reference dreamweaver.historyPalette.setSelectedSteps([0,1,2]); dreamweaver.historyPalette.setUndoState() Availability Dreamweaver Dreamweaver MX 2004. Description Inserts a specified Flash element (SWC file) into the current document. This function assumes that the Flash - Adobe 38040334 | API Reference - Page 133
DREAMWEAVER CS3 128 API Reference dreamweaver.objectPalette.getMenuDefault() Availability Dreamweaver MX 2004. Description the Flash object as the default object for the Media menu: dw.objectPalette.setMenuDefault("DW_Media", "DW_Flash"); dreamweaver.reloadObjects() Availability Dreamweaver - Adobe 38040334 | API Reference - Page 134
region of a template instance. Example if( !dom.convertActiveContent(true) ) { alert(dw.loadString("ActiveContent/notAllConverted")); } dom.convertNextActiveContent() Availability Dreamweaver CS3. Description Specifies that the next object tag that is inserted (for the remainder of the current edit - Adobe 38040334 | API Reference - Page 135
DREAMWEAVER CS3 130 API Reference Example dom.convertNextActiveContent(); dom.insertHTML(" - Adobe 38040334 | API Reference - Page 136
DREAMWEAVER CS3 131 API Reference • The bShiftIsDown argument, which is optional, is a Boolean value that indicates whether to extend the selection. If this argument is omitted, the default is false. Returns Nothing. dom.arrowRight() Availability Dreamweaver 3. Description Moves the insertion point - Adobe 38040334 | API Reference - Page 137
DREAMWEAVER CS3 132 API Reference Description This function is equivalent to pressing the that is, after the last visible content in the Document window or after the closing HTML tag in the Code inspector, depending on which window has focus). Arguments {bShiftIsDown} • The bShiftIsDown argument, - Adobe 38040334 | API Reference - Page 138
DREAMWEAVER CS3 133 API Reference dom.endOfLine() Availability Dreamweaver 3. Description Moves the insertion point to the end of is omitted, the default is false. Returns Nothing. dom.nextWord() Availability Dreamweaver 3. Description Moves the insertion point to the beginning of the next word or - Adobe 38040334 | API Reference - Page 139
DREAMWEAVER CS3 134 API Reference • The bShiftIsDown argument, which is optional, is a Boolean value that indicates whether to extend the selection. If this argument is omitted, the default is false. Returns Nothing. dom.pageDown() Availability Dreamweaver 3. Description Moves the insertion point - Adobe 38040334 | API Reference - Page 140
DREAMWEAVER CS3 135 API Reference Description Moves the insertion point to the beginning that is, before the first visible content in the Document window, or before the opening HTML tag in the Code inspector, depending on which window has focus). Arguments {bShiftIsDown} • The bShiftIsDown argument, - Adobe 38040334 | API Reference - Page 141
DREAMWEAVER CS3 136 API Reference Returns Nothing. dom.startOfLine() Availability Dreamweaver 3. Description Moves the insertion point to the beginning of the line. Arguments {bShiftIsDown} • The bShiftIsDown argument, which is optional, is a Boolean value that indicates whether - Adobe 38040334 | API Reference - Page 142
DREAMWEAVER CS3 137 API Reference dreamweaver.getMenuNeedsUpdating() Availability Dreamweaver 3. Description Checks whether the specified whether the menu needs to be updated. This function returns false only if dreamweaver.notifyMenuUpdated() has been called with this menuId, and the return value of - Adobe 38040334 | API Reference - Page 143
DREAMWEAVER CS3 138 API Reference Results window functions Results window functions let you interact with the built-in panels in the Results panel group or create a stand-alone window does not support the function, calling it has no effect. dreamweaver.showResults() Availability Dreamweaver MX 2004. - Adobe 38040334 | API Reference - Page 144
DREAMWEAVER CS3 139 API them in the specified window (floaterName) of the Results panel. Otherwise, it opens the Browser Compatibility Check window of the Results to use. To display a built-in icon, use a value "1" through "10" instead of the fully qualified path for the icon (use "0" for no icon - Adobe 38040334 | API Reference - Page 145
DREAMWEAVER CS3 140 API Reference • The strDesc argument is the description that goes Returns Nothing. Enabler See "dreamweaver.resultsPalette.canClear()" on page 456. dreamweaver.resultsPalette.Copy() Availability Dreamweaver MX. Description Sends a copied message to the window that is in focus ( - Adobe 38040334 | API Reference - Page 146
DREAMWEAVER CS3 141 API Reference Description Sends a cut message to the window in focus (often used for the FTP logging window). Arguments None. Returns Nothing. Enabler See "dreamweaver.resultsPalette.canCut()" on page 457. dreamweaver.resultsPalette.Paste() Availability Dreamweaver MX. - Adobe 38040334 | API Reference - Page 147
DREAMWEAVER CS3 142 API Reference dreamweaver.resultsPalette.openInEditor() Availability Dreamweaver MX. dreamweaver.resultsPalette.canOpenInEditor()" on page 458. dreamweaver.resultsPalette.save() Availability Dreamweaver MX. Description Opens the Save dialog box for a window that supports - Adobe 38040334 | API Reference - Page 148
DREAMWEAVER CS3 143 API Reference Enabler See "dreamweaver.resultsPalette.canSelectAll()" on page 459. Creating a stand-alone results window The dreamweaver.createResultsWindow() function, creates a results window. dreamweaver.createResultsWindow() Availability Dreamweaver "1" through "10" instead of - Adobe 38040334 | API Reference - Page 149
DREAMWEAVER CS3 144 API Reference • The itemData argument is a string you can use window. var resWin = dw.createResultsWindow("Test Window", ["Frodo", "Sam", "Gollum"]); resWin.addItem(resWin, "3", "Description", null, null, null, ["msg1", "msg2", "msg3"]); resWin.getItem() Availability Dreamweaver - Adobe 38040334 | API Reference - Page 150
the way the commandButtons() function works for commands. Only two buttons can be set in the window. Returns Nothing. resWin.setCallbackCommands() Availability Dreamweaver 4. Description Tells the Results window on which commands to call the processFile() method. If this function is not called, the - Adobe 38040334 | API Reference - Page 151
DREAMWEAVER CS3 146 API Reference • The arrCmdNames argument is an array of command names on which to call the processFile() function. Returns Nothing. resWin.setColumnWidths() Availability Dreamweaver resWin.setFileList() Availability Dreamweaver 4. Description Gives the Results window a list of - Adobe 38040334 | API Reference - Page 152
Availability Dreamweaver 4. Description Sets the title of the window. Dreamweaver 4. Description Starts processing the file. Arguments None. Returns Nothing. resWin.stopProcessing() Availability Dreamweaver 4. Description Stops processing the file. Arguments None. Returns Nothing. DREAMWEAVER CS3 - Adobe 38040334 | API Reference - Page 153
DREAMWEAVER CS3 148 API Reference Server debugging Dreamweaver can request files from ColdFusion and display the response in its embedded browser. When the response returns from the server, Dreamweaver searches the response for a packet of XML that has a known signature. If Dreamweaver finds XML - Adobe 38040334 | API Reference - Page 154
DREAMWEAVER CS3 149 API Reference path line number start position end position Path of the file Toggle functions get and set various options either on or off. dom.getEditNoFramesContent() Availability Dreamweaver 3. Description This function gets the current state of the Modify > Frameset > Edit - Adobe 38040334 | API Reference - Page 155
turns on the Prevent Layer Overlaps option; false otherwise. dom.getShowAutoIndent() Availability Dreamweaver 4. Description This function determines whether auto-indenting is on in the Code view of the document window. Arguments None. Returns A Boolean value: true if auto-indenting is on; false - Adobe 38040334 | API Reference - Page 156
frame borders are visible; false otherwise. dom.getShowGrid() Availability Dreamweaver 3. Description This function gets the current state of the View the grid is visible; false otherwise. dom.getShowHeadView() Availability Dreamweaver 3. Description This function gets the current state of the View - Adobe 38040334 | API Reference - Page 157
DREAMWEAVER CS3 152 API Reference Description This function determines whether invalid HTML code is currently highlighted in the Code view of the document window. Arguments None. Returns A Boolean value: true if invalid HTML code is highlighted; false otherwise. dom.getShowImageMaps() Availability - Adobe 38040334 | API Reference - Page 158
DREAMWEAVER CS3 153 API Reference Returns A Boolean value: true indicates the layer borders are visible; false otherwise. dom.getShowLineNumbers() Availability Dreamweaver Dreamweaver 4. Description This function determines whether syntax coloring is on in the Code view of the document window. - Adobe 38040334 | API Reference - Page 159
DREAMWEAVER CS3 154 API Reference dom.getShowTableBorders() Availability Dreamweaver getShowToolbar() Availability Dreamweaver 4. Description dom.getShowTracingImage() Availability Dreamweaver 3. Description This dom.getShowWordWrap() Availability Dreamweaver 4. Description This function determines - Adobe 38040334 | API Reference - Page 160
DREAMWEAVER CS3 155 API Reference Arguments None. Returns A Boolean value: true if word wrap is on; false otherwise. dom.getSnapToGrid() Availability Dreamweaver 3. Description This function gets the current state of the View > Grid > Snap To option. Arguments None. Returns A Boolean value: true - Adobe 38040334 | API Reference - Page 161
DREAMWEAVER CS3 156 API Reference Arguments bSet • The bSet argument is a Boolean value: true hides visual aids; false otherwise. Returns Nothing. dom.setPreventLayerOverlaps() Availability Dreamweaver 3. Description This function toggles the Prevent Layer Overlaps option on and off. Arguments - Adobe 38040334 | API Reference - Page 162
Content option; false turns it off. Returns Nothing. dom.setShowInvalidHTML() Availability Dreamweaver 4. Description This function turns highlighting of invalid HTML code on or off in the Code view of the document window. This function determines whether invalid HTML code is currently highlighted - Adobe 38040334 | API Reference - Page 163
DREAMWEAVER CS3 158 API Reference Arguments bShowImageMaps • The bShowImageMaps argument is a Boolean value, true turns on the Image Maps option; false turns it off. Returns Nothing. dom.setShowInvisibleElements() Availability Dreamweaver Availability Dreamweaver 3. Availability Dreamweaver 4. - Adobe 38040334 | API Reference - Page 164
on the Show option; false turns it off. Returns Nothing. dom.setShowSyntaxColoring() Availability Dreamweaver 4. Description This function turns syntax coloring on or off in the Code view of the document window. Arguments bShow • The bShow argument is a Boolean value: true indicates that syntax - Adobe 38040334 | API Reference - Page 165
on the Show option; false turns it off. Returns Nothing. dom.setShowWordWrap() Availability Dreamweaver 4. Description This function toggles the Word Wrap option off or on in the Code view of the document window. Arguments bShow • The bShow argument is a Boolean value: true indicates that the lines - Adobe 38040334 | API Reference - Page 166
DREAMWEAVER CS3 161 API Reference Returns Nothing. dom.setSnapToGrid() Availability Dreamweaver 3. Description This function toggles the View > Grid > Snap To option on or off. Arguments bSnapToGrid • The bSnapToGrid argument is a Boolean value: true turns on the - Adobe 38040334 | API Reference - Page 167
CS3 162 API Reference dreamweaver.htmlInspector.getShowAutoIndent() Availability Dreamweaver 4. Description This function determines whether the Auto Indent option is on in the Code inspector. Arguments None. Returns A Boolean value: true if auto-indenting is on; false otherwise. dreamweaver - Adobe 38040334 | API Reference - Page 168
DREAMWEAVER CS3 163 API Reference Arguments None. Returns A Boolean value: true if syntax coloring is on; false otherwise. dreamweaver.htmlInspector.getShowWordWrap() Availability Dreamweaver 4. Description This function determines whether the Word Wrap is on in the Code inspector. Arguments None. - Adobe 38040334 | API Reference - Page 169
DREAMWEAVER CS3 164 API Reference Returns Nothing. dreamweaver.htmlInspector.setShowLineNumbers() Availability Dreamweaver 4. Description This function shows or hides the line numbers in the Code view of the Code inspector. Arguments bShow • The bShow argument is a Boolean value: - Adobe 38040334 | API Reference - Page 170
DREAMWEAVER CS3 165 API Reference Returns Nothing. dreamweaver.setHideAllFloaters() Availability Dreamweaver 3. Description This function sets either the Hide Panels option or the Show Panels option. Arguments bShowFloatingPalettes • The bShowFloatingPalettes argument is a Boolean value: true turns - Adobe 38040334 | API Reference - Page 171
DREAMWEAVER CS3 166 API Reference site.getShowHiddenFiles() Availability Dreamweaver 3. Description This function gets the current are visible in the site map; false otherwise. site.getShowPageTitles() Availability Dreamweaver 3. Description This function gets the current state of the Show Page - Adobe 38040334 | API Reference - Page 172
DREAMWEAVER CS3 167 API Reference Arguments bShowDependentFiles • The bShowDependentFiles argument is a Boolean value: true turns on the Show Dependent Files option; false turns it off. Returns Nothing. site.setShowHiddenFiles() Availability Dreamweaver 3. Description This function toggles the Show - Adobe 38040334 | API Reference - Page 173
DREAMWEAVER CS3 168 API Reference Description This function toggles the Tool Tips option on or Description This function determines whether labels for buttons are visible in the current document window. Dreamweaver always shows labels for non-button controls, if the labels are defined. Arguments - Adobe 38040334 | API Reference - Page 174
DREAMWEAVER CS3 169 API Reference Example The following example makes labels for buttons visible: var dom = dw.getDocumentDom(); if (dom.getShowToolbarIconLabels() == false) { dom.setShowToolbarIconLabels(true); } dom.getToolbarIdArray() Availability Dreamweaver MX. Description This function returns - Adobe 38040334 | API Reference - Page 175
DREAMWEAVER CS3 170 API Reference Example The following example of receiveArguments() is in a toolbar the variable label: var label = dom.getToolbarLabel("myEditbar"); dom.getToolbarVisibility() Availability Dreamweaver MX. Description This function returns a Boolean value that indicates whether the - Adobe 38040334 | API Reference - Page 176
DREAMWEAVER CS3 171 API Reference Returns A Boolean value: true if the toolbar is visible, false if the toolbar is not visible or does not exist. Example The following example checks whether the toolbar myEditbar is visible in the document window, and then stores that value in the retval variable: - Adobe 38040334 | API Reference - Page 177
top is the default position. The toolbar appears at the top of the document window. • below makes the toolbar appear at the beginning of the row immediately below the toolbar that relative_to specifies. Dreamweaver reports an error if the toolbar does not find the toolbar that relative_to specifies - Adobe 38040334 | API Reference - Page 178
DREAMWEAVER CS3 173 API Reference Description This function shows or hides the specified the functions in this section operate only on Windows. The description of a function indicates whether this is the case. dom.getFocus() Availability Dreamweaver 3. Description This function determines the part of - Adobe 38040334 | API Reference - Page 179
DREAMWEAVER CS3 174 API Reference • The "body" string if the BODY or NOFRAMES area is TITLE tags in the document, or nothing, if the document is not in an open window. dom.setView() Availability Dreamweaver 4. Description This function shows or hides the Design or Code view to produce a design-only - Adobe 38040334 | API Reference - Page 180
Nothing. Example The following example opens and flashes the Assets panel: dw.bringAttentionToFloater("library"); dreamweaver.cascade() Availability Dreamweaver MX (Windows only), Dreamweaver 8 (added Macintosh support). Description Cascades the document windows, starting in the upper left corner - Adobe 38040334 | API Reference - Page 181
DREAMWEAVER CS3 176 API Reference Description This function gets the document in the active window. Arguments None. Returns The document object that corresponds to the document in the active window; or, if the document is in a frame, the document object that corresponds to the frameset. dreamweaver. - Adobe 38040334 | API Reference - Page 182
DREAMWEAVER CS3 177 API Reference CSS Styles = "css styles" Frames = "frames" History = "history" Insert bar = "objects" Layers = "layers" Library = "library" Link Checker has focus; false otherwise. Returns One of the following strings: • The "document" string if the document window is in focus - Adobe 38040334 | API Reference - Page 183
DREAMWEAVER CS3 178 API Reference • The "site" string if the Site panel is in focus • The " 10 pixels; 0 indicates that the Snap feature is off. dreamweaver.minimizeRestoreAll() Availability Dreamweaver 4. Description This function minimizes (reduces to an icon) or restores all windows in Dreamweaver - Adobe 38040334 | API Reference - Page 184
DREAMWEAVER CS3 179 API Reference • The bMinimize argument is a Boolean value: true if windows should be minimized; false if the minimized windows should be restored. Returns Nothing. dreamweaver.setActiveWindow() Availability Dreamweaver 3. Description This function activates the window that - Adobe 38040334 | API Reference - Page 185
DREAMWEAVER CS3 180 API Reference Code inspector = "html" Components = "server components" CSS Styles = "css styles" Frames = " to make the floating panel visible. Returns Nothing. dreamweaver.setPrimaryView() Availability Dreamweaver 4. Description This function displays the specified view at the - Adobe 38040334 | API Reference - Page 186
and gives it focus. Arguments None. Returns Nothing. dreamweaver.tileHorizontally() Availability Dreamweaver MX (Windows only), Dreamweaver 8 (added Macintosh support). Description Tiles the document windows horizontally, positioning each window next to another one without overlapping the documents - Adobe 38040334 | API Reference - Page 187
DREAMWEAVER CS3 182 API Reference Returns Nothing. Example The following example tiles the open documents horizontally: dw.tileHorizontally() dreamweaver.tileVertically() Availability Dreamweaver MX (Windows only), Dreamweaver 8 (added Macintosh support). Description Tiles the document window - Adobe 38040334 | API Reference - Page 188
DREAMWEAVER CS3 183 API Reference dreamweaver.updateReference() Availability Dreamweaver 4. Description This function updates in both Code view and the Cold Inspector. dom.collapseFullTag() Availability Dreamweaver 8. Description This function determines whether the selection in Code view is - Adobe 38040334 | API Reference - Page 189
DREAMWEAVER CS3 184 API Reference dom.collapseFullTagInverse() Availability Dreamweaver 8. Description This function determines to perform a smart collapse, which preserves current indenting and spacing. If false, Dreamweaver collapses the code fragments that are before the open tag and after the end - Adobe 38040334 | API Reference - Page 190
DREAMWEAVER CS3 185 API Reference dom.collapseSelectedCodeFragmentInverse() Availability Dreamweaver 8. Description This function collapses all code before and after the selected code in Code view. Arguments allowAdjustmentOfCodeFragments • The allowAdjustmentOfCodeFragments argument is a required, - Adobe 38040334 | API Reference - Page 191
DREAMWEAVER CS3 186 API Reference Description This function expands all collapsed code fragments currently has no effect, or has the same effect as a value of false. If false, Dreamweaver collapses the code that begins immediately before the opening tag and ends immediately after the ending tag, - Adobe 38040334 | API Reference - Page 192
DREAMWEAVER CS3 187 API Reference Arguments allowAdjustmentOfCodeFragments • The allowAdjustmentOfCodeFragments argument is a required, Boolean value. If true, Dreamweaver adjusts the boundaries of the code before the start tag and of the code after the end tag to perform a smart collapse, which - Adobe 38040334 | API Reference - Page 193
DREAMWEAVER CS3 188 API Reference Arguments allowAdjustmentOfCodeFragments • The allowAdjustmentOfCodeFragments argument is a required, Boolean value. If true, Dreamweaver adjusts the boundaries of the code sections before and after the current selection to perform a smart collapse, which preserves - Adobe 38040334 | API Reference - Page 194
DREAMWEAVER CS3 189 API Reference Example The following example expands all collapsed code in the current selection in the Code inspector: dreamweaver xml. dom.getOpenPathName() Availability Dreamweaver 8. Description This function gets getShowHiddenCharacters() Availability Dreamweaver 8. Description - Adobe 38040334 | API Reference - Page 195
DREAMWEAVER CS3 190 API Reference Example The following example turns off the display indicates whether to display the hidden characters. Returns Nothing. dom.source.applyComment() Availability Dreamweaver 8. Description This function inserts the text specified in the beforeText argument before the - Adobe 38040334 | API Reference - Page 196
following example makes the current selection an HTML comment: dw.getDocumentDOM().source.applyComment dom.source.refreshVariableCodeHints() Availability Dreamweaver CS3. Description Rescans the page looking for variables and corresponding class associations. This function rebuilds the color state - Adobe 38040334 | API Reference - Page 197
DREAMWEAVER CS3 192 API Reference Example The following example removes an HTML comment: dw.getDocumentDOM().source.removeComment dreamweaver.htmlInspector.getShowHiddenCharacters() Availability Dreamweaver 8. Description This function determines whether the special characters for white spaces are - Adobe 38040334 | API Reference - Page 198
Chapter 13: Site The Adobe® Dreamweaver® CS3 site functions perform operations related to managing a website. These operations include customizing a report, defining a new site, checking in and checking out files, running validation on a - Adobe 38040334 | API Reference - Page 199
DREAMWEAVER CS3 194 API Reference dreamweaver.showReportsDialog() Availability Dreamweaver 4. Description Opens the Reports has defined • Import and export site information dom.getSiteURLPrefixFromDoc() Availability Dreamweaver 8. Description This function gets the site URL prefix that is extracted - Adobe 38040334 | API Reference - Page 200
DREAMWEAVER CS3 195 API Reference dom.localPathToSiteRelative() Availability Dreamweaver 8. Description This function converts a local file path to a Inetpub\wwwroot\siteA\myFile.cfm") dom.siteRelativeToLocalPath() Availability Dreamweaver 8. Description This function converts a site-relative URI - Adobe 38040334 | API Reference - Page 201
DREAMWEAVER CS3 196 API Reference Description This function launches the file comparison tool Loads the site information for all the sites from the system registry (Windows) or the Dreamweaver Preferences file (Macintosh) into Dreamweaver. If a site is connected to a remote server when this function - Adobe 38040334 | API Reference - Page 202
DREAMWEAVER CS3 197 API Reference dreamweaver.siteSyncDialog.compare() Availability Dreamweaver 8. Description This function runs the file compare application specified in the File Compare Category of the Preferences dialog box to compare the selected files on - Adobe 38040334 | API Reference - Page 203
DREAMWEAVER CS3 198 API Reference Enabler See "dreamweaver.siteSyncDialog.canMarkGet()" on page 459. dreamweaver.siteSyncDialog.markIgnore() Availability Dreamweaver 8. Description This function changes the action for the selected items in the Site Synchronization dialog box to Ignore. Arguments - Adobe 38040334 | API Reference - Page 204
DREAMWEAVER CS3 199 API Reference Returns Nothing. Enabler See "dreamweaver.siteSyncDialog.canMarkSynced()" on page 460. dreamweaver.siteSyncDialog.toggleShowAllFiles() Availability Dreamweaver 8. Description This function lets you see which files Dreamweaver thinks are the same on the remote and - Adobe 38040334 | API Reference - Page 205
DREAMWEAVER CS3 200 API Reference Arguments None. Returns Nothing. Enabler See "site.canAddLink()" on page 462. site.changeLinkSitewide() Availability Dreamweaver 3. Description Opens the Change Link Sitewide dialog box. Arguments None. Returns Nothing. site.changeLink() Availability Dreamweaver 3. - Adobe 38040334 | API Reference - Page 206
DREAMWEAVER CS3 201 API Reference • If the user previously selected the Don't Show selected the Don't Show Me Again option in the Dependent Files dialog box and clicked Yes, dependent files are downloaded and no dialog box appears. • If the user previously selected the Don't Show Me Again option in - Adobe 38040334 | API Reference - Page 207
DREAMWEAVER CS3 202 API Reference Arguments siteOrURL • The siteOrURL argument must be file. Returns Nothing. Enabler See "site.canCheckOut()" on page 463. site.checkTargetBrowsers() Availability Dreamweaver 3. Description Runs a target browser check on the selected files. Arguments None. Returns - Adobe 38040334 | API Reference - Page 208
DREAMWEAVER CS3 203 API Reference site.compareFiles() Availability Dreamweaver 8. Description This function launches the Diff tool their remote versions: site.compareFiles("site"); site.defineSites() Availability Dreamweaver 3. Description This function opens the Edit Sites dialog box. Arguments - Adobe 38040334 | API Reference - Page 209
DREAMWEAVER CS3 204 API Reference Arguments None. Returns Nothing. site.deployFilesToTestingServerBin() Availability Dreamweaver MX. Description Puts a specified file (or files) in the testing server's bin folder. If the current site does not have any settings defined for deploying supporting files, - Adobe 38040334 | API Reference - Page 210
DREAMWEAVER CS3 205 API Reference If the dwsync.xml file does not contain any information Arguments siteName • The siteName argument identifies the site to export. If siteName is an empty string, Dreamweaver exports the current site. Returns A Boolean value: true if the named site exists and if the - Adobe 38040334 | API Reference - Page 211
DREAMWEAVER CS3 206 API Reference Example The following example shows a sample XML file that Dreamweaver creates when you export a site: - Adobe 38040334 | API Reference - Page 212
DREAMWEAVER CS3 207 API Reference urlprefix="http://dreamweaver/kojak/" serverscripting="CFML" serverpageext="" connectionsmigrated="TRUE" useUD4andUD5pages="TRUE" defaultdoctype="" accesstype="ftp" host="dreamweaver box and clicked Yes, dependent files are downloaded and no dialog box appears. • If - Adobe 38040334 | API Reference - Page 213
DREAMWEAVER CS3 208 API Reference Arguments siteOrURL • The siteOrURL argument must single file. Returns Nothing. Enabler See "site.canGet()" on page 465. site.getAppServerAccessType() Availability Dreamweaver MX. Description Returns the access method that is used for all files on the current site's - Adobe 38040334 | API Reference - Page 214
DREAMWEAVER CS3 209 API Reference Arguments None. Returns If the access type to the application server file is local/network, this function returns a path; otherwise, this function returns an empty string. site.getAppURLPrefixForSite() Availability Dreamweaver MX. Description Gets the value of the - Adobe 38040334 | API Reference - Page 215
DREAMWEAVER CS3 210 API Reference site.getCheckOutUserForFile() Availability Dreamweaver 3. Description Gets the login and the login name returns (for example, "denise"). site.getCloakingEnabled() Availability Dreamweaver MX. Description Determines whether cloaking is enabled for the current site. - Adobe 38040334 | API Reference - Page 216
DREAMWEAVER CS3 211 API Reference Enabler See "site.canConnect()" on page 464. site.getCurrentSite() Availability Dreamweaver 3. Description Gets the Current Sites List in the Site panel. site.getFocus() Availability Dreamweaver 3. Description Determines which pane of the Site panel has focus. - Adobe 38040334 | API Reference - Page 217
DREAMWEAVER CS3 212 API Reference Arguments None. Returns A Boolean value: true if all the selected links are visible; false otherwise. site.getLocalPathToFiles() Availability Dreamweaver MX. Description Determines the path to the local files that are defined for the current site. The current site - Adobe 38040334 | API Reference - Page 218
DREAMWEAVER CS3 213 API Reference Arguments fileURL • The fileURL argument is the fully qualified is empty when the specified file does not exist in any defined site. site.getSites() Availability Dreamweaver 3. Description Gets a list of the defined sites. Arguments None. Returns An array of strings - Adobe 38040334 | API Reference - Page 219
DREAMWEAVER CS3 214 API Reference Description Creates a Dreamweaver site from an XML file. During import, if the folder that is specified by the localroot attribute of the element does not exist on the local computer, Dreamweaver prompts for a different local root folder. Dreamweaver - Adobe 38040334 | API Reference - Page 220
DREAMWEAVER CS3 215 API Reference site.locateInSite() Availability Dreamweaver 3. Description Locates the specified file (or . Enabler See "site.canLocateInSite()" on page 465. site.makeEditable() Availability Dreamweaver 3. Description Turns off the read-only flag on the selected files. Arguments - Adobe 38040334 | API Reference - Page 221
466. site.makeNewFolder() Availability Dreamweaver 3. Description Creates a new canMakeNewFileOrFolder()" on page 466. site.newHomePage() Availability Dreamweaver 3. Description Opens the New Home Page dialog newSite() Availability Dreamweaver 3. Description Opens the Site Definition dialog box for a - Adobe 38040334 | API Reference - Page 222
DREAMWEAVER CS3 217 API Reference Returns Nothing. site.open() Availability Dreamweaver 3. Description Opens the Returns Nothing. Enabler See "site.canOpen()" on page 466. site.put() Availability Dreamweaver 3. Description Puts the selected files and handles dependent files in one of the following - Adobe 38040334 | API Reference - Page 223
DREAMWEAVER CS3 218 API Reference site.recreateCache() Availability Dreamweaver 3. Description Re-creates the cache for the current site. Arguments None. Returns Nothing. Enabler See "site.canRecreateCache()" on page 467. site.refresh() Availability Dreamweaver 3. Description Refreshes the file - Adobe 38040334 | API Reference - Page 224
DREAMWEAVER CS3 219 API Reference Returns A Boolean value that indicates whether a remote site has been defined and, if the server type is Local/Network, whether the drive is mounted. site.removeLink() Availability Dreamweaver 3. Description Removes the selected link from the document above it in - Adobe 38040334 | API Reference - Page 225
DREAMWEAVER CS3 220 API Reference Returns Nothing. site.saveAsImage() Availability Dreamweaver 3. Description Opens the Save As dialog box to let the user save the site map as an image. Arguments fileType • The fileType argument is the type of image that should be saved. Valid values for Windows are - Adobe 38040334 | API Reference - Page 226
DREAMWEAVER CS3 221 API Reference site.selectNewer() Availability Dreamweaver 3. Description Selects all files that are newer on server interaction. Arguments None. Returns A Boolean value that indicates whether Dreamweaver is currently interacting with a server. Example The following example, from - Adobe 38040334 | API Reference - Page 227
DREAMWEAVER CS3 222 API Reference Arguments None. Returns Nothing. site.setCloakingEnabled() Availability Dreamweaver MX. Description Determines whether cloaking should be enabled for the current site. Arguments enable • The enable argument is a Boolean value that indicates whether cloaking should - Adobe 38040334 | API Reference - Page 228
DREAMWEAVER CS3 223 API Reference • The whichSite argument is the name of a defined the following strings: "local", "remote", or "site map". Returns Nothing. site.setLayout() Availability Dreamweaver 3. Description Opens the Site Map Layout pane in the Site Definition dialog box. Arguments None. - Adobe 38040334 | API Reference - Page 229
DREAMWEAVER CS3 224 API Reference Description Shows or hides the current link. Arguments bShow • The bShow argument is a Boolean value that indicates whether to remove the Hidden designation from the current link. Returns Nothing. site.setSelection() Availability Dreamweaver 3. Description Selects - Adobe 38040334 | API Reference - Page 230
DREAMWEAVER CS3 225 API Reference returns "C:\Inetpub\wwwroot\siteA\myFile.xml" based on your site mappings and HTTP address specified in the Local info of the Site Definition dialog box. site.synchronize() Availability Dreamweaver 3. Description Opens the Synchronize Files dialog box. Arguments - Adobe 38040334 | API Reference - Page 231
DREAMWEAVER CS3 226 API Reference Description Uncloaks all folders in the current site and deselects the Cloak Files Ending With: checkbox in the Cloaking settings. Arguments None. Returns Nothing. Enabler See "site.canUncloak()" on page 469. site.undoCheckOut() Availability Dreamweaver 3. - Adobe 38040334 | API Reference - Page 232
Chapter 14: Document The Document functions in Adobe® Dreamweaver® CS3 perform operations that affect the document on which the user is working. These functions perform tasks that convert tables to layers, run a command in the - Adobe 38040334 | API Reference - Page 233
DREAMWEAVER CS3 228 API Reference dom.convertLayersToTable() Availability Dreamweaver 3. Description Opens the Convert Layers to Table dialog box. Arguments None. Returns Nothing. Enabler See "dom.canConvertLayersToTable()" on page 437. dom.convertTablesToLayers() Availability Dreamweaver 3. - Adobe 38040334 | API Reference - Page 234
DREAMWEAVER CS3 229 API Reference Arguments None. Returns Nothing. dreamweaver.popupCommand() (deprecated) Availability Dreamweaver 2; deprecated in 3 in favor of "dreamweaver.runCommand()" on page 229. Description This function executes the specified command. To the user, the effect is the same as - Adobe 38040334 | API Reference - Page 235
DREAMWEAVER CS3 230 API Reference Example You can write a custom Property inspector for tables that lets users get to the Format Table command from a button on the inspector by calling the following function from the button's onClick event handler: function callFormatTable(){ dreamweaver.runCommand - Adobe 38040334 | API Reference - Page 236
DREAMWEAVER CS3 231 API Reference Description Parses the HTML into a DOM tree, inserts . Arguments None. Returns An array of six integers that quantify the following items: • XHTML errors that Dreamweaver fixed • The map elements that do not have an id attribute and cannot be fixed • The script - Adobe 38040334 | API Reference - Page 237
DREAMWEAVER CS3 232 API Reference Arguments None. Returns A true value if the document is XHTML; false otherwise. dreamweaver.browseForFileURL() Availability Dreamweaver 1, enhanced in 2, 3, and 4. Description Opens the specified type of dialog box with the specified label in the title bar. - Adobe 38040334 | API Reference - Page 238
DREAMWEAVER CS3 233 API Reference • The titleBarLabel argument is the label that should 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 - Adobe 38040334 | API Reference - Page 239
the same window or in a new window. The new document becomes the active document. It is similar to the dreamweaver.createDocument() function. When Dreamweaver creates XHTML document, by default, Dreamweaver uses it (for both new and converted documents). Users can manually delete the directive. The - Adobe 38040334 | API Reference - Page 240
DREAMWEAVER CS3 235 API Reference • The bOpenInSameWindow argument is a Boolean value that indicates whether to open the new document in the current window. If this value is false or omitted, or if the function is called on the Macintosh, the new document opens in a separate window. Returns The - Adobe 38040334 | API Reference - Page 241
DREAMWEAVER CS3 236 API Reference Description This function opens the Export Editable Regions as XML dialog box. Arguments None. Returns Nothing. dreamweaver.exportTemplateDataAsXML() Availability Dreamweaver MX. Description Exports the current document to the specified file as XML. This function - Adobe 38040334 | API Reference - Page 242
DREAMWEAVER CS3 237 API Reference • The sourceDoc argument must be "document", "parent", "parent.frames[number 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 - Adobe 38040334 | API Reference - Page 243
DREAMWEAVER CS3 238 API Reference Example The following code returns the DOM for a new, empty document: var theDOM = dreamweaver.getNewDocumentDOM(); dreamweaver.getRecentFileList() Availability Dreamweaver 3. Description Gets a list of all the files in the recent files list at the bottom of the - Adobe 38040334 | API Reference - Page 244
or false, that indicates whether to maintain the link to the original template. Returns Nothing. dreamweaver.openDocument() Availability Dreamweaver 2. Description Opens a document for editing in a new Dreamweaver window and gives it the focus. For a user, the effect is the same as selecting File - Adobe 38040334 | API Reference - Page 245
DREAMWEAVER CS3 240 API Reference dreamweaver.openDocumentFromSite() Availability Dreamweaver 3. Description Opens a document for editing in a new Dreamweaver window and gives it the focus. For a user, the effect is the same as double-clicking a file in the Site panel. If the specified file is - Adobe 38040334 | API Reference - Page 246
that were referenced by a URL, are not currently open in a frame or document window, and are not extension files. Extension files are loaded into memory at startup and are not released until you quit Dreamweaver. Arguments documentObject • The documentObject argument is the object at the root of - Adobe 38040334 | API Reference - Page 247
DREAMWEAVER CS3 242 API Reference Enabler See "dreamweaver.canSaveAll()" on page 450. dreamweaver.saveDocument() Availability Dreamweaver 2. Description Saves the specified file on a local computer. Note: In Dreamweaver 2, if the file is read-only, Dreamweaver tries to check it out. If the document - Adobe 38040334 | API Reference - Page 248
CS3 243 API Reference dreamweaver.saveDocumentAsTemplate() Availability Dreamweaver 3. Description Opens the Save As Template dialog box. Arguments documentObject, {fileName} • The documentObject argument is the object at the root of a document's DOM tree, which is the value that dreamweaver - Adobe 38040334 | API Reference - Page 249
DREAMWEAVER CS3 244 API Reference Arguments documentObject • The documentObject argument is the object at the root of a document's DOM tree, which is the value that the dreamweaver.getDocumentDOM() function returns. Returns Nothing. Enabler See "dreamweaver.canSaveFramesetAs()" on page 451. Global - Adobe 38040334 | API Reference - Page 250
DREAMWEAVER CS3 245 API Reference dom.getParseMode() Availability Dreamweaver MX 2004 Description Gets the current parsing mode of the document, which controls how the document is validated and whether it shows up in the main document window as HTML. Arguments None. Returns A string that specifies - Adobe 38040334 | API Reference - Page 251
document has not been saved, the validation will not start. If the document has been saved, Dreamweaver runs an automatic validation, does not open the Validation results window, and does not indicate the total number of errors encountered on the document toolbar: dw.getDocumentDOM().runValidation - Adobe 38040334 | API Reference - Page 252
DREAMWEAVER CS3 247 API Reference Arguments location, message, timeout • The location argument is a string that specifies forget the title for the window', 5000); See also "dom.hideInfoMessagePopup()" on page 245. dom.showPagePropertiesDialog() Availability Dreamweaver 3. Description Opens the Page - Adobe 38040334 | API Reference - Page 253
DREAMWEAVER CS3 248 API Reference Description Uses the internal Dreamweaver Dreamweaver does not return references for unnamed objects. If an object does not contain either a NAME or an ID attribute, Dreamweaver returns "unnamed ". If the browser does not support a reference by name, Dreamweaver - Adobe 38040334 | API Reference - Page 254
does not contain either a NAME or an ID attribute, Dreamweaver returns "unnamed ". If the browser does not support a reference by name, Dreamweaver references the object by index (for example, document.myform.applets[3]). • Dreamweaver does return references for named objects that are contained - Adobe 38040334 | API Reference - Page 255
DREAMWEAVER CS3 250 API Reference dreamweaver.getObjectTags() (deprecated) Availability 10" NAME="bullet">" • "" • "" dreamweaver.getPreferenceInt() Availability Dreamweaver - Adobe 38040334 | API Reference - Page 256
DREAMWEAVER CS3 251 API Reference Arguments section, key, default_value • The section that specifies the entry of the value to retrieve. • The default_value argument is the default value that Dreamweaver returns if it cannot find the entry. This value must be an unsigned integer in the range 0 - Adobe 38040334 | API Reference - Page 257
DREAMWEAVER CS3 252 API Reference dreamweaver.setPreferenceInt() Availability Dreamweaver MX. Description Lets you set an integer preference setting for an extension. This setting is stored with Dreamweaver preferences when Dreamweaver is not running. Arguments section, key, new_value • The section - Adobe 38040334 | API Reference - Page 258
DREAMWEAVER CS3 253 API Reference • The new_value argument is a string that specifies the value of the category option. Returns A true value if successful; false otherwise. Example var txtEditor = getExternalTextEditor(); dreamweaver.setPreferenceString("My Extension", "Text Editor", txtEditor); - Adobe 38040334 | API Reference - Page 259
DREAMWEAVER CS3 254 API Reference Example The following function is useful when referencing other extension files, which are stored in the Configuration folder in the Dreamweaver application folder: var sortCmd = dreamweaver.getConfigurationPath() + ¬ "/Commands/Sort Table.htm" var sortDOM = - Adobe 38040334 | API Reference - Page 260
DREAMWEAVER CS3 255 API Reference Description Gets the full path to a temporary folder where you can store temporary or transient files. This function looks for a Temp folder inside the Dreamweaver Configuration folder. If the system supports multiple users, it looks in the user's Configuration - Adobe 38040334 | API Reference - Page 261
DREAMWEAVER CS3 256 API Reference dom.getSelectedNode() Availability Dreamweaver 3. Description Gets the selected node. that completely contains the specified range of characters. dom.getSelection() Availability Dreamweaver 3. Description Gets the selection, which is expressed as character offsets - Adobe 38040334 | API Reference - Page 262
DREAMWEAVER CS3 257 API Reference Description Gets the position of a specific node must be a tag, comment, or range of text that is a node in the tree that the dreamweaver.getDocumentDOM() function returns. Returns An array that contains two integers. The first integer is the character offset of - Adobe 38040334 | API Reference - Page 263
DREAMWEAVER CS3 258 API Reference var offsets = dom.getSelection(); var theSelection = dreamweaver.offsetsToNode(offsets[0], ¬ offsets[1]); if ( is a Boolean value that indicates whether to scroll the Document window, if necessary, to make the selection visible. If it is omitted, this argument - Adobe 38040334 | API Reference - Page 264
DREAMWEAVER CS3 259 API Reference dom.setSelection() Availability Dreamweaver 3. Description Sets the selection in the document. Arguments offsetBegin, offsetEnd • These arguments are the opening and closing points, respectively, for the new selection, which is - Adobe 38040334 | API Reference - Page 265
DREAMWEAVER CS3 260 API Reference • The node argument is the node that you want to argument must be a tag, comment, or range of text that is a node in the tree that the dreamweaver.getDocumentDOM() function returns. Returns An array that contains two integers. The first integer is the byte offset for - Adobe 38040334 | API Reference - Page 266
DREAMWEAVER CS3 261 API Reference Description Gets the object in the DOM that completely contains the specified range of characters. dreamweaver.selectAll() Availability Dreamweaver 3. Description Performs a Select All operation in the active document window, the Site panel or, on the Macintosh, - Adobe 38040334 | API Reference - Page 267
DREAMWEAVER CS3 262 API Reference • These arguments are the opening and closing points, convert a string from Latin 1 encoding to platform-native encoding and back. dreamweaver.doURLEncoding() Availability Dreamweaver 1. Description Takes a string and returns a URL-encoded string by replacing - Adobe 38040334 | API Reference - Page 268
DREAMWEAVER CS3 263 API Reference • The separatorCharacters argument is the character or characters . dreamweaver.nativeToLatin1() Availability Dreamweaver 2. Description Converts a string in native encoding to Latin 1 encoding. Note: This function has no effect in Windows because Windows encodings - Adobe 38040334 | API Reference - Page 269
DREAMWEAVER CS3 264 API Reference Returns The converted string. dreamweaver.scanSourceString() Availability Dreamweaver UltraDev 1. Description Scans a function starts a callback function that you must supply. Dreamweaver supports the following callback functions: • openTagBegin() • openTagEnd() • - Adobe 38040334 | API Reference - Page 270
DREAMWEAVER CS3 265 API Reference 7 Dreamweaver calls the text() function for each span of text in the seven callback functions. 2 Write a script that calls the dreamweaver.scanSourceString() function. 3 The dreamweaver.scanSourceString() function passes a string that contains HTML and pointers to - Adobe 38040334 | API Reference - Page 271
DREAMWEAVER CS3 266 API Reference Description This function runs the specified translator on if you try to edit a locked region before specifically making it editable with this function, Dreamweaver beeps and does not allow the change. Note: Editing locked regions can have unintended consequences for - Adobe 38040334 | API Reference - Page 272
reference to an XML document, and prompt the user to specify the XML document associated with the current XSLT document. MMXSLT.getXML() Availability Dreamweaver CS3. Description Gets an XML source string for an XML file. Arguments xmlSourceURI • A string representing a URI to an XML file. It can be - Adobe 38040334 | API Reference - Page 273
:///c:/Program Files/Adobe/¬ Adobe Dreamweaver CS3/Configuration/Menus/menus.xml""); MMXSLT.getXMLSourceURI() Availability Dreamweaver 8. Description Settings/Temporary Internet Files/Content.IE5/GTSLQ9KZ/rss[1].xml) that is downloaded when the original XML file is remote (for example, http://myHost - Adobe 38040334 | API Reference - Page 274
DREAMWEAVER CS3 269 API Reference MMXSLT.launchXMLSourceDialog() Availability Dreamweaver 8. Description This function prompts the user the XML source reference is a remote reference, the function returns the downloaded filepath to the temporary location. Example The following example launches the - Adobe 38040334 | API Reference - Page 275
Chapter 15: Page content The Adobe® Dreamweaver® CS3 page content functions perform operations that affect the content of a web page. These you manage and use the elements in the Assets panel (templates, libraries, images, Adobe Shockwave and Adobe Flash content, URLs, colors, and scripts). - Adobe 38040334 | API Reference - Page 276
DREAMWEAVER CS3 271 API Reference dreamweaver.assetPalette.addToFavoritesFrom Document() Availability Dreamweaver 4. Description Adds the element that is selected in the Document window to the Favorites list. This function handles only images, Shockwave files, Flash files, text font colors, and URLs - Adobe 38040334 | API Reference - Page 277
445. dreamweaver.assetPalette.getSelectedCategory() Availability Dreamweaver 4. Description Returns the currently selected category. Arguments None. Returns The currently selected category, which can be one of the following: "templates", "library", "images", "movies", "shockwave", "flash", "scripts - Adobe 38040334 | API Reference - Page 278
DREAMWEAVER CS3 273 API Reference dreamweaver.assetPalette.getSelectedItems() Availability Dreamweaver 4. Description Returns one of the following categories: "templates", "library", "images", "movies", "shockwave", "flash", "scripts", "colors", or "urls". Note: If nothing is selected in the Assets - Adobe 38040334 | API Reference - Page 279
DREAMWEAVER CS3 274 API Reference Description Inserts selected elements or applies the element to the current selection. It applies and prompts the user for a URL and a nickname. This function is not available for images, Shockwave files, Flash files, or scripts. Arguments None. Returns Nothing. - Adobe 38040334 | API Reference - Page 280
DREAMWEAVER CS3 275 API Reference dreamweaver.assetPalette.newFolder() Availability Dreamweaver 4. Description Creates a new folder in the current category with the default name (untitled) and puts a text box around the default name. It is available only - Adobe 38040334 | API Reference - Page 281
DREAMWEAVER CS3 276 API Reference Description Removes the selected elements from the Favorites one of the following categories: "templates", "library", "images", "movies", "shockwave", "flash", "scripts", "colors", or "urls". Returns Nothing. dreamweaver.assetPalette.setSelectedView() Availability - Adobe 38040334 | API Reference - Page 282
DREAMWEAVER CS3 277 API Reference Description Switches the display to show either the Site list or the Favorites list. Arguments viewType • The viewType argument is a string that can be "site" or "favorites". Returns Nothing. dreamweaver.libraryPalette.deleteSelectedItem() (deprecated) Availability - Adobe 38040334 | API Reference - Page 283
DREAMWEAVER CS3 278 API Reference Description This function creates a new library item based on the selection in the current document. Arguments bReplaceCurrent • The bReplaceCurrent argument is a Boolean - Adobe 38040334 | API Reference - Page 284
DREAMWEAVER CS3 279 API Reference Description Returns the current font size of the Reference panel display region. Arguments None. Returns The relative font size as small, medium, or large. dreamweaver.referencePalette.setFontSize() Availability Dreamweaver 4. Description Changes the font size that - Adobe 38040334 | API Reference - Page 285
DREAMWEAVER CS3 280 API Reference Arguments None. Returns A string that contains the path of the template, which is expressed as a file:// URL. dreamweaver.templatePalette.renameSelectedTemplate() (deprecated) Availability Dreamweaver 3; deprecated in Dreamweaver 4 in favor of using "dreamweaver. - Adobe 38040334 | API Reference - Page 286
DREAMWEAVER CS3 281 API Reference • The eventBasedIndex argument, which is optional, is added after all existing actions for the specified event. Returns Nothing. dom.getBehavior() Availability Dreamweaver 3. Description Gets the action at the specified position within the specified event. This - Adobe 38040334 | API Reference - Page 287
DREAMWEAVER CS3 282 API Reference dom.removeBehavior() Availability Dreamweaver 3. Description Removes the action to edit a behavior in a timeline • When the currently executing script is started by dreamweaver.popupAction() • When the Behaviors panel is attaching an event to a link wrapper and the - Adobe 38040334 | API Reference - Page 288
DREAMWEAVER CS3 283 API Reference Example The dreamweaver.getBehaviorElement() function can be used in the same way as "dreamweaver.getBehaviorTag()" on a hypertext link (A HREF) that does not target another frame or window, you can use the getBehaviorElement() function as part of the function that - Adobe 38040334 | API Reference - Page 289
DREAMWEAVER CS3 284 API Reference Returns A string that represents the source of the user // that this action can only be applied to a // hyperlink } } dreamweaver.popupAction() Availability Dreamweaver 2. Description Starts a Parameters dialog box for the specified behavior action. To the user, - Adobe 38040334 | API Reference - Page 290
DREAMWEAVER CS3 285 API Reference dreamweaver.behaviorInspector.getBehaviorAt() Availability Dreamweaver 3. Description Gets the event/action pair the Behaviors panel displays the list, a call to the dreamweaver.behaviorInspector.getBehaviorAt(2) function returns an array that contains two strings: - Adobe 38040334 | API Reference - Page 291
DREAMWEAVER CS3 286 API Reference Description Gets the position of the selected action If the Behaviors panel is set up as shown in the following figure, calling the dreamweaver.behaviorInspector.moveBehaviorDown(2) function swaps the positions of the Preload Images and the Change Property actions - Adobe 38040334 | API Reference - Page 292
DREAMWEAVER CS3 287 API Reference dreamweaver.behaviorInspector.moveBehaviorUp() Availability Dreamweaver 3. Description Moves a behavior is set up as shown in the following figure, calling the dreamweaver.behaviorInspector.moveBehaviorUp(3) function swaps the positions of the Preload Images and - Adobe 38040334 | API Reference - Page 293
DREAMWEAVER CS3 288 API Reference dreamweaver.behaviorInspector.setSelectedBehavior() Availability Dreamweaver 3. Description dreamweaver object and as methods of the DOM object. The dreamweaver version of the function operates on the selection in the active window: the current Document window - Adobe 38040334 | API Reference - Page 294
DREAMWEAVER CS3 289 API Reference Description Copies the selection, including any HTML markup that defines the selection, to the Clipboard. Arguments None. Returns Nothing. dom.clipCopyText() Availability Dreamweaver 3. Description Copies the selected text to the Clipboard, ignoring any HTML markup. - Adobe 38040334 | API Reference - Page 295
DREAMWEAVER CS3 290 API Reference Arguments None. Returns Nothing. Enabler See "dom.canClipPaste()" on page 436. Example If the Clipboard contains ABC Widgets, a call to dw.getDocumentDOM().clipPaste() results in the following figure: dom.clipPasteText() (deprecated) Availability Dreamweaver 3. - Adobe 38040334 | API Reference - Page 296
DREAMWEAVER CS3 291 API Reference Example If the Clipboard contains return true;, a call to dw.getDocumentDOM().clipPasteText() results in the following figure: dreamweaver.clipCopy() Availability Dreamweaver 3. Description Copies the current selection from the active Document window, - Adobe 38040334 | API Reference - Page 297
DREAMWEAVER CS3 292 API Reference Returns Nothing. Enabler See "dreamweaver.canClipCut()" on page 446. dreamweaver.clipPaste() Availability Dreamweaver 3. Added the strPasteOption argument in Dreamweaver 8. Description Pastes the contents of the Clipboard into the current document, dialog box, - Adobe 38040334 | API Reference - Page 298
DREAMWEAVER CS3 293 API Reference Example If dreamweaver.getClipboardText() returns "text bold text", dreamweaver.getClipboardText(true) returns "text bold text". Library and template functions Library and template functions handle operations that are related to library items and templates, - Adobe 38040334 | API Reference - Page 299
Arguments None. Returns Nothing. dom.getAttachedTemplate() Availability Dreamweaver 3. Description Gets the path of the template that template, which is expressed as a file:// URL. dom.getEditableRegionList() Availability Dreamweaver 3. Description Gets a list of all the editable regions in the body - Adobe 38040334 | API Reference - Page 300
DREAMWEAVER CS3 295 API Reference dom.getIsLibraryDocument() Availability Dreamweaver 3. Description Determines whether the document is a library item. Arguments None. Returns A Boolean value that indicates whether the document is an LBI file. dom.getIsTemplateDocument() Availability Dreamweaver 3. - Adobe 38040334 | API Reference - Page 301
DREAMWEAVER CS3 296 API Reference var theDOM = dw.getDocumentDOM(); var edRegs = theDOM.getEditableRegionList(); var selReg = theDOM.getSelectedEditableRegion(); alert(edRegs[selReg].innerHTML); dom.insertLibraryItem() Availability Dreamweaver 3. Description Inserts an instance of a library item - Adobe 38040334 | API Reference - Page 302
DREAMWEAVER CS3 297 API Reference Returns Nothing. Enabler See "dom.canMakeNewEditableRegion()" on page 441. dom.removeEditableRegion() Availability Dreamweaver 3. Description Removes an editable region from the document. If the editable region contains any content, the content is preserved; only - Adobe 38040334 | API Reference - Page 303
DREAMWEAVER CS3 298 API Reference Arguments {typeOfUpdate} • The optional typeOfUpdate argument must be "library", "template", or "both", if you specify it. If the argument is omitted, it defaults to "both". Returns Nothing. Snippets panel functions Using Dreamweaver, web developers can edit and - Adobe 38040334 | API Reference - Page 304
DREAMWEAVER CS3 299 API Reference Attribute name description preview type Description Name the Snippets panel. Returns an empty string if no snippet is selected. dreamweaver.snippetPalette.newFolder() Availability Dreamweaver MX. Description Creates a new folder with the default name untitled and - Adobe 38040334 | API Reference - Page 305
Enabler See "dreamweaver.snippetpalette.canEditSnippet()" on page 461. dreamweaver.snippetPalette.insert() Availability Dreamweaver MX. Description Applies See "dreamweaver.snippetpalette.canInsert()" on page 461. dreamweaver.snippetPalette.insertSnippet() Availability Dreamweaver MX. Description - Adobe 38040334 | API Reference - Page 306
.snippetPalette.remove() Availability Dreamweaver MX. Description Deletes the selected element or folder from the Snippets panel and deletes the file from the disk. Returns Nothing. Spry widget editing functions Dreamweaver CS3 provides enhanced editing functions for Spry and other dynamic - Adobe 38040334 | API Reference - Page 307
DOMString. If the attribute does not have a specified or default value, this function returns an empty string. element.removeTranslatedAttribute() Availability Dreamweaver CS3. Description This function is the same as the W3C removeAttribute() function, but acts on translated attributes. The element - Adobe 38040334 | API Reference - Page 308
This function is the same as the element.ClassName() function, but acts on the translated className attribute. element.translatedStyle Availability Dreamweaver CS3. Description This function is the same as the element.style() function, but acts on the translated style attribute. Example var - Adobe 38040334 | API Reference - Page 309
accordion"); var code = "new Accordion('" + id + "',250,{duration:200,step:20})"; dom.addJavaScript(code, false); return retVal; } dom.copyAssets() Availability Dreamweaver CS3. Description An extension author can use this API to copy external dependent files to the user's site and add the necessary - Adobe 38040334 | API Reference - Page 310
= new AssetInfo("Objects/Ajax/Images", "Images", ""); assetList.push(assetInfo); dom.copyAssets(assetList); return retVal; } dom.getDefaultAssetFolder() Availability Dreamweaver CS3. Description Gets the default asset folder of the document. Arguments None. Returns A string that is the default asset - Adobe 38040334 | API Reference - Page 311
), but this filtering is not done when you use the functions outside the scope of a browser compatibility check. elem.getComputedStyleProp() Availability Dreamweaver CS3. Description Gets the value of the specified CSS property that is used to render the specified element, regardless of where the - Adobe 38040334 | API Reference - Page 312
DREAMWEAVER CS3 307 API Reference window.getDeclaredStyle() Availability Dreamweaver CS3. Description Gets ("no margin-left property has been set for myDiv."); dom.getMinDisplayWidth() Availability Dreamweaver CS3. Description Gets the minimum width required for a block-level container to display - Adobe 38040334 | API Reference - Page 313
set width."); dom.getBlockElements() elem.getBlockElements() Availability Dreamweaver CS3. Description Scans the document (or element) for can see whether width // or height have been specified explicitly dProps = window.getDeclaredStyle(blocks[i]); // if the block has children, border-left, and - Adobe 38040334 | API Reference - Page 314
j < children.length; j++){ dProps = window.getDeclaredStyle(children[j]); if (typeof(dProps.width) != "undefined" || typeof(dProps.height) != "undefined"){ hasLayout = true; break; } dom.getInlineElements() elem.getInlineElements() Availability Dreamweaver CS3. Description Scans the document (or - Adobe 38040334 | API Reference - Page 315
tagName); } dom.getListElements() elem.getListElements() Availability Dreamweaver CS3. Description Scans the document (or element) for var props = null; for (var i=0; i < lists.length; i++){ props = window.getDeclaredStyle(lists[i]); if ((props.cssFloat == "left" || props.cssFloat == "right") && - Adobe 38040334 | API Reference - Page 316
of two consecutive block elements" test. if (next && (next.nodeType == 1) && next.isBlockElement()){ // do something } } [...] elem.isInlineElement() Availability Dreamweaver CS3. Description Checks whether the element has an inherent or specified display value of 'inline'. Arguments None. Returns - Adobe 38040334 | API Reference - Page 317
if (next && (next.nodeType == Node.TEXT_NODE || (next.nodeType == Node.ELEMENT_NODE && next.isInlineElement()))){ // do something } } [...] elem.isHeaderElement() Availability Dreamweaver CS3. Description Checks whether the element is one of the following tags: h1, h2, h3, h4, h5, h6. Arguments None - Adobe 38040334 | API Reference - Page 318
= issueUtils.getFloats(DOM.body); var prev = null, children = null; for (var i=0; i < floats.length; i++){ children = floats[i].childNodes; for (var k=0; k < children.length; k++){ if (children[k].isListElement()){ // do something } } } [...] DREAMWEAVER CS3 313 API Reference - Adobe 38040334 | API Reference - Page 319
Chapter 16: Dynamic documents The dynamic documents functions in Adobe® Dreamweaver® CS3 perform operations that are related to web server pages. These operations include returning a property for the selected node in the Components panel, getting a list of - Adobe 38040334 | API Reference - Page 320
MX. Description Refreshes the view of the Components tree. Arguments None. Returns Nothing. DREAMWEAVER CS3 315 API Reference Data source functions Data source files are stored in the Configuration/DataSources folder. Each server model has its own folder: ASP.Net/C#, - Adobe 38040334 | API Reference - Page 321
be an empty string ("") if no server behavior is associated with the data source (such as a session variable). dw.dbi.setExpanded() Availability Dreamweaver CS3. Description Sets the node to be expanded or collapsed. Arguments data-source-node-name, expanded • data-source-node-name is a string - Adobe 38040334 | API Reference - Page 322
DREAMWEAVER CS3 317 API Reference dreamweaver.getExtDataValue() Availability Dreamweaver UltraDev 4. Description This function retrieves the field values from an EDML file for the specified nodes. Arguments qualifier(s) • The qualifier(s) argument is a variable-length list ( - Adobe 38040334 | API Reference - Page 323
DREAMWEAVER CS3 318 API Reference • The value argument is a property value, or it is blank and is ignored. For example dreamweaver.getExtPar- ticipants("", "participant"); • The qualifier(s) argument is a variable-length list of comma-separated node qualifiers of the required property. Returns - Adobe 38040334 | API Reference - Page 324
DREAMWEAVER CS3 319 API Reference Live data functions You can use the following live data string that contains the initialization tags. dreamweaver.getLiveDataMode() Availability Dreamweaver UltraDev 1. Description Determines whether the Live Data window is currently visible. Arguments None. Returns - Adobe 38040334 | API Reference - Page 325
DREAMWEAVER CS3 320 API Reference Description Obtains the URL parameters that are you must set these URL parameters before you view live data. You can enter Live Data settings through Dreamweaver in the following ways: • Through the Live Data Settings dialog box, which you can activate from the - Adobe 38040334 | API Reference - Page 326
DREAMWEAVER CS3 321 API Reference Description Sends an entire HTML document time, an error occurs. The dreamweaver.liveDataTranslate() function performs the following operations: • Makes the animated image (that appears near the right edge of the Live Data window) play. • Listens for user input - Adobe 38040334 | API Reference - Page 327
DREAMWEAVER CS3 322 API Reference Returns Nothing. dreamweaver.setLiveDataMode() Availability Dreamweaver UltraDev 1. Description Toggles the visibility of the Live Data window. Arguments bIsVisible • The bIsVisible argument is a Boolean value that indicates whether the Live Data window should be - Adobe 38040334 | API Reference - Page 328
Live Data Settings dialog box. Arguments None. Returns Nothing. DREAMWEAVER CS3 323 API Reference Server behavior functions Server behavior functions let you manipulate the Server Behaviors panel, which you can display by selecting Window > Server Behaviors. Using these functions, you can find all - Adobe 38040334 | API Reference - Page 329
DREAMWEAVER CS3 324 API Reference • The participantNode property is a pointer to the participant it calls the findServerBehaviors() function for each currently installed behavior. Each function returns an array. Dreamweaver merges all the arrays into a single array and sorts it, based on the order - Adobe 38040334 | API Reference - Page 330
DREAMWEAVER CS3 325 API Reference Server model functions In Dreamweaver, each document has an associated document type. For dynamic document types, Dreamweaver and whether the current server model supports a named character set (such as UTF-8). Note: Dreamweaver reads all the information in the - Adobe 38040334 | API Reference - Page 331
DREAMWEAVER CS3 326 API Reference Description Lets JavaScript code get the script A string, the value of which is the name of the server model. dom.serverModel.getFolderName() Availability Dreamweaver MX. Description Gets the name of the folder that is used for this server model in the Configuration - Adobe 38040334 | API Reference - Page 332
DREAMWEAVER CS3 327 API Reference Description Returns the default file extension of . Arguments None. Returns A string that represents the supported file extensions. dom.serverModel.getServerIncludeUrlPatterns() Availability Dreamweaver MX. Description Returns the following list of properties, - Adobe 38040334 | API Reference - Page 333
DREAMWEAVER CS3 328 API Reference The search pattern contains a JavaScript regular expression that //i 2 ssi_comment dom.serverModel.getServerInfo() Availability Dreamweaver MX. Description Returns information that is specific to the current - Adobe 38040334 | API Reference - Page 334
DREAMWEAVER CS3 329 API Reference Description Determines the server model that is associated None. Returns A string that contains the supported scripting languages. dom.serverModel.getServerName() Availability Dreamweaver 1; enhanced in Dreamweaver MX. Description Retrieves the server name that - Adobe 38040334 | API Reference - Page 335
DREAMWEAVER CS3 330 API Reference Note: In addition to letting you call this function from the JavaScript layer, Dreamweaver calls this function when the user changes the encoding in the page Properties dialog box. If the server model does not support the new character encoding, this function - Adobe 38040334 | API Reference - Page 336
DREAMWEAVER CS3 331 API Reference Returns A Boolean value that indicates whether the request to connect to the application server was successful. dreamweaver.getServerModels() Availability Dreamweaver MX. Description Gets the names for all the currently defined server models. The set of names is the - Adobe 38040334 | API Reference - Page 337
Chapter 17: Design The Design functions in Adobe® Dreamweaver® CS3 perform operations related to designing the appearance of a 355 • "Layout view functions" on page 360 • "Zoom functions" on page 369 • "Guide functions and properties" on page 372 • "Table editing functions" on page 379 CSS layout - Adobe 38040334 | API Reference - Page 338
(theDOM.canApplyLayout()); if (theDOM.canApplyLayout()) theDOM.applyLayout(1, "embed"); else alert("can't apply layout to this doc"); dom.canApplyLayout() Availability Dreamweaver CS3. Description Checks whether a CSS-based layout can be applied to the document. It checks that the document body is - Adobe 38040334 | API Reference - Page 339
. Returns String array containing the full paths of the HTML and preview image files (which can be null). dw.getLayoutNames() Availability Dreamweaver CS3. Description Gets the names of the available CSS-based layouts. Arguments None. Returns String array of layout names. dw.getLayoutDescriptions - Adobe 38040334 | API Reference - Page 340
DREAMWEAVER CS3 335 API Reference Description Gets the descriptions of the available CSS-based layouts Arguments None. Returns String array of layout descriptions. dom.applyCSSStyle() Availability Dreamweaver 4. Description Applies the specified style to the specified element. This function is valid - Adobe 38040334 | API Reference - Page 341
DREAMWEAVER CS3 336 API Reference Description This function gets the Element view the element has CSS properties that may cause content to be partially or completely hidden in Design view. Supported CSS properties include: • overflow: hidden, scroll, or auto • display: none • "full", which indicates - Adobe 38040334 | API Reference - Page 342
DREAMWEAVER CS3 337 API Reference dom.getShowDivBoxModel() Availability Dreamweaver 8. Description This function gets the state of the == false){ currentDOM.setShowDivBoxModel(true); } dom.getShowDivOutlines() Availability Dreamweaver 8. Description This function gets the state of the Layout Block - Adobe 38040334 | API Reference - Page 343
DREAMWEAVER CS3 338 API Reference Description Removes the CLASS or ID attribute from the tag that surrounds the elementNode argument is removed. Returns Nothing. dom.resetAllElementViews() Availability Dreamweaver 8. Description This function resets the Element view of all elements in the document to - Adobe 38040334 | API Reference - Page 344
DREAMWEAVER CS3 339 API Reference Description This function sets the Element view for returns to its original state. • "hidden" - If the currently selected element is in "hidden" view, Dreamweaver generates the CSS to cause all content to be viewed and then applies the CSS as an internal design time - Adobe 38040334 | API Reference - Page 345
DREAMWEAVER CS3 340 API Reference Description This function turns the Layout Block Box . Returns Nothing. Example See "dom.getShowDivBoxModel()" on page 337. dom.setShowDivOutlines() Availability Dreamweaver 8. Description This function turns the Layout Block Outlines visual aid on or off. Arguments - Adobe 38040334 | API Reference - Page 346
DREAMWEAVER CS3 341 API Reference Enabler See "dreamweaver.cssRuleTracker.canEditSelectedRule()" on page 453. dreamweaver.cssRuleTracker.newRule() Availability Dreamweaver MX 2004. Description Opens the New CSS Style dialog box, so the user can create a new rule. Arguments None. Returns Nothing. - Adobe 38040334 | API Reference - Page 347
DREAMWEAVER CS3 342 API Reference Arguments None. Returns Nothing. dreamweaver.cssStylePalette.deleteSelectedStyle() Availability Dreamweaver 3. Description Deletes the style that is currently selected in the Styles panel from the document. Arguments { pane } • The pane argument, which is optional, - Adobe 38040334 | API Reference - Page 348
DREAMWEAVER CS3 343 API Reference Enabler See "dreamweaver.cssStylePalette.canDuplicateSelectedStyle()" on page 454. dreamweaver.cssStylePalette.editSelectedStyle() Availability Dreamweaver 3. Description Opens the Style Definition dialog box for the style that is currently selected in the Styles - Adobe 38040334 | API Reference - Page 349
.getMediaType() Availability Dreamweaver MX 2004. Description Gets target media type for rendering. The default media type is "screen". Arguments None. Returns A string value that specifies the target media type. Example var mediaType = dw.cssStylePalette.getMediaType(); DREAMWEAVER CS3 344 API - Adobe 38040334 | API Reference - Page 350
DREAMWEAVER CS3 345 API Reference dreamweaver.cssStylePalette.getSelectedStyle() Availability Dreamweaver 3; fullSelector available in Dreamweaver MX. Description Gets the name of the style that is currently selected in the Styles panel. Arguments fullSelector • The fullSelector argument is a - Adobe 38040334 | API Reference - Page 351
DREAMWEAVER CS3 346 API Reference Description Gets a list of all the class styles in the Styles panel is set up as shown in the following figure, a call to the dreamweaver.cssStylePalette.getStyles() function returns an array that contains these strings: "BreadcrumbEnd", "change", "doctitle", " - Adobe 38040334 | API Reference - Page 352
DREAMWEAVER CS3 347 API Reference dreamweaver.cssStylePalette.newStyle() Availability Dreamweaver 3. Description Opens the New Style dialog box. Arguments None. Returns Nothing. dreamweaver.cssStylePalette.renameSelectedStyle() Availability Dreamweaver 3. Description Renames the class name that is - Adobe 38040334 | API Reference - Page 353
DREAMWEAVER CS3 348 API Reference Returns Nothing. Example The following example turns off rendering of CSS styles: dw.cssStylePalette.setDisplayStyles(false); dreamweaver.cssStylePalette.setMediaType() Availability Dreamweaver MX 2004. Description Sets the target media type for rendering. Refreshes - Adobe 38040334 | API Reference - Page 354
DREAMWEAVER CS3 349 API Reference var boxColors = dreamweaver.getBlockVisBoxModelColors(); if ((boxColors[0] != "#FFFFFF") || (boxColors[1] != "#FFFFFF)){ currentDOM.setBlockVisBoxModelColors("#FFFFFF", "#FFFFFF"); } dreamweaver.getBlockVisOutlineProperties() Availability Dreamweaver 8. Description - Adobe 38040334 | API Reference - Page 355
DREAMWEAVER CS3 350 API Reference Example The following example gets the background colors used by the Layout Block Backgrounds visual aid: var backgroundColors = dreamweaver.getDivBackgroundColors(); dreamweaver.setBlockVisOutlineProperties() Availability Dreamweaver 8. Description This function - Adobe 38040334 | API Reference - Page 356
DREAMWEAVER CS3 351 API Reference Returns Nothing. Example The following example makes sure the names of the frames in a frameset and splitting a frame in two. dom.getFrameNames() Availability Dreamweaver 3. Description Gets a list of all the named frames in the frameset. Arguments None. Returns An - Adobe 38040334 | API Reference - Page 357
DREAMWEAVER CS3 352 API Reference dom.isDocumentInFrame() Availability Dreamweaver 4. Description Identifies whether the current document is a frameset, this function saves all the frames and framesets from the Document window. If the specified document is not in a frameset, this function saves the - Adobe 38040334 | API Reference - Page 358
DREAMWEAVER CS3 353 API Reference Layer and image map functions Layer and image map functions handle aligning, resizing, and moving layers and image map hotspots. The function description indicates if it applies to layers or to hotspots. dom.align() Availability Dreamweaver 3. Description Aligns the - Adobe 38040334 | API Reference - Page 359
DREAMWEAVER CS3 354 API Reference Description Makes the selected layers or hotspots equal in height, width, or both. The last layer or hotspot selected is the guide. Arguments bHoriz, bVert • The bHoriz argument is a Boolean value that indicates whether to resize the layers or hotspots horizontally. - Adobe 38040334 | API Reference - Page 360
DREAMWEAVER CS3 355 API Reference Example If the selected layer has the Left, Top, Width, and Height properties shown, calling dw.getDocumentDOM().resizeSelectionBy(-10,-30,30,10) is equivalent to resetting Left to 40, Top to 20, Width to 240, and Height to 240. dom.setLayerTag() Availability - Adobe 38040334 | API Reference - Page 361
DREAMWEAVER CS3 356 API Reference dom.getRulerUnits() Availability Dreamweaver 3. Description Gets the current ruler units. Arguments None. Returns A string that contains one of the following values: • "in" • "cm" • "px" dom.getTracingImageOpacity() Availability Dreamweaver 3. Description Gets the - Adobe 38040334 | API Reference - Page 362
Returns Nothing. Enabler See "dom.canPlayPlugin()" on page 441. dom.setRulerOrigin() Availability Dreamweaver 3. Description Sets the origin of the ruler. Arguments xCoordinate, yCoordinate • The a value, expressed in pixels, on the vertical axis. Returns Nothing. DREAMWEAVER CS3 357 API Reference - Adobe 38040334 | API Reference - Page 363
DREAMWEAVER CS3 358 API Reference dom.setRulerUnits() Availability Dreamweaver 3. Description Sets the current ruler units. Arguments units • The units argument must be "px", "in", or "cm". Returns Nothing. dom.setTracingImagePosition() Availability Dreamweaver 3. Description Moves the upper left - Adobe 38040334 | API Reference - Page 364
DREAMWEAVER CS3 359 API Reference Returns Nothing. Enabler See "dom.hasTracingImage()" on page 444. Example The following code sets the opacity of the tracing image to 30%: dw.getDocumentDOM().setTracingOpacity('30'); dom.snapTracingImageToSelection() Availability Dreamweaver 3. Description Aligns - Adobe 38040334 | API Reference - Page 365
panels to their default positions. Arguments None. Returns Nothing. dreamweaver.showGridSettingsDialog() Availability Dreamweaver 3. Description Opens the Grid Settings dialog box. Arguments None. Returns Nothing. DREAMWEAVER CS3 360 API Reference Layout view functions Layout view functions handle - Adobe 38040334 | API Reference - Page 366
DREAMWEAVER CS3 361 API Reference Description Creates a 1-pixel-high transparent spacer other layout cells or nested layout tables. If the rectangle is not inside an existing layout table, Dreamweaver tries to create a layout table to house the new cell. This function does not force the document - Adobe 38040334 | API Reference - Page 367
DREAMWEAVER CS3 362 API Reference • The left argument is the x position of the left in pixels. Returns Nothing. dom.doesColumnHaveSpacer() Availability Dreamweaver 4. Description Determines whether a column contains a spacer image that Dreamweaver generated. It fails if the current selection is not - Adobe 38040334 | API Reference - Page 368
DREAMWEAVER CS3 363 API Reference Description If the user clicks a menu button in the in Layout view; false if the document is in Standard view. dom.isColumnAutostretch() Availability Dreamweaver 4. Description Determines whether a column is set to expand and contract automatically, depending on the - Adobe 38040334 | API Reference - Page 369
CS3 364 API Reference Arguments colNum • The colNum argument is the column to be automatically sized or fixed width. Returns Returns true if the column at the given index in the currently selected table is set to autostretch; false otherwise. dom.makeCellWidthsConsistent() Availability Dreamweaver - Adobe 38040334 | API Reference - Page 370
DREAMWEAVER CS3 365 API Reference Arguments colNum • The colNum argument is the column from which to remove the spacer image. Returns Nothing. dom.setColumnAutostretch() Availability Dreamweaver 4. Description Switches a column between automatically sized or fixed width. If bAutostretch is true, the - Adobe 38040334 | API Reference - Page 371
DREAMWEAVER CS3 366 API Reference var currentDOM = dw.getDocumentDOM(); if (currentDOM.getShowBlockBackgrounds(false) == false){ currentDOM.setShowBlockBackgrounds(false); } dom.getShowBlockBorders() Availability Dreamweaver 8. Description This function gets the state of the visual aid that draws - Adobe 38040334 | API Reference - Page 372
DREAMWEAVER CS3 367 API Reference var currentDOM = dw.getDocumentDOM(); if (currentDOM.getShowBlockIDs(false) == false){ currentDOM.setShowBlockIDs(true); } dom.getShowBoxModel() Availability Dreamweaver 8. Description This function turns on and off the visual aid that colors the full box model for - Adobe 38040334 | API Reference - Page 373
DREAMWEAVER CS3 368 API Reference dom.setShowBlockBorders() Availability Dreamweaver 8. Description This function turns . Example See "dom.getShowBlockBorders()" on page 366. dom.setShowBlockIDs() Availability Dreamweaver 8. Description This function turns on or off the visual aid that displays - Adobe 38040334 | API Reference - Page 374
DREAMWEAVER CS3 369 API Reference Returns A Boolean: true if the box model is displayed; false if the box model is not displayed. Example See "dom.getShowBoxModel()" on page 367. dom.setShowLayoutTableTabs() Availability Dreamweaver 4. Description Sets the current document to display tabs for layout - Adobe 38040334 | API Reference - Page 375
DREAMWEAVER CS3 370 API Reference dreamweaver.activeViewScale() Availability Dreamweaver 8. Description This function gets or sets a mutable floating point property. When you get the value, Dreamweaver returns the active view's scale as it appears in the Zoom combo box, divided by 100. For example, - Adobe 38040334 | API Reference - Page 376
DREAMWEAVER CS3 371 API Reference Description This function zooms in or out so that the current selection fits in the currently visible portion of the Design view. Arguments None. Returns Nothing. Enabler See "dreamweaver.canFitSelection()" on page 448. Example if (canFitSeletion()){ fitSelection(); - Adobe 38040334 | API Reference - Page 377
function does nothing. Arguments None. Returns Nothing. Enabler See "dreamweaver.canZoom()" on page 452. Example if (canZoom()){ zoomOut(); } Guide functions and properties Guide functions and properties let you display, manipulate, and delete guides that let users measure and lay out elements on - Adobe 38040334 | API Reference - Page 378
DREAMWEAVER CS3 373 API Reference Description This function determines whether to delete all guides in the document. Arguments None. Returns Nothing. Example The following example deletes all guides in the document if the document has at least one guide: var currentDOM = dw.getDocumentDOM(); if ( - Adobe 38040334 | API Reference - Page 379
DREAMWEAVER CS3 374 API Reference • The location argument is the location of the guide with both the value and units as one string, with no space between the value and units. The possible units are "px" for pixels and "%" for percentage. For example, to specify 10 pixels, location = "10px"; to - Adobe 38040334 | API Reference - Page 380
= dw.getDocumentDOM(); if (currentDOM.hasVerticalGuide("10px") == true) { currentDOM.deleteVerticalGuide("10px"); } dom.guidesColor Availability Dreamweaver 8. Description This mutable color property determines the color of guides in the document. You can set and get this property. Arguments None - Adobe 38040334 | API Reference - Page 381
DREAMWEAVER CS3 376 API Reference Example The following example makes the distance feedback color of guides gray: var currentDOM = dw.getDocumentDOM(); if (currentDOM.guidesDistanceColor != "#CCCCCC"){ currentDOM.guidesDistanceColor = "#CCCCCC"; } dom.guidesLocked Availability Dreamweaver 8. - Adobe 38040334 | API Reference - Page 382
DREAMWEAVER CS3 377 API Reference var currentDOM = dw.getDocumentDOM(); if (currentDOM.guidesSnapToElements == false) { currentDOM.guidesSnapToElements = true; } dom.guidesVisible Availability Dreamweaver 8. Description This mutable Boolean property determines whether guides are visible in the - Adobe 38040334 | API Reference - Page 383
DREAMWEAVER CS3 378 API Reference dom.hasHorizontalGuide() Availability Dreamweaver 8. Description This function determines whether the document has a horizontal guide 10 pixels, location = "10px"; to specify 50 percent, location = "50%". Returns A Boolean value: true if there is a vertical guide at - Adobe 38040334 | API Reference - Page 384
DREAMWEAVER CS3 379 API Reference var currentDOM = dw.getDocumentDOM(); if (currentDOM.hasVerticalGuide("10px") == true) { currentDOM.clearGuides(); } dom.snapToGuides Availability Dreamweaver 8. Description This mutable Boolean property determines whether elements snap to guides in the document. - Adobe 38040334 | API Reference - Page 385
. Arguments None. Returns Nothing. dom.decreaseColspan() Availability Dreamweaver 3. Description This function decreases the column span by one See "dom.canDecreaseColspan()" on page 438. dom.decreaseRowspan() Availability Dreamweaver 3. Description This function decreases the row span by one. - Adobe 38040334 | API Reference - Page 386
DREAMWEAVER CS3 381 API Reference dom.deleteTableColumn() Availability Dreamweaver 3. Description This function removes the selected table column or columns. Arguments None. Returns Nothing. Enabler See "dom.canDeleteTableColumn()" on page 438. dom.deleteTableRow() Availability Dreamweaver 3. - Adobe 38040334 | API Reference - Page 387
DREAMWEAVER CS3 382 API Reference dom.getShowTableWidths() Availability Dreamweaver MX 2004. Description Returns whether table widths appear in standard or expanded tables mode (non-Layout mode). For information on whether Dreamweaver dom.increaseColspan() Availability Dreamweaver 3. Description This - Adobe 38040334 | API Reference - Page 388
DREAMWEAVER CS3 383 API Reference dom.increaseRowspan() Availability Dreamweaver 3. Description This function increases the row span by one. Arguments None. Returns Nothing. Enabler See "dom.canIncreaseRowspan()" on page 440. dom.insertTableColumns() Availability Dreamweaver 3. Description This - Adobe 38040334 | API Reference - Page 389
CS3 384 API Reference • The bBeforeSelection argument is a Boolean value: true indicates that the rows should be inserted above the row that contains the selection; false otherwise. Returns Nothing. Enabler See "dom.canInsertTableRows()" on page 440. dom.mergeTableCells() Availability Dreamweaver - Adobe 38040334 | API Reference - Page 390
DREAMWEAVER CS3 385 API Reference Arguments None. Returns Nothing. dom.removeColumnWidth() Availability Dreamweaver MX 2004. Description This function removes all WIDTH attributes from a single, selected column. Arguments None. Returns Nothing. dom.selectTable() Availability Dreamweaver 3. - Adobe 38040334 | API Reference - Page 391
DREAMWEAVER CS3 386 API Reference • The bShow is a Boolean argument that indicates whether to display table widths for tables when the current document is in standard or Expanded Tables mode (non-Layout mode). If bShow is true, Dreamweaver displays the widths. If bShow is false, Dreamweaver does not - Adobe 38040334 | API Reference - Page 392
DREAMWEAVER CS3 387 API Reference • The numberOfRows argument specifies the number of rows to set in the selected table. Returns Nothing. dom.showInsertTableRowsOrColumnsDialog() Availability Dreamweaver 3. Description This function opens the Insert Rows or Columns dialog box. Arguments None. - Adobe 38040334 | API Reference - Page 393
• "Code view functions" on page 415 • "Tag editor and tag library functions" on page 431 Code functions Code Hints are menus that Adobe® Dreamweaver® CS3 opens when you type certain character patterns in Code view. Code Hints provide a typing shortcut by offering a list of strings that potentially - Adobe 38040334 | API Reference - Page 394
DREAMWEAVER CS3 389 API Reference You can also add new Code Hints menus dynamically through JavaScript after Dreamweaver loads the contents of . If it is a string, it specifies the URL for a single image file that Dreamweaver uses for all items in the menu. If it is an array of strings, it must - Adobe 38040334 | API Reference - Page 395
DREAMWEAVER CS3 390 API Reference Returns Nothing. Example If the user creates a record set document // no icons for this menu // specific to the ASP doc types dreamweaver.codeHints.addFunction() Availability Dreamweaver MX. Description Dynamically defines a new function tag. If there is an - Adobe 38040334 | API Reference - Page 396
DREAMWEAVER CS3 391 API Reference dreamweaver.codeHints.resetMenu() Availability Dreamweaver MX. Description Resets the specified menu tag or function tag to its state immediately after Dreamweaver reads the CodeHints.xml file. In other words, a call to this function erases the effect of previous - Adobe 38040334 | API Reference - Page 397
DREAMWEAVER CS3 392 API Reference dreamweaver.reloadCodeColoring() Description Reloads code coloring files from the Dreamweaver Configuration/Code Coloring folder. Arguments None. Returns Nothing. Example dreamweaver.reloadCodeColoring() Find and replace functions Find and replace functions handle - Adobe 38040334 | API Reference - Page 398
DREAMWEAVER CS3 393 API Reference dreamweaver.replace() Availability Dreamweaver 3. Description Verifies that the current selection matches the search criteria that was specified by "dreamweaver.setUpFindReplace()" on page 395, by "dreamweaver.setUpComplexFindReplace()" on page 394, or by the user - Adobe 38040334 | API Reference - Page 399
DREAMWEAVER CS3 394 API Reference Returns Nothing. Example The first line of the following example sets up a tag search and specifies that the scope of the search should be the current document. The second line performs the search operation. dreamweaver.setUpComplexFind(' - Adobe 38040334 | API Reference - Page 400
DREAMWEAVER CS3 395 API Reference dreamweaver.setUpFind() Availability Dreamweaver 3. Description Prepares for a text or HTML source search by defining the search parameters for a subsequent dreamweaver.findNext() operation. Arguments searchObject The searchObject argument is an object for which the - Adobe 38040334 | API Reference - Page 401
DREAMWEAVER CS3 396 API Reference The searchObject argument is an object for which the following properties searchParams.replaceString = 'bgcolor="#CCFFCC"'; searchParams.searchSource = true; dreamweaver.setUpFindReplace(searchParams); var searchParams = {searchString: 'bgcolor="#FFCCFF"', - Adobe 38040334 | API Reference - Page 402
Description Opens the Replace dialog box. Arguments None. Returns Nothing. Enabler See"dreamweaver.canShowFindDialog()" on page 452. General editing functions You handle general editing functions in the Document window. These functions insert text, HTML, and objects; apply, change, and remove font - Adobe 38040334 | API Reference - Page 403
DREAMWEAVER CS3 398 API Reference Arguments attribute, value • The attribute argument must be "face", the tag attribute that you want to edit. Returns Nothing. dom.exitBlock() Availability Dreamweaver 3. Description Exits the current paragraph or heading block, leaving the insertion point outside - Adobe 38040334 | API Reference - Page 404
DREAMWEAVER CS3 399 API Reference Arguments None. Returns Nothing. dom.getCharSet() Availability Dreamweaver 4. Description Returns the empty string if the attribute is not set. dom.getLineFromOffset() Availability Dreamweaver MX. Description Finds the line number of a specific character offset in - Adobe 38040334 | API Reference - Page 405
DREAMWEAVER CS3 400 API Reference Returns An integer that represents the line number in the document. dom.getLinkHref() Availability Dreamweaver 3. Description Gets the link that surrounds the current selection. This function is equivalent to looping through the parents and grandparents of the - Adobe 38040334 | API Reference - Page 406
DREAMWEAVER CS3 401 API Reference dom.getTextAlignment() Availability Dreamweaver 3. Description Gets the alignment of the tag. This value always returns in lowercase letters. dom.getTextFormat() Availability Dreamweaver 3. Description Gets the block format of the selected text. Arguments None. - Adobe 38040334 | API Reference - Page 407
DREAMWEAVER CS3 402 API Reference dom.indent() Availability Dreamweaver 3. Description Indents the selection using BLOCKQUOTE tags. If the selection is a list theDOM = dw.getDocumentDOM(); theDOM.insertHTML('130'); The result appears in the Document window, as shown in the following figure: - Adobe 38040334 | API Reference - Page 408
DREAMWEAVER CS3 403 API Reference dom.insertObject() Availability Dreamweaver 3. Description Inserts the specified object, the current document: var theDOM = dreamweaver.getDocumentDOM(); theDOM.insertText('130'); The results appear in the Document window, as shown in the following figure: - Adobe 38040334 | API Reference - Page 409
DREAMWEAVER CS3 404 API Reference dom.newBlock() Availability Dreamweaver 3. Description Creates a new block with the same . dom.notifyFlashObjectChanged() Availability Dreamweaver 4. Description Tells Dreamweaver that the current Flash object file has changed. Dreamweaver updates the Preview display - Adobe 38040334 | API Reference - Page 410
DREAMWEAVER CS3 405 API Reference Arguments None. Returns Nothing. dom.removeCharacterMarkup() Availability Dreamweaver 3. strong", "tt", "u", or "var". Returns Nothing. dom.removeFontMarkup() Availability Dreamweaver 3. Description Removes the specified attribute and its value from a FONT tag. - Adobe 38040334 | API Reference - Page 411
DREAMWEAVER CS3 406 API Reference Returns Nothing. dom.resizeSelection() Availability Dreamweaver 3. Description Resizes the selected value to set for the attribute. Returns Nothing. dom.setLinkHref() Availability Dreamweaver 3. Description Makes the selection a hypertext link or changes the URL - Adobe 38040334 | API Reference - Page 412
DREAMWEAVER CS3 407 API Reference • The linkHREF argument is the URL (document-relative path Arguments {linkTarget} • The linkTarget argument, which is optional, is a string that represents a frame name, window name, or one of the reserved targets ("_self", "_parent", "_top", or "_blank"). If the - Adobe 38040334 | API Reference - Page 413
DREAMWEAVER CS3 408 API Reference Description Opens the List Properties dialog box. Arguments None. Returns Nothing. Enabler See "dom.canShowListPropertiesDialog()" on page 443. dom.setListTag() Availability Dreamweaver 3. Description Sets the style of the selected list. Arguments listTag • The - Adobe 38040334 | API Reference - Page 414
DREAMWEAVER CS3 409 API Reference Description Sets the format of the selected text field. Arguments fieldType • The fieldType argument must be "input", "textarea", or "password". Returns Nothing. dom.setTextFormat() Availability Dreamweaver 4. Description Sets the block format of the selected text. - Adobe 38040334 | API Reference - Page 415
DREAMWEAVER CS3 410 API Reference Arguments None. Returns Nothing. Enabler See "dreamweaver.canDeleteSelection()" on page 446. dreamweaver.editFontList() Availability Dreamweaver 3. Description Opens the Edit Font List dialog box. Arguments None. Returns Nothing. dreamweaver.getFontList() - Adobe 38040334 | API Reference - Page 416
whether the font supports both Bold and Italic. dreamweaver.getKeyState() Availability Dreamweaver 3. Description Determines whether the specified modifier key is depressed. Arguments key • The key argument must be one of the following values: "Cmd", "Ctrl", "Alt", or "Shift". In Windows, "Cmd" and - Adobe 38040334 | API Reference - Page 417
DREAMWEAVER CS3 412 API Reference Arguments url • The url argument points to a graphical object for which the dimensions are wanted. Dreamweaver must support this object (GIF, JPEG, PNG, Flash this argument is set to true, in Windows, the dreamweaver.PrintCode() function displays the Print dialog box - Adobe 38040334 | API Reference - Page 418
to selecting the next tag to the right in the tag selector at the bottom of the Document window. Arguments None. Returns Nothing. dom.selectParent() Availability Dreamweaver 3. Description Selects the parent of the current selection. Calling this function is equivalent to selecting the next tag - Adobe 38040334 | API Reference - Page 419
DREAMWEAVER CS3 414 API Reference Arguments None. Returns Nothing. dom.stripTag() Availability Dreamweaver 3. Description Removes the tag from around the current selection, leaving any contents. If the selection has no tags or contains more than one tag, Dreamweaver reports an error. Arguments None. - Adobe 38040334 | API Reference - Page 420
DREAMWEAVER CS3 415 API Reference Description Displays the Quick Tag Editor for the current within a split document view or the Code inspector window. dom.formatRange() Availability Dreamweaver MX. Description Applies Dreamweaver automatic syntax formatting to a specified range of characters - Adobe 38040334 | API Reference - Page 421
DREAMWEAVER CS3 416 API Reference Description Applies Dreamweaver automatic syntax formatting to the selected content (the on page 245). Note: This function returns only the results that are currently in the results window for the document. If you want to make sure that the counts are up-to-date, - Adobe 38040334 | API Reference - Page 422
DREAMWEAVER CS3 417 API Reference Example theDom = dw.getDocumentDOM(); theDom.runValidation(); theDom.getAutoValidationCount(); dom.isDesignViewUpdated() Availability Dreamweaver 4. Description Determines whether the Design view and Text view content is synchronized for those Dreamweaver operations - Adobe 38040334 | API Reference - Page 423
CS3 418 API Reference • The bShowNoscript argument, which is optional, is a Boolean value that indicates whether the noscript tag content should be rendered; true if the noscript tag content should be rendered, false otherwise. Returns Nothing. dom.source.arrowDown() Availability Dreamweaver - Adobe 38040334 | API Reference - Page 424
DREAMWEAVER CS3 419 API Reference dom.source.arrowRight() Availability Dreamweaver 4. Description Moves the insertion point is selected; otherwise it is not. Returns Nothing. dom.source.arrowUp() Availability Dreamweaver 4. Description Moves the insertion point up the Code view document, line by - Adobe 38040334 | API Reference - Page 425
DREAMWEAVER CS3 420 API Reference Description This function is a Code view extension that enables If bShiftIsDown is true, the content is selected. Returns Nothing. dom.source.endOfLine() Availability Dreamweaver 4. Description Places the insertion point at the end of the current line. If content - Adobe 38040334 | API Reference - Page 426
DREAMWEAVER CS3 421 API Reference dom.source.endPage() Availability Dreamweaver 4. Description Moves the insertion point to the content is selected. Returns Nothing. dom.source.getCurrentLines() Availability Dreamweaver 4. Description Returns the line numbers for the specified offset locations from - Adobe 38040334 | API Reference - Page 427
CS3 422 API Reference dom.source.getLineFromOffset() Availability Dreamweaver MX. Description Takes an offset into the source document. Arguments None. Returns The associated line number, or -1 if the offset is negative or past the end of the file. dom.source.getText() Availability Dreamweaver - Adobe 38040334 | API Reference - Page 428
DREAMWEAVER CS3 423 API Reference Returns An array of objects or the value null. Each object in the array has the following properties: • The message object is a string that contains the error message. • The floaterName object is a string that contains the name of the results window. You can pass - Adobe 38040334 | API Reference - Page 429
DREAMWEAVER CS3 424 API Reference • The string argument is the string to insert. Returns A Boolean value: true if successful; false otherwise. dom.source.nextWord() Availability Dreamweaver 4. Description Moves the insertion point to the beginning of the next word (or words, if specified) in the - Adobe 38040334 | API Reference - Page 430
DREAMWEAVER CS3 425 API Reference Arguments {nTimes}, {bShiftIsDown} • The nTimes argument, which is If bShiftIsDown is true, the content is selected. Returns Nothing. dom.source.pageUp() Availability Dreamweaver 4. Description Moves the insertion point up the Code view document, page by page. If - Adobe 38040334 | API Reference - Page 431
DREAMWEAVER CS3 426 API Reference Returns Nothing. dom.source.replaceRange() Availability Dreamweaver 4. Description Replaces the range value: true if successful; false otherwise. dom.source.scrollEndFile() Availability Dreamweaver 4. Description Scrolls the Code view to the bottom of the document - Adobe 38040334 | API Reference - Page 432
Returns Nothing. dom.source.scrollLineUp() Availability Dreamweaver 4. Description Scrolls the Code view up Nothing. dom.source.scrollPageDown() Availability Dreamweaver 4. Description Scrolls the Code view . dom.source.scrollPageUp() Availability Dreamweaver 4. Description Scrolls the Code view - Adobe 38040334 | API Reference - Page 433
DREAMWEAVER CS3 428 API Reference • The nTimes argument is the number of pages to scroll. If nTimes is omitted, the default is 1. Returns Nothing. dom.source.scrollTopFile() Availability Dreamweaver 4. Description Scrolls the Code view to the top of the document file without moving the insertion - Adobe 38040334 | API Reference - Page 434
DREAMWEAVER CS3 429 API Reference Returns A Boolean value: true if successful; false otherwise. dom.source.startOfDocument() Availability Dreamweaver 4. Description Places the insertion point at the beginning of the Code view document. If content is already selected, this function extends the - Adobe 38040334 | API Reference - Page 435
DREAMWEAVER CS3 430 API Reference Arguments {nTimes}, {bShiftIsDown} • The nTimes argument, which bShiftIsDown is true, the content is selected. Returns Nothing. dom.source.wrapSelection() Availability Dreamweaver 4. Description Inserts the text of startTag before the current selection and the text - Adobe 38040334 | API Reference - Page 436
DREAMWEAVER CS3 431 API Reference Tag editor and tag library functions You the bottom of the document window. Arguments None. Returns The DOM node for the currently selected tag; null if no tag is selected. dreamweaver.popupInsertTagDialog() Availability Dreamweaver MX. Description This function - Adobe 38040334 | API Reference - Page 437
DREAMWEAVER CS3 432 API Reference Description If a tag is selected, this function opens the tag editor for that tag, so you can edit the tag. Arguments None. Returns Nothing. Enabler See "dreamweaver.canPopupEditTagDialog()" on page 449. dreamweaver.showTagChooser() Availability Dreamweaver MX. - Adobe 38040334 | API Reference - Page 438
DREAMWEAVER CS3 433 API Reference Arguments fileURL • The fileURL argument is the URL Tag Library editor; returns an empty string if no library is selected. dreamweaver.tagLibrary.getSelectedTag() Availability Dreamweaver MX. Description If an attribute node is currently selected, this function gets - Adobe 38040334 | API Reference - Page 439
DREAMWEAVER CS3 434 API Reference • The fileURL argument is the path to DTD or schema file, in local URL format. • The Prefix argument is the prefix string that should be added to all tags in this tag library. Returns Name of the imported tag library. dreamweaver.tagLibrary.getImportedTagList() - Adobe 38040334 | API Reference - Page 440
Chapter 19: Enablers Adobe® Dreamweaver® CS3 enabler functions determine whether another function can perform a the JavaScript API include the following functions. dom.canAlign() Availability Dreamweaver 3. Description Checks whether Dreamweaver can perform an Align Left, Align Right, Align Top, - Adobe 38040334 | API Reference - Page 441
DREAMWEAVER CS3 436 API Reference dom.canApplyTemplate() Availability Dreamweaver 3. Description Checks whether Dreamweaver can perform an Apply To Page operation. This function is valid only for the active document. Arguments None. Returns A Boolean value that indicates whether the - Adobe 38040334 | API Reference - Page 442
DREAMWEAVER CS3 437 API Reference Description Checks whether Dreamweaver can perform a Paste operation. Arguments None. Returns A Boolean value: true if the Clipboard contains any content that can be pasted into Dreamweaver; false otherwise. dom.canClipPasteText() Availability Dreamweaver 3. - Adobe 38040334 | API Reference - Page 443
DREAMWEAVER CS3 438 API Reference Returns A Boolean value: true if all the content in the BODY section of the document is contained within tables, and the document is not based on a template; false otherwise. dom.canDecreaseColspan() Availability Dreamweaver 3. Description Checks whether Dreamweaver - Adobe 38040334 | API Reference - Page 444
DREAMWEAVER CS3 439 API Reference dom.canDeleteTableRow() Availability Dreamweaver 3. Description Checks whether Dreamweaver can perform a Delete Row operation. Arguments None. Returns A Boolean value: true if the insertion point is inside a cell or if a cell or row is selected; - Adobe 38040334 | API Reference - Page 445
DREAMWEAVER CS3 440 API Reference Returns A Boolean value: true if there are any cells to the right of the current cell; false otherwise. dom.canIncreaseRowspan() Availability Dreamweaver 3. Description Checks whether Dreamweaver can perform an Increase Rowspan operation. Arguments None. Returns A - Adobe 38040334 | API Reference - Page 446
DREAMWEAVER CS3 441 API Reference dom.canMakeNewEditableRegion() Availability Dreamweaver 3. Description Checks whether Dreamweaver can perform a New Editable Region operation. Arguments None. Returns A Boolean value: true if the current document is a template (DWT) file. dom. - Adobe 38040334 | API Reference - Page 447
-in. dom.canRedo() Availability Dreamweaver 3. Description Checks whether Dreamweaver can perform a Redo operation. () Availability Dreamweaver 3. Description Checks whether Dreamweaver can perform dom.canSelectTable() Availability Dreamweaver 3. Description Checks whether Dreamweaver can perform a - Adobe 38040334 | API Reference - Page 448
DREAMWEAVER CS3 443 API Reference dom.canSetLinkHref() Availability Dreamweaver 3. Description Checks whether Dreamweaver can change the link around the current selection or create one if necessary. Arguments None. Returns A Boolean value: true if the selection is an image, - Adobe 38040334 | API Reference - Page 449
DREAMWEAVER CS3 444 API Reference Description Checks whether Dreamweaver can perform a Split Cell operation. Arguments None. Returns A Boolean value: true if the insertion point is inside a table cell or the selection is a table cell; false otherwise. dom.canStopPlugin() Availability Dreamweaver 3. - Adobe 38040334 | API Reference - Page 450
DREAMWEAVER CS3 445 API Reference Returns A Boolean value: true if the document has a tracing image; false otherwise. dreamweaver.assetPalette.canEdit() Availability Dreamweaver 4. Description Enables menu items in the Assets panel for editing. Arguments None. Returns Returns a Boolean value: true - Adobe 38040334 | API Reference - Page 451
(on the Macintosh, a text field in a floating panel or dialog box); false otherwise. dreamweaver.canDeleteSelection() Availability Dreamweaver 3. Description Checks whether Dreamweaver can delete the current selection. Depending on the window that has focus, the deletion might occur in the Document - Adobe 38040334 | API Reference - Page 452
DREAMWEAVER CS3 447 API Reference dreamweaver.canExportCSS() (deprecated) Availability Dreamweaver 3. Description Checks whether Dreamweaver can perform an Export CSS Styles operation. Arguments None. Returns A Boolean value: true if the document contains any class styles that are defined in the - Adobe 38040334 | API Reference - Page 453
DREAMWEAVER CS3 448 API Reference Returns A Boolean value: true if a search pattern has already been established; false otherwise. dreamweaver.canFitSelection() Availability Dreamweaver 8. Description Checks whether there is a selection in an active Design view, which means that fitSelection() can - Adobe 38040334 | API Reference - Page 454
DREAMWEAVER CS3 449 API Reference dreamweaver.canPlayRecordedCommand() Availability Dreamweaver 3. Description Checks whether Dreamweaver can perform a Play Recorded Command operation. Arguments None. Returns A Boolean value: true if there is an active document and a previously recorded command that - Adobe 38040334 | API Reference - Page 455
DREAMWEAVER CS3 450 API Reference Description Checks whether Dreamweaver can perform a Revert (to the last-saved version) operation. Arguments documentObject • The documentObject argument is the object at the root of a document's DOM tree (the value that the dreamweaver.getDocumentDOM() function - Adobe 38040334 | API Reference - Page 456
DREAMWEAVER CS3 451 API Reference Description Checks whether Dreamweaver can perform a Save As Template operation on the specified document. Arguments documentObject • The documentObject argument is the root of a document's DOM (the same value that the dreamweaver.getDocumentDOM() function returns). - Adobe 38040334 | API Reference - Page 457
value that is true if a Site panel or a Document window is open. This function returns the value false when the selection is in the HEAD section. dreamweaver.canUndo() Availability Dreamweaver 3. Description Checks whether Dreamweaver can perform an Undo operation in the current context. Arguments - Adobe 38040334 | API Reference - Page 458
DREAMWEAVER CS3 453 API Reference Returns A Boolean value: true if there is an active Design view; false otherwise. dreamweaver.cssRuleTracker.canEditSelectedRule() Availability Dreamweaver MX 2004. Description Checks whether the Property Grid editor can be applied to the selected rule. Because the - Adobe 38040334 | API Reference - Page 459
DREAMWEAVER CS3 454 API Reference dreamweaver.cssStylePalette.canDeleteSelectedStyle() Availability Dreamweaver MX. Description Checks the current selection to determine whether the selected style can be deleted. Arguments { pane } • The pane argument, which is optional, is a string - Adobe 38040334 | API Reference - Page 460
DREAMWEAVER CS3 455 API Reference • The pane argument, which is optional, is a string value: true if the selected style is editable; false otherwise. dreamweaver.cssStylePalette.canEditStyleSheet() Availability Dreamweaver MX. Description Checks the current selection to see whether it contains - Adobe 38040334 | API Reference - Page 461
DREAMWEAVER CS3 456 API Reference Description Checks the current active document to see whether the selected style can be renamed. Arguments { pane } • The pane argument, which is - Adobe 38040334 | API Reference - Page 462
None. Returns A Boolean value: true if the contents can display; false otherwise. dreamweaver.resultsPalette.canPaste() Availability Dreamweaver MX. Description Checks whether the current Results window can display a Paste message in its contents. Arguments None. DREAMWEAVER CS3 457 API Reference - Adobe 38040334 | API Reference - Page 463
.resultsPalette.canSave() Availability Dreamweaver MX. Description Checks whether the Save dialog box can open for the current panel. Currently, the Site Reports, Target Browser Check, Validation, and Link Checker panels support the Save dialog box. Arguments None. Returns A Boolean value: true - Adobe 38040334 | API Reference - Page 464
DREAMWEAVER CS3 459 API Reference dreamweaver.resultsPalette.canSelectAll() Availability Dreamweaver MX. Description Checks whether a Select All message can be sent to the window that is currently in focus. Arguments None. Returns A Boolean value: true if the Select All message can be sent; false - Adobe 38040334 | API Reference - Page 465
DREAMWEAVER CS3 460 API Reference Description This function checks whether the Change Action to Get context menu in the Site Synchronize dialog box can be displayed. Arguments None. Returns A Boolean value: true if the Change Action to Get context menu can be displayed; false otherwise. dreamweaver. - Adobe 38040334 | API Reference - Page 466
value: true if you can insert or apply the selected element; false otherwise. site.browseDocument() Availability Dreamweaver 4. Description Opens all selected documents in a browser window. It is the same as using the Preview in Browser command. Arguments browserName • The browserName argument - Adobe 38040334 | API Reference - Page 467
DREAMWEAVER CS3 462 API Reference Returns Nothing. site.canAddLink() Availability Dreamweaver 3. Description Checks whether Dreamweaver can Dreamweaver 3. Description Checks whether Dreamweaver can perform a Change Link operation. Arguments None. Returns A Boolean value: true if an HTML or Flash - Adobe 38040334 | API Reference - Page 468
DREAMWEAVER CS3 463 API Reference • If a document window has focus, the file has been saved in a local site; or, if the Site panel has focus, one or more files or folders are selected. • The Check In/Check Out feature is turned on for the site. site.canCheckOut() Availability Dreamweaver 3. - Adobe 38040334 | API Reference - Page 469
Boolean value: true if the current remote site is an FTP site; false otherwise. site.canDisplaySyncInfoForFile() Availability Dreamweaver CS3 Description Determines whether Dreamweaver can perform the displaySyncInfoForFile operation. Arguments path, 'site' • path is the URL to a local file. • 'site - Adobe 38040334 | API Reference - Page 470
DREAMWEAVER CS3 465 API Reference Arguments None. Returns A Boolean value that indicates that the selected link in the site map is not the home page. site.canGet() Availability Dreamweaver 3. Description Determines whether Dreamweaver can perform a Get operation. Arguments siteOrURL • The siteOrURL - Adobe 38040334 | API Reference - Page 471
DREAMWEAVER CS3 466 API Reference • If the second argument is the keyword site, a Boolean value that indicates whether both windows contain site files (not the site map) and whether the selection is in the opposite pane from the argument site.canMakeEditable() Availability Dreamweaver 3. Description - Adobe 38040334 | API Reference - Page 472
DREAMWEAVER CS3 467 API Reference site.canPut() Availability Dreamweaver 3. Description Determines whether Dreamweaver can perform a Put operation. Arguments siteOrURL • The siteOrURL argument must be the site keyword, which indicates that the function should act on the selection in - Adobe 38040334 | API Reference - Page 473
. Arguments None. Returns A Boolean value that indicates that an HTML or Flash file links to the selected file in the site map. site.canSetLayout() Availability Dreamweaver 3. Description Determines whether Dreamweaver can perform a Layout operation. Arguments None. Returns A Boolean value: true if - Adobe 38040334 | API Reference - Page 474
DREAMWEAVER CS3 469 API Reference site.canSelectNewer() Availability Dreamweaver 3. Description Determines whether Dreamweaver can perform a Select Newer [Remote | Local] operation. Arguments localOrRemote • The localOrRemote argument must be either the local or remote keyword. Returns A Boolean - Adobe 38040334 | API Reference - Page 475
DREAMWEAVER CS3 470 API Reference Description Determines whether Dreamweaver value: true if Dreamweaver can perform the uncloaking Dreamweaver 3. Description Determines whether Dreamweaver . site.canViewAsRoot() Availability Dreamweaver 3. Description Determines whether Dreamweaver can perform a View - Adobe 38040334 | API Reference - Page 476
73 Design Notes 23 file I/O 6 Fireworks integration 34 Flash objects 42 HTTP 15 JavaBeans 79 source control integration 85 Assets() 271 assetPalette.addToFavoritesFromSite Window() 271 assetPalette.canEdit() bringDWToFront() 34 bringFWToFront() 35 bringing Dreamweaver to front 34 bringing Fireworks - Adobe 38040334 | API Reference - Page 477
() 443 canStopPlugin() 444 canSynchronize() 469 canUncloak() 469 canUndo() 444, 452 canUndoCheckOut() 470 canViewAsRoot() 470 cascade() 175 cascading document windows 175 Cascading Style Sheets to HTML markup, converting 227 changeLink() 200 changeLinkSitewide() 200 check out names 93 checkIn() 200 - Adobe 38040334 | API Reference - Page 478
models 348, 367, 368 code 388, 392 divs 365, 367 guides 375 Layout Block Backgrounds 349 column span, decreasing 380 columns 60, sets 64, 65 sizing 363, 364, 365 types of 60 widths in Results window 146 Command menu functions 228 commands executing 229 recorded 121 comments, apply 190 compare() - Adobe 38040334 | API Reference - Page 479
342 deployFilesToTestingServerBin() 20 4 deprecated functions 4 dreamweaver.canExportCSS() 447 dreamweaver.exportCSS() 235 dreamweaver.exportEditableRegio nsAsXML() 235 dreamweaver.libraryPalette.recrea teFromDocument() 278 dreamweaver.libraryPalette.renam eSelectedItem() 278 description attribute - Adobe 38040334 | API Reference - Page 480
475 Replace 397 Restrict 58 Save As 241, 242 Save As Command 126 Save As Template 243 Select External Editor 109 Select Image Source 356 Size Definition 148 Style Definition 343 System ODBC Administration 58 Tag Chooser 115 Target Browsers 253 disconnecting from source control systems 86 displaying - Adobe 38040334 | API Reference - Page 481
476 getHideAllVisualAids() 150 getInlineElements() 309 getIsLibraryDocument() 295 getIsTemplateDocument() 295 getIsXHTMLDocument() 231 getLineFromOffset() 399 getLinkHref() 400 getLinkTarget() 400 getListElements() 310 getListTag() 400 getMinDisplayWidth() 307 getOpenPathName() 189 getParseMode() - Adobe 38040334 | API Reference - Page 482
() 430 undo() 120 updateCurrentPage() 297 wrapTag() 414 DOM, getting 236 doURLDecoding() 247 doURLEncoding() 262 Dreamweaver bringing to front 34 quitting 113 dreamweaver activateApp() 111 activeViewScale() 370 arrangeFloatingPalettes() 360 assetPalette.addToFavoritesFrom Document() 271 assetPalette - Adobe 38040334 | API Reference - Page 483
478 assetPalette.setSelectedCategory() 276 assetPalette.setSelectedView() 276 beep() 112, 114, 194, 195, 224 behaviorInspector object 280 behaviorInspector.getBehaviorAt( ) 285 behaviorInspector.getBehaviorCo unt() 285 behaviorInspector.getSelectedBeh avior() 285 behaviorInspector.moveBehavior Down - Adobe 38040334 | API Reference - Page 484
479 getPrimaryExtensionEditor() 107 getPrimaryView() 178 getRecentFileList() 238 getRedoText() 120 getSecondaryBrowser() 108 getSelection() 259 getServerModels() 331 getShowDialogsOnInsert() 113 getShowStatusBar() 161 getSiteRoot() 254 getSnapDistance() 178 getSystemFontList() 412 getTempFolderPath - Adobe 38040334 | API Reference - Page 485
DLL 6 DWfile.copy() 6 DWfile.createFolder() 7 DWfile.exists() 7 DWfile.getAttributes() 8 DWfile.getCreationDate() 9 DWfile.getCreationDateObj() 10 DWfile.getModificationDate() 9 DWfile.getModificationDateObj() 10 DWfile.getSize() 11 DWfile.listFolder() 11 DWfile.read() 12 DWfile.remove() 12 DWfile - Adobe 38040334 | API Reference - Page 486
10 DWfile.getModificationDate() 9 DWfile.getModificationDateObj() 10 removing 12 renaming 90 Results window 146 saving 17, 18 size Flash content, natural size of 44 Flash elements, inserting 41, 127 Flash MX, determining version 110 Flash Object file generating 43 reading 45 Flash object type 44 Flash - Adobe 38040334 | API Reference - Page 487
guide 372 history 119 insert objects 127 keyboard 130 layer and image map 353 layout environment 355 layout view 360 library and template 293 live data 319 menu 136 new in Dreamweaver CS3 2 passing file contents to 19 path 253 print 412 quick tag editor 413 report 193 results window Flash 10 - Adobe 38040334 | API Reference - Page 488
() 212 getMediaType() 344 getMenuDefault() 128 getMenuNeedsUpdating() 137 getMethods() 81 getMinDisplayWidth() 307 getModificationDate() 9 getModificationDateObj() 10 getNaturalSize() 411 getNewDocumentDOM() 237 GetNote() 28 GetNoteLength() 29 GetNotesKeyCount() 29 GetNotesKeys() 29 getObjectRefs - Adobe 38040334 | API Reference - Page 489
() 268 getXMLSourceURI() 268 global application functions 112 global document functions 244 groups of files 102, 103 guide functions 372 guides locking 376 working with 372 guidesColor() 375 guidesDistanceColor() 375 guidesLocked 376 guidesSnapToElements 376 guidesVisible 377 H hasCharacterMarkup - Adobe 38040334 | API Reference - Page 490
485 Flash elements 41, 127 string into document 114 tags 115 insertion page 134 insertion relative URI 195 local root folder 254 LocalURLToFilePath() 31 locateInSite() 215 locking, guides 376 login information, RDS 55, 58 M makeCellWidthsConsistent() 364 makeEditable() 215 makeNewDreamweaverFile - Adobe 38040334 | API Reference - Page 491
JavaBeans 81 minimizeRestoreAll() 178 minimizing windows 178 MMDB.deleteConnection() 47 MMDB.getColdFusionDsnList 239 New functions in Dreamweaver CS3 2 newBlock() 404 newDocument 137 numbers, of files checked out 95 O object type, Flash 44 ODBC administration 58 ODBC DSNs 52, 53 offsetsToNode() 257 - Adobe 38040334 | API Reference - Page 492
147 properties, JavaBeans 81, 82 put() 217 putting files 89, 103 Q quitApplication() 113 quitting Dreamweaver 113 R RDS login information 55, 58 passwords 53, 56 user names 53, 57 read() 12 reading, Flash Object file 45 read-only files 13 reapplyBehaviors() 281 recorded commands 121 recording steps - Adobe 38040334 | API Reference - Page 493
result sets 64, 65, 68, 69 Results floating panel 138 results panel clearing 140 messages 140, 141 Results panel group 138 Results window adding 143 adding results entry 139 calling processFile() processFile() 145 column widths 146 creating 143 functions 138 processing files 146, 147 retrieve index - Adobe 38040334 | API Reference - Page 494
489 SCS_GetNewFeatures() 92 SCS_GetNoteCount() 96 SCS_GetNumCheckedOut() 95 SCS_GetNumNewFeatures() 92 SCS_GetRootFolder() 87 SCS_GetRootFolderLength() 87 SCS_IsConnected() 87 SCS_IsRemoteNewer() 98 SCS_ItemExists() 91 SCS_NewFolder() 89 SCS_Put() 89 SCS_Rename() 90 SCS_SetDesignNotes() 98 - Adobe 38040334 | API Reference - Page 495
.markDelete() 197 siteSyncDialog.markGet() 197 siteSyncDialog.markIgnore() 198 siteSyncDialog.markPut() 198 siteSyncDialog.markSynced() 198 siteSyncDialog.toggleShowAllFiles() 199 size Flash content 44 of files 11 sizing hotspots 354 layers 354 snapToGuides() 379 snapTracingImageToSelection() 359 - Adobe 38040334 | API Reference - Page 496
491 snippet tag, attributes 298 snippetPalette.getCurrentSnippetPat h() 299 snippetPalette.newFolder() 299 Snippets panel functions 298 Source Control Integration API about 84 SCS_AfterGet() 103 SCS_AfterPut() 103 SCS_BeforeGet() 102 SCS_BeforePut() 102 SCS_canCheckin() 100 SCS_canCheckout() 99 - Adobe 38040334 | API Reference - Page 497
opening in browser 104 posting data to 20 relative 255 to Flash MX application 106 user names 54 checkout names 93 RDS 53, 57, Spry editing functions 301 inserting functions 303 window functions 173 window.getDeclaredStyle() 307 windows cascading 175 minimizing 178 word wrap 160
-
1 -
2 -
3 -
4 -
5 -
6 -
7 -
8
-
9
-
10
-
11
-
12
-
13
-
14
-
15
-
16
-
17
-
18
-
19
-
20
-
21
-
22
-
23
-
24
-
25
-
26
-
27
-
28
-
29
-
30
-
31
-
32
-
33
-
34
-
35
-
36
-
37
-
38
-
39
-
40
-
41
-
42
-
43
-
44
-
45
-
46
-
47
-
48
-
49
-
50
-
51
-
52
-
53
-
54
-
55
-
56
-
57
-
58
-
59
-
60
-
61
-
62
-
63
-
64
-
65
-
66
-
67
-
68
-
69
-
70
-
71
-
72
-
73
-
74
-
75
-
76
-
77
-
78
-
79
-
80
-
81
-
82
-
83
-
84
-
85
-
86
-
87
-
88
-
89
-
90
-
91
-
92
-
93
-
94
-
95
-
96
-
97
-
98
-
99
-
100
-
101
-
102
-
103
-
104
-
105
-
106
-
107
-
108
-
109
-
110
-
111
-
112
-
113
-
114
-
115
-
116
-
117
-
118
-
119
-
120
-
121
-
122
-
123
-
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
-
132
-
133
-
134
-
135
-
136
-
137
-
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
-
152
-
153
-
154
-
155
-
156
-
157
-
158
-
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
-
174
-
175
-
176
-
177
-
178
-
179
-
180
-
181
-
182
-
183
-
184
-
185
-
186
-
187
-
188
-
189
-
190
-
191
-
192
-
193
-
194
-
195
-
196
-
197
-
198
-
199
-
200
-
201
-
202
-
203
-
204
-
205
-
206
-
207
-
208
-
209
-
210
-
211
-
212
-
213
-
214
-
215
-
216
-
217
-
218
-
219
-
220
-
221
-
222
-
223
-
224
-
225
-
226
-
227
-
228
-
229
-
230
-
231
-
232
-
233
-
234
-
235
-
236
-
237
-
238
-
239
-
240
-
241
-
242
-
243
-
244
-
245
-
246
-
247
-
248
-
249
-
250
-
251
-
252
-
253
-
254
-
255
-
256
-
257
-
258
-
259
-
260
-
261
-
262
-
263
-
264
-
265
-
266
-
267
-
268
-
269
-
270
-
271
-
272
-
273
-
274
-
275
-
276
-
277
-
278
-
279
-
280
-
281
-
282
-
283
-
284
-
285
-
286
-
287
-
288
-
289
-
290
-
291
-
292
-
293
-
294
-
295
-
296
-
297
-
298
-
299
-
300
-
301
-
302
-
303
-
304
-
305
-
306
-
307
-
308
-
309
-
310
-
311
-
312
-
313
-
314
-
315
-
316
-
317
-
318
-
319
-
320
-
321
-
322
-
323
-
324
-
325
-
326
-
327
-
328
-
329
-
330
-
331
-
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
-
343
-
344
-
345
-
346
-
347
-
348
-
349
-
350
-
351
-
352
-
353
-
354
-
355
-
356
-
357
-
358
-
359
-
360
-
361
-
362
-
363
-
364
-
365
-
366
-
367
-
368
-
369
-
370
-
371
-
372
-
373
-
374
-
375
-
376
-
377
-
378
-
379
-
380
-
381
-
382
-
383
-
384
-
385
-
386
-
387
-
388
-
389
-
390
-
391
-
392
-
393
-
394
-
395
-
396
-
397
-
398
-
399
-
400
-
401
-
402
-
403
-
404
-
405
-
406
-
407
-
408
-
409
-
410
-
411
-
412
-
413
-
414
-
415
-
416
-
417
-
418
-
419
-
420
-
421
-
422
-
423
-
424
-
425
-
426
-
427
-
428
-
429
-
430
-
431
-
432
-
433
-
434
-
435
-
436
-
437
-
438
-
439
-
440
-
441
-
442
-
443
-
444
-
445
-
446
-
447
-
448
-
449
-
450
-
451
-
452
-
453
-
454
-
455
-
456
-
457
-
458
-
459
-
460
-
461
-
462
-
463
-
464
-
465
-
466
-
467
-
468
-
469
-
470
-
471
-
472
-
473
-
474
-
475
-
476
-
477
-
478
-
479
-
480
-
481
-
482
-
483
-
484
-
485
-
486
-
487
-
488
-
489
-
490
-
491
-
492
-
493
-
494
-
495
-
496
-
497
 |
 |
API REFERENCE
ADOBE
®
DREAMWEAVER
®
CS
3