Adobe Dreamweaver API Reference CS5 Manual de usuario Pagina 1

ADOBE® DREAMWEAVER® CS5 & CS5.5API Reference

5Last updated 8/27/2013Chapter 2: The file I/O APIAdobe® Dreamweaver® CS5 includes a C shared library called DWfile. The DWfile lets authors of object

95DREAMWEAVER API REFERENCEThe source control integration APILast updated 8/27/2013Argumentsvoid *connectionData, char checkOutName[64], char emailAdd

96DREAMWEAVER API REFERENCEThe source control integration APILast updated 8/27/2013• The successList argument is a list of Boolean values that are pop

97DREAMWEAVER API REFERENCEThe source control integration APILast updated 8/27/2013bool SCS_GetFileCheckoutList()DescriptionThis function returns a li

98DREAMWEAVER API REFERENCEThe source control integration APILast updated 8/27/2013Argumentsvoid *connectionData, char errorMsg[], const int *msgLengt

99DREAMWEAVER API REFERENCEThe source control integration APILast updated 8/27/2013bool SCS_GetDesignNotes()DescriptionThis function retrieves key-val

100DREAMWEAVER API REFERENCEThe source control integration APILast updated 8/27/2013• The noteLength argument is the length of the largest Design note

101DREAMWEAVER API REFERENCEThe source control integration APILast updated 8/27/2013bool SCS_canGet()DescriptionThis function returns whether the Get

102DREAMWEAVER API REFERENCEThe source control integration APILast updated 8/27/2013ReturnsA Boolean value: true if successful; false otherwise.bool S

103DREAMWEAVER API REFERENCEThe source control integration APILast updated 8/27/2013• The remotePath argument is a list of remote filenames or folder

104DREAMWEAVER API REFERENCEThe source control integration APILast updated 8/27/2013ReturnsA Boolean value: true if successful; false otherwise.Exampl

6DREAMWEAVER API REFERENCEThe file I/O APILast updated 8/27/2013 var fileURL = "file:///c|/Config/myconfig.cfg"; var newURL ="file:///

105DREAMWEAVER API REFERENCEThe source control integration APILast updated 8/27/2013ExampleSee “bool SCS_BeforeGet()” on page 103.bool SCS_AfterPut()

106Last updated 8/27/2013Chapter 11: ApplicationThe application functions perform operations related to the Adobe® Dreamweaver® interaction with other

107DREAMWEAVER API REFERENCEApplicationLast updated 8/27/2013 function goToadobe(){ var prevBrowsers = dw.getBrowserList(); var theBrowser = "&

108DREAMWEAVER API REFERENCEApplicationLast updated 8/27/2013ExampleA call to the dreamweaver.getExtensionEditorList(".gif") function might

109DREAMWEAVER API REFERENCEApplicationLast updated 8/27/2013dreamweaver.getPrimaryBrowser()AvailabilityDreamweaver 3.DescriptionGets the path to the

110DREAMWEAVER API REFERENCEApplicationLast updated 8/27/2013ReturnsA string that contains the path on the computer of the user to the secondary brows

111DREAMWEAVER API REFERENCEApplicationLast updated 8/27/2013ArgumentsbookID • The bookID argument, which is required, has the format: ID:pageThe ID p

112DREAMWEAVER API REFERENCEApplicationLast updated 8/27/2013dreamweaver.openWithExternalTextEditor()AvailabilityDreamweaver 3.DescriptionOpens the cu

113DREAMWEAVER API REFERENCEApplicationLast updated 8/27/2013ReturnsA Boolean value: true if Flash MX (or a later version) is installed on the local c

114DREAMWEAVER API REFERENCEApplicationLast updated 8/27/2013Arguments:fileName• The fileName argument is a string that specifies the name of the file

7DREAMWEAVER API REFERENCEThe file I/O APILast updated 8/27/2013 var fileURL = "file:///c|/temp/mydata.txt"; if (DWfile.exists(fileURL)){

115DREAMWEAVER API REFERENCEApplicationLast updated 8/27/2013Example // Launches the notepad application to edit filefoo.txt file. dreamweaver.launch

116DREAMWEAVER API REFERENCEApplicationLast updated 8/27/2013ReturnsA Boolean value that indicates whether the option is on.dreamweaver.quitApplicatio

117DREAMWEAVER API REFERENCEApplicationLast updated 8/27/2013Argumentssource, {title} • The source argument is a string that contains source code, whi

118DREAMWEAVER API REFERENCEApplicationLast updated 8/27/2013Arguments{strCategory}• The strCategoryargument, which is optional, must be one of the fo

119DREAMWEAVER API REFERENCEApplicationLast updated 8/27/2013Argumentsid, idleFunction, interval• The id argument is a unique string used to identify

120DREAMWEAVER API REFERENCEApplicationLast updated 8/27/2013BridgeTalk.bringToFront()AvailabilityDreamweaver CS3.DescriptionMakes the specified appli

121DREAMWEAVER API REFERENCEApplicationLast updated 8/27/2013ReturnsA Boolean value indicating whether communication with the Bridge application was a

122Last updated 8/27/2013Chapter 12: WorkspaceWorkspace API functions create or operate on an element of the Adobe® Dreamweaver® workspace. They perfo

123DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013DescriptionUndoes the previous step in the document.ArgumentsNone.ReturnsNothing.EnablerSee

124DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013ExampleIf the user’s last action applied a Cascading Style Sheet (CSS) style to a selected

8DREAMWEAVER API REFERENCEThe file I/O APILast updated 8/27/2013ArgumentsfileURL • The fileURL argument, which is expressed as a file:// URL, is the f

125DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013DescriptionStarts recording steps in the active document; the previously recorded command i

126DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013dreamweaver.historyPalette.clearSteps()AvailabilityDreamweaver 3.DescriptionClears all step

127DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013ReturnsAn array that contains the position indices of all the selected steps. The first pos

128DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013ExampleIf the three steps shown in the following example are selected in the History panel,

129DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013ExampleA call to dreamweaver.historyPalette.replaySteps([0,2,3]) function plays the first,

130DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013dreamweaver.historyPalette.setUndoState()AvailabilityDreamweaver 3.DescriptionPerforms the

131DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013DescriptionSets the default object for a pop-up menu. The default object’s icon represents

132DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013ArgumentsforceUpdate• The forceUpdate argument is a Boolean value that indicates whether to

133DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013dom.arrowDown()AvailabilityDreamweaver 3.DescriptionMoves the insertion point down the spec

134DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013Arguments{nTimes}, {bShiftIsDown}• The nTimes argument, which is optional, is the number of

9DREAMWEAVER API REFERENCEThe file I/O APILast updated 8/27/2013 var file1 = "file:///c|/temp/file1.txt"; var time1 = DWfile.getCreationDat

135DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013dom.deleteKey()AvailabilityDreamweaver 3.DescriptionThis function is equivalent to pressing

136DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013Arguments{bShiftIsDown} • The bShiftIsDown argument, which is optional, is a Boolean value

137DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013dom.pageDown()AvailabilityDreamweaver 3.DescriptionMoves the insertion point down one page

138DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013Arguments{nTimes}, {bShiftIsDown} • The nTimes argument, which is optional, is the number o

139DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013dom.startOfLine()AvailabilityDreamweaver 3.DescriptionMoves the insertion point to the begi

140DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013dreamweaver.getMenuNeedsUpdating()AvailabilityDreamweaver 3.DescriptionChecks whether the s

141DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013ArgumentsNone.ReturnsNothing.Results window functionsResults window functions let you inter

142DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013Note: This function is supported only in the Validation, Browser Compatibility Check, and S

143DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013• The strDisplay argument is the string to display to the user in the first column of the R

144DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013dreamweaver.resultsPalette.cut()AvailabilityDreamweaver MX.DescriptionSends a cut message t

10DREAMWEAVER API REFERENCEThe file I/O APILast updated 8/27/2013DescriptionThis function gets the size of a specified file.ArgumentsfileURL • The fil

145DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013ReturnsNothing.EnablerSee “dreamweaver.resultsPalette.canOpenInBrowser()” on page 516.drea

146DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013dreamweaver.resultsPalette.selectAll()AvailabilityDreamweaver MX.DescriptionSends a Select

147DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013Note: Use only on stand-alone results windows created with “dreamweaver.createResultsWindow

148DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013ArgumentsitemIndex • The itemIndex argument is the index of the item whose data is to be re

149DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013ArgumentscmdDoc, arrButtons• The cmdDoc argument is a document object that represents the c

150DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013resWin.setFileList()AvailabilityDreamweaver 4.DescriptionGives the Results window a list of

151DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013ReturnsNothing.resWin.startProcessing()AvailabilityDreamweaver 4.DescriptionStarts processi

152DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013Additionally, the Server Debug panel can display debug data from other server models. To se

153DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013 <serverdebuginfo> <context> <template><![CDATA[/ooo/master.cfm]]>

154DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013dom.getHideAllVisualAids()AvailabilityDreamweaver 4.DescriptionThis function determines whe

11DREAMWEAVER API REFERENCEThe file I/O APILast updated 8/27/2013ArgumentsfileURL • The fileURL argument, which is expressed as a file:// URL, is the

155DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013dom.getShowFrameBorders()AvailabilityDreamweaver 3.DescriptionThis function gets the curren

156DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013dom.getShowInvalidHTML()AvailabilityDreamweaver 4.DescriptionThis function determines wheth

157DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013dom.getShowLayerBorders()AvailabilityDreamweaver 3.DescriptionThis function gets the curren

158DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013dom.getShowSyntaxColoring()AvailabilityDreamweaver 4.DescriptionThis function determines wh

159DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013dom.getShowTracingImage()AvailabilityDreamweaver 3.DescriptionThis function gets the curren

160DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013dom.setEditNoFramesContent()AvailabilityDreamweaver 3.DescriptionThis function toggles the

161DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013ArgumentsbPreventLayerOverlaps • The bPreventLayerOverlaps argument is a Boolean value: tru

162DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013DescriptionThis function toggles the View > Head Content option on and off.ArgumentsbSho

163DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013dom.setShowInvisibleElements()AvailabilityDreamweaver 3.DescriptionThis function toggles th

164DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013ReturnsNothing.dom.setShowRulers()AvailabilityDreamweaver 3.DescriptionThis function toggle

12DREAMWEAVER API REFERENCEThe file I/O APILast updated 8/27/2013DWfile.setAttributes()AvailabilityDreamweaver MX.DescriptionThis function sets the sy

165DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013ReturnsNothing.dom.setShowToolbar()AvailabilityDreamweaver 4.DescriptionThis function shows

166DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013ReturnsNothing.dom.setSnapToGrid()AvailabilityDreamweaver 3.DescriptionThis function toggle

167DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013DescriptionThis function gets the current state of the View > Status Bar option.Argument

168DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013ArgumentsNone.ReturnsA Boolean value: true if line numbers appear; false otherwise.dreamwea

169DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013ReturnsNothing.dreamweaver.htmlInspector.setShowInvalidHTML()AvailabilityDreamweaver 4.Desc

170DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013ArgumentsbShow • The bShow argument is a Boolean value: true indicates that the syntax colo

171DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013dreamweaver.setShowStatusBar()AvailabilityDreamweaver 3.DescriptionThis function toggles th

172DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013Toolbar functionsThe following JavaScript functions let you get and set the visibility of t

173DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013 var tb_ids = new Array(); tb_ids = dom.getToolbarIdArray();dom.getToolbarItemValue()Avail

174DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013Argumentstoolbar_id • The toolbar_id argument is the ID of the toolbar, which is the value

13DREAMWEAVER API REFERENCEThe file I/O APILast updated 8/27/2013• The text argument indicates the string the function has to write.• The mode argumen

175DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013• The toolbarItemId argument is a string that specifies the ID of the toolbar item.• The at

176DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013Note: There is no way to determine the current position of a toolbar.Argumentstoobar_id, po

177DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013 var dom = dw.getDocumentDOM(); if(dom != null && dom.getToolbarVisibility("m

178DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013ReturnsOne of the following strings: • The "head" string if the HEAD area is acti

179DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013ArgumentsviewString • The viewString argument is the view to produce; it must be one of the

180DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013 dw.cascade()dreamweaver.getActiveWindow()AvailabilityDreamweaver 3.DescriptionThis functio

181DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013ReturnsA Boolean value: true if any panel is visible; false otherwise.dreamweaver.getFloate

182DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013ReturnsA Boolean value: true if the floating panel is visible and in the front; false other

183DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013ArgumentsNone.Returns The "design" or "code" strings, depending on whic

184DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013ArgumentsdocumentObject, {bActivateFrame} • The documentObject argument is the object at th

14Last updated 8/27/2013Chapter 3: The HTTP APIExtensions are not limited to working in the local file system. Adobe® Dreamweaver® provides a mechanis

185DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013• The bIsVisible argument is a Boolean value that indicates whether to make the floating pa

186DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013ArgumentssnapDistance • The snapDistance argument is an integer that represents the snappin

187DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013dreamweaver.tileVertically()AvailabilityDreamweaver MX (Windows only), Dreamweaver 8 (added

188DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013DescriptionThis function updates the Reference floating panel. If the Reference floating pa

189DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013Related files functionsThe related files functions enhance the editing experience of coders

190DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013ArgumentsNone.ReturnsA string that is the absolute local URL of the related file.dreamweave

191DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013ArgumentsNone.ReturnsAn array of String objects representing extensions of the files shown

192DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013dreamweaver.setDynamicRelatedFilesDiscoverySetting()AvailabilityDreamweaver CS5.Description

193DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013ArgumentsNone.ReturnsNone.dreamweaver.canSaveAllRelatedFiles()AvailabilityDreamweaver CS5.D

194DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013A Boolean: true to apply the filter selected in the Related Files bar to the result. Use fa

Last updated 8/27/2013Legal noticesLegal noticesFor legal notices, see http://help.adobe.com/en_US/legalnotices/index.html.

15DREAMWEAVER API REFERENCEThe HTTP APILast updated 8/27/2013DescriptionDeletes the _mmServerScripts folder—and all its files—under the root folder fo

195DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013If you are an extension developer, make sure that you invoke the refreshRelatedFiles() func

196DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013DWFilenameFilter referenceThe objects of type DWFilenameFilter are new to Dreamweaver CS5 a

197DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013DWFilenameFilter.doesExcludeExtension()AvailabilityDreamweaver CS5.DescriptionThis function

198DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013ArgumentsNone.ReturnsA Boolean: true if the filter matches any file.DWFilenameFilter.getExp

199DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013ArgumentsNone.ReturnsAn array of string objects representing the extensions that are to be

200DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013DescriptionThis function is used to add an extension to the filter object’s exclusion list.

201DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013Vertical Split view functionsThe Vertical Split view functions facilitate a side-by-side vi

202DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013DescriptionThis function gets the name of the primary view. In Split view or Split code, th

203DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013ArgumentsNone.ReturnsA Boolean value: true if a related file view is open, false otherwise.

204DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013DescriptionThis function determines whether the selection in Code view is entirely within a

16DREAMWEAVER API REFERENCEThe HTTP APILast updated 8/27/2013 <html> <head> <title>Clean Up Temp Files on Shutdown</title>

205DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013dom.collapseSelectedCodeFragmentInverse()AvailabilityDreamweaver 8.DescriptionThis function

206DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013dom.expandSelectedCodeFragments()AvailabilityDreamweaver 8.DescriptionThis function expands

207DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013dreamweaver.htmlInspector.collapseFullTagInverse()AvailabilityDreamweaver 8.DescriptionThis

208DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013 dreamweaver.htmlInspector.collapseSelectedCodeFragment(true);dreamweaver.htmlInspector.col

209DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013dreamweaver.htmlInspector.expandSelectedCodeFragments()AvailabilityDreamweaver 8.Descriptio

210DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013dom.getShowHiddenCharacters()AvailabilityDreamweaver 8.DescriptionThis function determines

211DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013DescriptionThis function inserts the text specified in the beforeText argument before the c

212DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013DescriptionThis function removes comments. If you specify no arguments, it removes all type

213DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013dreamweaver.htmlInspector.setShowHiddenCharacters()AvailabilityDreamweaver 8.DescriptionThi

214DREAMWEAVER API REFERENCEWorkspaceLast updated 8/27/2013Examplevar panelColorArray = dw.getPanelColor();The return values for this example are:• pa

17DREAMWEAVER API REFERENCEThe HTTP APILast updated 8/27/2013• 12: Lock violation• 13: Disk full• 14: End of file reachedExampleThe following code get

215Last updated 8/27/2013Chapter 13: SiteThe Adobe® Dreamweaver® CS5 site functions perform operations related to managing a website. These operations

216DREAMWEAVER API REFERENCESiteLast updated 8/27/2013Site functionsSite functions handle operations that are related to files in the site files. Thes

217DREAMWEAVER API REFERENCESiteLast updated 8/27/2013ReturnsA string, which specifies the site-relative URI.ExampleThe following example returns &quo

218DREAMWEAVER API REFERENCESiteLast updated 8/27/2013ReturnsNothing.ExampleThe following example compares two files, red.htm and blue.htm: dw.compare

219DREAMWEAVER API REFERENCESiteLast updated 8/27/2013DescriptionThis function runs the file compare application specified in the File Compare Categor

220DREAMWEAVER API REFERENCESiteLast updated 8/27/2013dreamweaver.siteSyncDialog.markIgnore()AvailabilityDreamweaver 8.DescriptionThis function change

221DREAMWEAVER API REFERENCESiteLast updated 8/27/2013ReturnsNothing.EnablerSee “dreamweaver.siteSyncDialog.canMarkSynced()” on page 519.dreamweaver.

222DREAMWEAVER API REFERENCESiteLast updated 8/27/2013ArgumentsNone.ReturnsNothing.site.changeLink()AvailabilityDreamweaver 3.DescriptionOpens the Sel

223DREAMWEAVER API REFERENCESiteLast updated 8/27/2013site.checkLinks()AvailabilityDreamweaver 3.DescriptionOpens the Link Checker dialog box and chec

224DREAMWEAVER API REFERENCESiteLast updated 8/27/2013DescriptionRuns a target browser check on the selected files.ArgumentsNone.ReturnsNothing.site.c

18DREAMWEAVER API REFERENCEThe HTTP APILast updated 8/27/2013MMHttp.getText()AvailabilityDreamweaver UltraDev 4, enhanced in Dreamweaver MX. Descripti

225DREAMWEAVER API REFERENCESiteLast updated 8/27/2013ReturnsA Boolean value: true if the compare succeeded; false otherwise.EnablerSee “site.canCompa

226DREAMWEAVER API REFERENCESiteLast updated 8/27/2013DescriptionPuts a specified file (or files) in the testing server’s bin folder. If the current s

227DREAMWEAVER API REFERENCESiteLast updated 8/27/2013ReturnsNothing.EnablerSee “site.canDisplaySyncInfoForFile()” on page 522.site.editColumns()Desc

228DREAMWEAVER API REFERENCESiteLast updated 8/27/2013ExampleThe following example shows a sample XML file that Dreamweaver creates when you export a

229DREAMWEAVER API REFERENCESiteLast updated 8/27/2013servermodel="ColdFusion" urlprefix="http://dreamweaver/kojak/" serverscrip

230DREAMWEAVER API REFERENCESiteLast updated 8/27/2013site.getAppServerAccessType()AvailabilityDreamweaver MX.DescriptionReturns the access method tha

231DREAMWEAVER API REFERENCESiteLast updated 8/27/2013site.getAppURLPrefixForSite()AvailabilityDreamweaver MX.DescriptionGets the value of the URL pre

232DREAMWEAVER API REFERENCESiteLast updated 8/27/2013ArgumentsfileName • The fileName argument is the path to the file being queried, which is expres

233DREAMWEAVER API REFERENCESiteLast updated 8/27/2013site.getCurrentSite()AvailabilityDreamweaver 3.DescriptionGets the current site.ArgumentsNone.Re

234DREAMWEAVER API REFERENCESiteLast updated 8/27/2013ArgumentsNone.ReturnsThe path to the files residing on the local computer for the current site.s

19DREAMWEAVER API REFERENCEThe HTTP APILast updated 8/27/2013DescriptionPerforms an HTTP post of the specified data to the specified URL. Typically, t

235DREAMWEAVER API REFERENCESiteLast updated 8/27/2013ArgumentsfileURL • The fileURL argument is the fully qualified URL (including the string "f

236DREAMWEAVER API REFERENCESiteLast updated 8/27/2013site.getSiteURLPrefix()AvailabilityDreamweaver 8.DescriptionGets the site URL prefix that is ext

237DREAMWEAVER API REFERENCESiteLast updated 8/27/2013ArgumentssiteOrURL • The siteOrURL argument must contain one of the following two values: • The

238DREAMWEAVER API REFERENCESiteLast updated 8/27/2013EnablerSee “site.canMakeEditable()” on page 524.site.makeNewDreamweaverFile()AvailabilityDreamw

239DREAMWEAVER API REFERENCESiteLast updated 8/27/2013ArgumentsNone.ReturnsNothing.site.open()AvailabilityDreamweaver 3.DescriptionOpens the files tha

240DREAMWEAVER API REFERENCESiteLast updated 8/27/2013EnablerSee “site.canPut()” on page 525.site.recreateCache()AvailabilityDreamweaver 3.Descriptio

241DREAMWEAVER API REFERENCESiteLast updated 8/27/2013ArgumentsNone.ReturnsA Boolean value that indicates whether a remote site has been defined and,

242DREAMWEAVER API REFERENCESiteLast updated 8/27/2013ArgumentswhichSide • The whichSide argument must be either "local" or "remote&quo

243DREAMWEAVER API REFERENCESiteLast updated 8/27/2013ReturnsNone.site.setConnectionState()AvailabilityDreamweaver 3.DescriptionSets the connection st

244DREAMWEAVER API REFERENCESiteLast updated 8/27/2013DescriptionGives focus to a specified pane in the Files panel. If the specified pane is not show

20DREAMWEAVER API REFERENCEThe HTTP APILast updated 8/27/2013ArgumentscallbackFunc, URL, dataToPost, {contentType}, {serverScriptsFolder}• The callbac

245DREAMWEAVER API REFERENCESiteLast updated 8/27/2013ExampleThe following example var filePath = site.siteRelativeToLocalPath("/myWebApp/myFile.

246DREAMWEAVER API REFERENCESiteLast updated 8/27/2013site.uncloakAll()AvailabilityDreamweaver MX.DescriptionUncloaks all folders in the current site

247Last updated 8/27/2013Chapter 14: DocumentThe Document functions in Adobe® Dreamweaver® perform operations that affect the document on which the us

248DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013DescriptionOpens the Convert Tables to Layers dialog box.ArgumentsNone.ReturnsNothing.Enable

249DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013ArgumentscommandFile, {commandArg1}, {commandArg2},...{commandArgN} • The commandFile argume

250DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013• The style elements that do not have a type attribute and cannot be fixed• The img elements

251DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013ExampleIn normal use, an extension first calls the dreamweaver.openDocument() or dreamweaver

252DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013• You can specify the extensions as .xxx[;.yyy;.zzz] or CCCC:• .xxx specifies the filename e

253DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013dreamweaver.closeDocument()AvailabilityDreamweaver 2.DescriptionCloses the specified documen

254DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013dreamweaver.createXHTMLDocument() AvailabilityDreamweaver MX.DescriptionDepending on the arg

21Last updated 8/27/2013Chapter 4: The Design Notes APIAdobe® Dreamweaver®, Adobe® Fireworks®, and Adobe® Flash® give web designers and developers a w

255DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013dreamweaver.createXMLDocument()AvailabilityDreamweaver MX.DescriptionCreates and opens a new

256DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013dreamweaver.getDocumentDOM()AvailabilityDreamweaver 2.DescriptionProvides access to the obje

257DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013dreamweaver.getNewDocumentDOM()AvailabilityDreamweaver MX; added documentType argument in Dr

258DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013Arguments{filePath} • The filePath argument, which is optional, is a string that specifies t

259DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013dreamweaver.openDocument()AvailabilityDreamweaver 2.DescriptionOpens a document for editing

260DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013dreamweaver.openInFrame()AvailabilityDreamweaver 3.DescriptionOpens the Open In Frame dialog

261DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013DescriptionReverts the specified document to the previously saved version.ArgumentsdocumentO

262DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013ArgumentsdocumentObject, {fileURL}• The documentObject argument is the object at the root of

263DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013ReturnsNothing.EnablerSee “dreamweaver.canSaveDocumentAsTemplate()” on page 508.dreamweaver

264DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013Global document functionsGlobal document functions act on an entire document. They check spe

22DREAMWEAVER API REFERENCEThe Design Notes APILast updated 8/27/2013ArgumentsfileHandle • The fileHandle argument is the file handle that the MMNotes

265DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013ArgumentsNone.ReturnsA string that specifies the current parsing mode: "html", &qu

266DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013• If the controlString argument is "auto-explicit", Dreamweaver prompts the user t

267DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013Argumentslocation, message, timeout• The location argument is a string that specifies a tool

268DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013DescriptionUses the internal Dreamweaver URL decoding mechanism to decode special characters

269DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013• Dreamweaver does not return references for unnamed objects. If an object does not contain

270DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013Argumentssection, key, default_value • The section argument is a string that specifies the p

271DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013dreamweaver.setPreferenceString()AvailabilityDreamweaver MX.Note: To access the preferences

272DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013Path functionsPath functions get and manipulate the paths to various files and folders on a

273DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013ArgumentsNone.ReturnsThe path to the application configurations.ExampleThe following functio

274DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013ReturnsEither a string that contains the URL of the local root folder of the site where the

23DREAMWEAVER API REFERENCEThe Design Notes APILast updated 8/27/2013MMNotes.getKeyCount()DescriptionThis function gets the number of key/value pairs

275DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013ReturnsAn absolute URL string. The return value is generated, as described in the following

276DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013ArgumentsNone.ReturnsA Boolean value: true if the URI is relative.DWUri.isDirectory()Availab

277DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013DescriptionDetermines if the URI object has the specified service type scheme. The URI objec

278DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013DWUri.getAuthority()AvailabilityDreamweaver CS5.DescriptionRetrieves the domain authority. T

279DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013DWUri.getServerPort()AvailabilityDreamweaver CS5.DescriptionRetrieves the server port. The U

280DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013DWUri.getFragmentAvailabilityDreamweaver CS5.DescriptionRetrieves the URI anchor fragment. T

281DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013ReturnsNone.DWUri.setAuthority()AvailabilityDreamweaver CS5.DescriptionSets the domain autho

282DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013ArgumentspasswordThe argument specifies the password.ReturnsNone.DWUri.setPath()Availability

283DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013DWUri.setQuery()AvailabilityDreamweaver CS5.DescriptionSets the query string of the URI obje

284DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013ReturnsNone.DWUri.getQueryValue()AvailabilityDreamweaver CS5.DescriptionRetrieves the value

24DREAMWEAVER API REFERENCEThe Design Notes APILast updated 8/27/2013ArgumentsfileURL • The fileURL argument, which is expressed as a file:// URL, is

285DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013DescriptionRetrieves the query property object of the URI object.Changes to the property map

286DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013The URI to compare against. Specify a valid string or a DWUri object.ReturnsInteger that spe

287DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013DWUri.makeRelative()AvailabilityDreamweaver CS5.DescriptionConstructs a relative URI by find

288DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013ReturnsA string that specifies the filename.DWUri.getExtension()AvailabilityDreamweaver CS5.

289DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013ArgumentsNone.ReturnsA string that specifies the last path part.DWUri.isUnderDirectory()Avai

290DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013ArgumentsA string specifying the local filename that needs to be encoded as a URI.ReturnsNot

291DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013For complex selections (multiple table cells, multiple layers, or multiple image map hotspot

292DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013ReturnsAn array that contains two integers. The first integer is the character offset of the

293DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013DescriptionPerforms a Select All operation.Note: In most cases, this function selects all th

294DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013ArgumentsoffsetBegin, offsetEnd • These arguments are the opening and closing points, respec

iiiLast updated 8/27/2013ContentsChapter 1: IntroductionAbout extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

25DREAMWEAVER API REFERENCEThe Design Notes APILast updated 8/27/2013ArgumentsfileURL • The fileURL argument, which is expressed as a file:// URL, is

295DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013 function applyFormatToSelectedTable(){ // get current selection var selObj = dw.getDocu

296DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013dreamweaver.doURLEncoding()AvailabilityDreamweaver 1.DescriptionTakes a string and returns a

297DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013• "my arg 1"• 34dreamweaver.latin1ToNative()AvailabilityDreamweaver 2.DescriptionC

298DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013DescriptionScans a string of HTML and finds the tags, attributes, directives, and text. For

299DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013• The parserCallbackObj argument is a JavaScript object that has one or more of the followin

300DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013ReturnsNothing.dreamweaver.editLockedRegions()AvailabilityDreamweaver 2.DescriptionDepending

301DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013DescriptionThis function specifies that the values that dom.nodeToOffsets() and dom.getSelec

302DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013MMXSLT.getXMLSchema()AvailabilityDreamweaver 8.DescriptionThis function returns the schema t

303DREAMWEAVER API REFERENCEDocumentLast updated 8/27/2013 var theXMLSource = MMXSLT.getXMLSourceURI("file:///c:/myxslt/myxsltdocument.xsl")

304Last updated 8/27/2013Chapter 15: Page contentThe Adobe® Dreamweaver® page content functions perform operations that affect the content of a web pa

26DREAMWEAVER API REFERENCEThe Design Notes APILast updated 8/27/2013MMNotes.set()DescriptionThis function creates or updates one key/value pair in a

305DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013DescriptionAdds elements that are selected in the Site list to the Favorites list and gi

306DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013DescriptionEdits selected elements with primary external editor or Custom Edit control.

307DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013• The type string, which is either "folder" or one of the following categories

308DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013dreamweaver.assetPalette.locateInSite()AvailabilityDreamweaver 4.DescriptionSelects file

309DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013ReturnsNothing.dreamweaver.assetPalette.recreateLibraryFrom Document() AvailabilityDream

310DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013ReturnsNothing.dreamweaver.assetPalette.renameNickname()AvailabilityDreamweaver 4.Descri

311DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013ArgumentsviewType • The viewType argument is a string that can be "site" or &q

312DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013dom.addBehavior()AvailabilityDreamweaver 3.DescriptionAdds a new event/action pair to th

313DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013dom.reapplyBehaviors()AvailabilityDreamweaver 3.DescriptionChecks to make sure that the

314DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013ArgumentsNone.ReturnsA DOM object or a null value. This function returns a null value un

27DREAMWEAVER API REFERENCEThe Design Notes APILast updated 8/27/2013ArgumentsnoteHandle• The noteHandle argument is the file handle that the OpenNote

315DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013ExampleIf you write an action that can be applied only to a hypertext link (A HREF), you

316DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013DescriptionGets the event/action pair at the specified position in the Behaviors panel.A

317DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013DescriptionGets the position of the selected action in the Behaviors panel. ArgumentsNon

318DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013ExampleCalling the dreamweaver.behaviorInspector.moveBehaviorDown(2) function swaps the

319DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013ExampleCalling the dreamweaver.behaviorInspector.moveBehaviorUp(3) function swaps the po

320DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013ExampleCalling the dreamweaver.behaviorInspector.setSelection(2) function selects the Ch

321DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013dom.clipCopyText()AvailabilityDreamweaver 3.DescriptionCopies the selected text to the C

322DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013EnablerSee “dom.canClipPaste()” on page 493.ExampleIf the Clipboard contains ABC Widget

323DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013ReturnsNothing.EnablerSee “dreamweaver.canClipCut()” on page 503.dreamweaver.clipPaste(

324DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013ReturnsA string that contains the contents of the Clipboard, if the Clipboard contains t

28DREAMWEAVER API REFERENCEThe Design Notes APILast updated 8/27/2013 FileHandle noteHandle = OpenNotesFile("file:///c|/sites/avocado8/iwjs/welco

325DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013DescriptionDetaches the selected library item instance from its associated LBI file by r

326DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013ArgumentsNone.ReturnsAn array of element nodes.Example“dom.getSelectedEditableRegion()”

327DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013ArgumentsNone.ReturnsAn index into the array that the dom.getEditbableRegionList() funct

328DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013EnablerSee “dom.canMarkSelectionAsEditable()” on page 498.dom.newEditableRegion()Availa

329DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013DescriptionUpdates the document’s library items, templates, or both. This function is va

330DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013• Meta• Navigation• TextSnippet files are XML documents, so you can specify the encoding

331DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013dreamweaver.snippetPalette.newFolder()AvailabilityDreamweaver MX.DescriptionCreates a ne

332DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013dreamweaver.snippetPalette.insert()AvailabilityDreamweaver MX.DescriptionApplies the sel

333DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013DescriptionActivates a text box around the selected folder name or file nickname and let

334DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013element.removeTranslatedAttribute()AvailabilityDreamweaver CS3.DescriptionThis function

29DREAMWEAVER API REFERENCEThe Design Notes APILast updated 8/27/2013• The keyBufArray[64] argument is the buffer array where the keys are stored. • T

335DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013element.translatedClassNameAvailabilityDreamweaver CS3.DescriptionThis function is the s

336DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013Example function objectTag() { . . . var dom = dw.getDocumentDOM(); var id = dwscr

337DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013ReturnsAn array of strings that are expressed as file://URLs. Each string represents a f

338DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013Browser compatibility check functionsThe following functions facilitate locating combina

339DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013DescriptionGets the CSS styles that are declared for the specified element. Differs from

340DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013ReturnsAn integer representing the minimum display width of the specified container, in

341DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013Example [...] var blocks = DOM.getBlockElements(); var dProps = null, children = null;

342DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013Example [...] var DOM = dw.getDocumentDOM(); var inEls = DOM.body.getInlineElements();

343DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013ArgumentsNone.ReturnsAn array of element nodes. Example [...] var DOM = dw.getDocumentD

344DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013elem.isInlineElement()AvailabilityDreamweaver CS3.DescriptionChecks whether the element

30DREAMWEAVER API REFERENCEThe Design Notes APILast updated 8/27/2013BOOL GetVersionName()DescriptionThis function gets the version name of the MMNote

345DREAMWEAVER API REFERENCEPage contentLast updated 8/27/2013Example [...] var DOM = dw.getDocumentDOM(); var floats = issueUtils.getFloats(DOM.bod

346Last updated 8/27/2013Chapter 16: Dynamic documentsThe dynamic documents functions in Adobe® Dreamweaver® perform operations that are related to we

347DREAMWEAVER API REFERENCEDynamic documentsLast updated 8/27/2013ReturnsNothing.Data source functionsData source files are stored in the Configurati

348DREAMWEAVER API REFERENCEDynamic documentsLast updated 8/27/2013dw.dbi.setExpanded()AvailabilityDreamweaver CS3.DescriptionSets the node to be expa

349DREAMWEAVER API REFERENCEDynamic documentsLast updated 8/27/2013ExampleThe following example retrieves the location attribute value for the insertT

350DREAMWEAVER API REFERENCEDynamic documentsLast updated 8/27/2013DescriptionRetrieves the name of the group, which is the equivalent to the server b

351DREAMWEAVER API REFERENCEDynamic documentsLast updated 8/27/2013DescriptionReturns the initialization tags for the currently active document. The i

352DREAMWEAVER API REFERENCEDynamic documentsLast updated 8/27/2013• In the URL text field that appears at the top of the document when you click the

353DREAMWEAVER API REFERENCEDynamic documentsLast updated 8/27/2013• Returns the HTML response to the caller.Argumentsstring• A single string, which t

354DREAMWEAVER API REFERENCEDynamic documentsLast updated 8/27/2013ArgumentsbIsVisible • The bIsVisible argument is a Boolean value that indicates whe

31DREAMWEAVER API REFERENCEThe Design Notes APILast updated 8/27/2013ReturnsA Boolean value: true indicates the operation is successful; false otherwi

355DREAMWEAVER API REFERENCEDynamic documentsLast updated 8/27/2013ArgumentsNone.ReturnsNothing.Live view functionsLive view functions are used for th

356DREAMWEAVER API REFERENCEDynamic documentsLast updated 8/27/2013ReturnsNone.dom.getLiveViewUsingServer()AvailabilityDreamweaver CS4.DescriptionThis

357DREAMWEAVER API REFERENCEDynamic documentsLast updated 8/27/2013ReturnsA Boolean value. If the default action is to preview a page using a server,

358DREAMWEAVER API REFERENCEDynamic documentsLast updated 8/27/2013ReturnsNone.dom.setLiveViewFollowsLinks()DescriptionThis function is used to enable

359DREAMWEAVER API REFERENCEDynamic documentsLast updated 8/27/2013ArgumentsNoneReturnsboolA Boolean value that indicates whether the Live view mode i

360DREAMWEAVER API REFERENCEDynamic documentsLast updated 8/27/2013ReturnsboolA Boolean value that indicates whether the particular browser command is

361DREAMWEAVER API REFERENCEDynamic documentsLast updated 8/27/2013A Boolean value that indicates whether the browser is tracking the pages.dom.browse

362DREAMWEAVER API REFERENCEDynamic documentsLast updated 8/27/2013ArgumentsNoneReturnsintAn integer representing the user’s current position in the b

363DREAMWEAVER API REFERENCEDynamic documentsLast updated 8/27/2013dom.browser.setHomePage()AvailabilityDreamweaver CS5.DescriptionThis function is us

364DREAMWEAVER API REFERENCEDynamic documentsLast updated 8/27/2013DescriptionThis function is used to get the current selection from the browser in L

32DREAMWEAVER API REFERENCEThe Design Notes APILast updated 8/27/2013ReturnsA Boolean value: true indicates the operation is successful; false otherwi

365DREAMWEAVER API REFERENCEDynamic documentsLast updated 8/27/2013DescriptionThis function loads an HTML string directly into the browser control. Th

366DREAMWEAVER API REFERENCEDynamic documentsLast updated 8/27/2013At the head of the document, you must have a script that looks like the following:v

367DREAMWEAVER API REFERENCEDynamic documentsLast updated 8/27/2013Dreamweaver 13.1 and laterfunction OnMMBrowserCtrlLoaded(e) { liveViewWindow =

368DREAMWEAVER API REFERENCEDynamic documentsLast updated 8/27/2013Example 1Assume that the live view content invokes "GetUserName " and use

369DREAMWEAVER API REFERENCEDynamic documentsLast updated 8/27/2013Prior to Dreamweaver 13.1DW code: function loadString(str) { return dw.loadStri

370DREAMWEAVER API REFERENCEDynamic documentsLast updated 8/27/2013 var retval; for (i=0;i<gLocNameStrArray.length;i++) { if (

371DREAMWEAVER API REFERENCEDynamic documentsLast updated 8/27/2013Dreamweaver 13.1 and laterDW code: liveViewBrowser = document.getElementById('

372DREAMWEAVER API REFERENCEDynamic documentsLast updated 8/27/2013dreamweaver.serverBehaviorInspector.getServer Behaviors()AvailabilityDreamweaver Ul

373DREAMWEAVER API REFERENCEDynamic documentsLast updated 8/27/2013Server model functionsIn Dreamweaver, each document has an associated document type

374DREAMWEAVER API REFERENCEDynamic documentsLast updated 8/27/2013ArgumentsNone.ReturnsAn array of objects where each object contains the following t

33Last updated 8/27/2013Chapter 5: Fireworks integration FWLaunch is a C shared library that lets authors of objects, commands, behaviors, and Propert

375DREAMWEAVER API REFERENCEDynamic documentsLast updated 8/27/2013DescriptionReturns the following list of properties, which let you access:• Transla

376DREAMWEAVER API REFERENCEDynamic documentsLast updated 8/27/2013dom.serverModel.getServerInfo()AvailabilityDreamweaver MX.DescriptionReturns inform

377DREAMWEAVER API REFERENCEDynamic documentsLast updated 8/27/2013ReturnsA string that contains the server name. dom.serverModel.getServerSupportsCha

378DREAMWEAVER API REFERENCEDynamic documentsLast updated 8/27/2013dom.serverModel.testAppServer()AvailabilityDreamweaver MX.DescriptionTests whether

379Last updated 8/27/2013Chapter 17: DesignThe Design functions in Adobe® Dreamweaver® perform operations related to designing the appearance of a doc

380DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013• “create_and_import" - write CSS in cssFileName and import.• cssFileName is the name of

381DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013ArgumentslayoutIndex• layoutIndex is an integer, zero-based index specifying the layout. This

382DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013ArgumentselementNode, styleName, {classOrID}, {bForceNesting} • The elementNode argument is an

383DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013ExampleThe following example changes the status of the selected element to "full" if

384DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013 var currentDOM = dw.getDocumentDOM(); if (currentDOM.getShowDivBoxModel() == false){ curren

34DREAMWEAVER API REFERENCEFireworks integrationLast updated 8/27/2013FWLaunch.execJsInFireworks()AvailabilityDreamweaver 3, Fireworks 3.DescriptionTh

385DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013dom.resetAllElementViews()AvailabilityDreamweaver 8.DescriptionThis function resets the Elemen

386DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013ReturnsNothing.ExampleSee “dom.getElementView()” on page 382.dom.setShowDivBackgrounds()Avail

387DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013dom.setShowDivOutlines()AvailabilityDreamweaver 8.DescriptionThis function turns the Layout Bl

388DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013ReturnsNone.dreamweaver.cssRuleTracker.editSelectedRule()AvailabilityDreamweaver MX 2004.Descr

389DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013Arguments{pane} • The pane argument, which is optional, is a string that specifies the pane of

390DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013ReturnsNothing.EnablerSee “dreamweaver.cssStylePalette.canDeleteSelectedStyle()” on page 511.

391DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013ReturnsNothing.EnablerSee “dreamweaver.cssStylePalette.canEditSelectedStyle()” on page 512.dr

392DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013dreamweaver.cssStylePalette.getDisplayStyles()AvailabilityDreamweaver 8.DescriptionThis functi

393DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013ArgumentsfullSelector • The fullSelector argument is a Boolean value that indicates whether th

394DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013• The bGetFullSelector argument is optional. It is a Boolean value that, if true, returns the

ivDREAMWEAVER API REFERENCEContentsLast updated 8/27/2013Chapter 10: The source control integration APIHow source control integration with Dreamweaver

35DREAMWEAVER API REFERENCEFireworks integrationLast updated 8/27/2013• File I/O error, which indicates that Fireworks cannot create a Response file b

395DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013Arguments{pane} • The pane argument, which is optional, is a string that specifies the pane of

396DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013ReturnsNothing.Example dw.cssStylePalette.setMediaType("print");dreamweaver.getBlock

397DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013ReturnsAn array of strings that contains three strings:• color, which is the hexadecimal value

398DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013ArgumentsforWhat, color, width, {style} • The forWhat argument, which is required, is a string

399DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013 var currentDOM = dw.getDocumentDOM(); var divColors = currentDOM.getDivBackgroundColors(&quo

400DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013dreamweaver.deleteAllDisabled()AvailabilityDreamweaver CS5.DescriptionThis function deletes al

401DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013ReturnsA Boolean value: true if the selected style can be disabled.dreamweaver.canDeleteAllDis

402DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013DescriptionGets a list of all the named frames in the frameset.ArgumentsNone.ReturnsAn array o

403DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013dom.splitFrame()AvailabilityDreamweaver 3.DescriptionSplits the selected frame vertically or h

404DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013dom.arrange()AvailabilityDreamweaver 3.DescriptionMoves the selected hotspots in the specified

36DREAMWEAVER API REFERENCEFireworks integrationLast updated 8/27/2013FWLaunch.optimizeInFireworks()AvailabilityDreamweaver 2, Fireworks 2.Description

405DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013Argumentsx, y • The x argument is the number of pixels that the selection must move horizontal

406DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013ReturnsNothing.Layout environment functionsLayout environment functions handle operations that

407DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013dom.getTracingImageOpacity()AvailabilityDreamweaver 3.DescriptionGets the opacity setting for

408DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013dom.playPlugin()AvailabilityDreamweaver 3.DescriptionPlays the selected plug-in item.Arguments

409DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013ReturnsNothing.dom.setTracingImagePosition()AvailabilityDreamweaver 3.DescriptionMoves the upp

410DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013dom.snapTracingImageToSelection()AvailabilityDreamweaver 3.DescriptionAligns the upper-left co

411DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013EnablerSee “dom.canStopPlugin()” on page 501.dreamweaver.arrangeFloatingPalettes()Availabilit

412DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013DescriptionIf the user clicks a menu button in the header of a table in Layout view and causes

413DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013DescriptionThis function gets the state of the visual aid that forces background coloring for

414DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013dom.getShowBlockIDs()AvailabilityDreamweaver 8.DescriptionThis function gets the state of the

37DREAMWEAVER API REFERENCEFireworks integrationLast updated 8/27/2013ExampleThe following code checks whether Fireworks is installed: if (FWLaunch.va

415DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013dom.setShowBlockBackgrounds()AvailabilityDreamweaver 8.DescriptionThis function turns on and o

416DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013Argumentsallblocks • The allblocks argument, which is required, is a Boolean value. Set the va

417DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013dom.setShowLayoutView()AvailabilityDreamweaver 4.DescriptionPlaces the current document in Lay

418DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013ReturnsA string array.dom.isViewSizeMenuItemChecked()AvailabilityDreamweaver CS5.5.Description

419DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013Media Querydw.mediaQueryListToJSON(strMediaQueryList)AvailabilityDreamweaver CS5.5.Description

420DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013site.setMediaQueryFile()AvailabilityDreamweaver CS5.5.DescriptionSets site-wide media query fi

421DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013ExampleThe following example gets the value of the scale of current view. It also zooms in if

422DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013EnablerSee “dreamweaver.canFitSelection()” on page 505.Example if (canFitSeletion()){ fitSel

423DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013EnablerSee “dreamweaver.canZoom()” on page 510.Example if (canZoom()){ zoomIn(); }dreamweav

424DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013ArgumentsNone.ReturnsNothing.ExampleThe following example deletes all guides in the document i

38DREAMWEAVER API REFERENCEFireworks integrationLast updated 8/27/2013function checkOneMoreTime() { // Call checkJsResponse() every 1/2 second to see

425DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013Argumentslocation • The location argument is the location of the guide with both the value and

426DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013Argumentslocation • The location argument is a string that represents the location in the docu

427DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013ArgumentsNone.ReturnsNothing.ExampleThe following example makes the distance feedback color of

428DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013ReturnsNothing.ExampleThe following example makes guides in the document snap to elements: var

429DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013ExampleThe following example deletes all guides in the document if the document has at least o

430DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013ReturnsA Boolean value: true if there is a vertical guide at the location; false otherwise.Exa

431DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013ArgumentsNone.ReturnsNothing.dom.convertWidthsToPixels()AvailabilityDreamweaver 4.DescriptionT

432DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013ArgumentsNone.ReturnsNothing.EnablerSee “dom.canDecreaseRowspan()” on page 495.dom.deleteTabl

433DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013dom.doDeferredTableUpdate()AvailabilityDreamweaver 3.DescriptionIf the Faster Table Editing op

434DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013dom.increaseColspan()AvailabilityDreamweaver 3.DescriptionThis function increases the column s

39Last updated 8/27/2013Chapter 6: Flash integration Adobe® Dreamweaver® provides support for the Flash Object API, which leverages the Flash Generato

435DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013• The bBeforeSelection argument is a Boolean value: true indicates that the columns should be

436DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013dom.removeAllTableHeights()AvailabilityDreamweaver 3.DescriptionThis function removes all HEIG

437DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013dom.selectTable()AvailabilityDreamweaver 3.DescriptionSelects an entire table.ArgumentsNone.Re

438DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013ArgumentstdOrTh • The tdOrTh argument must be either "td" or "th".ReturnsN

439DREAMWEAVER API REFERENCEDesignLast updated 8/27/2013ArgumentsNone.ReturnsNothing.EnablerSee “dom.canInsertTableColumns()” on page 497 or “dom.can

440Last updated 8/27/2013Chapter 18: CodeThe code functions let you perform operations on a document that appears in Code view. The operations include

441DREAMWEAVER API REFERENCECodeLast updated 8/27/2013• The pattern argument is the pattern attribute for the new menu tag. • The labelArray argument

442DREAMWEAVER API REFERENCECodeLast updated 8/27/2013ReturnsNothing.ExampleIf the user creates a recordset called "myRs", the following cod

443DREAMWEAVER API REFERENCECodeLast updated 8/27/2013• The bClassPattern argument is a Boolean value. If set to true, states that the function belong

444DREAMWEAVER API REFERENCECodeLast updated 8/27/2013ExampleYour JavaScript code might build a Code Hints menu that contains user-defined session var

40DREAMWEAVER API REFERENCEFlash integrationLast updated 8/27/2013• The jpgFileName argument, which is expressed as a file:// URL, is the output filen

445DREAMWEAVER API REFERENCECodeLast updated 8/27/2013dreamweaver.findNext()AvailabilityDreamweaver 3; modified in Dreamweaver MX 2004.DescriptionFind

446DREAMWEAVER API REFERENCECodeLast updated 8/27/2013dreamweaver.replace()AvailabilityDreamweaver 3.DescriptionVerifies that the current selection ma

447DREAMWEAVER API REFERENCECodeLast updated 8/27/2013Note: In a query, certain special characters, such as the backslash character (\), must be escap

448DREAMWEAVER API REFERENCECodeLast updated 8/27/2013dreamweaver.setUpFind()AvailabilityDreamweaver 3.DescriptionPrepares for a text or HTML source s

449DREAMWEAVER API REFERENCECodeLast updated 8/27/2013ArgumentssearchObject The searchObject argument is an object for which the following properties

450DREAMWEAVER API REFERENCECodeLast updated 8/27/2013dreamweaver.showFindReplaceDialog()AvailabilityDreamweaver 3.DescriptionOpens the Replace dialog

451DREAMWEAVER API REFERENCECodeLast updated 8/27/2013DescriptionApplies the FONT tag and the specified attribute and value to the current selection.A

452DREAMWEAVER API REFERENCECodeLast updated 8/27/2013dom.exitBlock()AvailabilityDreamweaver 3.DescriptionExits the current paragraph or heading block

453DREAMWEAVER API REFERENCECodeLast updated 8/27/2013dom.getLineFromOffset()AvailabilityDreamweaver MX.DescriptionFinds the line number of a specific

454DREAMWEAVER API REFERENCECodeLast updated 8/27/2013dom.getListTag()AvailabilityDreamweaver 3.DescriptionGets the style of the selected list.Argumen

41DREAMWEAVER API REFERENCEFlash integrationLast updated 8/27/2013ReturnsAn array that contains two elements that represent the width and the height o

455DREAMWEAVER API REFERENCECodeLast updated 8/27/2013dom.hasCharacterMarkup()AvailabilityDreamweaver 3.DescriptionChecks whether the selection alread

456DREAMWEAVER API REFERENCECodeLast updated 8/27/2013• The bReplaceCurrentSelection argument, which is optional, is a Boolean value that indicates wh

457DREAMWEAVER API REFERENCECodeLast updated 8/27/2013ArgumentscontentToInsert, {bReplaceCurrentSelection} • The contentToInsert argument is the conte

458DREAMWEAVER API REFERENCECodeLast updated 8/27/2013ArgumentsNone.ReturnsNothing.dom.outdent()AvailabilityDreamweaver 3.DescriptionOutdents the sele

459DREAMWEAVER API REFERENCECodeLast updated 8/27/2013Argumentsattribute • The attribute argument must be "face", "size", or "

460DREAMWEAVER API REFERENCECodeLast updated 8/27/2013dom.setLinkHref()AvailabilityDreamweaver 3.DescriptionMakes the selection a hypertext link or ch

461DREAMWEAVER API REFERENCECodeLast updated 8/27/2013Argumentskind • The kind argument must be either "menu" or "list box".Return

462DREAMWEAVER API REFERENCECodeLast updated 8/27/2013DescriptionSets the ALIGN attribute of the block that contains the selection to the specified va

463DREAMWEAVER API REFERENCECodeLast updated 8/27/2013dom.showFontColorDialog()AvailabilityDreamweaver 3.DescriptionOpens the Color Picker dialog box.

464DREAMWEAVER API REFERENCECodeLast updated 8/27/2013dreamweaver.getFontList()AvailabilityDreamweaver 3.DescriptionGets a list of all the font groups

42DREAMWEAVER API REFERENCEFlash integrationLast updated 8/27/2013 "file:///MyMac/test.swt" // template file used to create this .swf fi

465DREAMWEAVER API REFERENCECodeLast updated 8/27/2013DescriptionDetermines whether the specified modifier key is depressed.Argumentskey • The key arg

466DREAMWEAVER API REFERENCECodeLast updated 8/27/2013ArgumentsfontTypes • The fontTypes argument is a string that contains either the value all, or t

467DREAMWEAVER API REFERENCECodeLast updated 8/27/2013ReturnsA Boolean value: true if the code can print; false otherwise. Example The following examp

468DREAMWEAVER API REFERENCECodeLast updated 8/27/2013ReturnsNothing.dom.stripTag()AvailabilityDreamweaver 3.DescriptionRemoves the tag from around th

469DREAMWEAVER API REFERENCECodeLast updated 8/27/2013dreamweaver.showQuickTagEditor()AvailabilityDreamweaver 3.DescriptionDisplays the Quick Tag Edit

470DREAMWEAVER API REFERENCECodeLast updated 8/27/2013dom.formatSelection()AvailabilityDreamweaver MX.DescriptionApplies Dreamweaver automatic syntax

471DREAMWEAVER API REFERENCECodeLast updated 8/27/2013ReturnsAn object with the following properties: • The numError property, which is the number of

472DREAMWEAVER API REFERENCECodeLast updated 8/27/2013dom.setShowNoscript()AvailabilityDreamweaver MX.DescriptionSets the noscript content option on o

473DREAMWEAVER API REFERENCECodeLast updated 8/27/2013Arguments{nTimes}, {bShiftIsDown} • The nTimes argument, which is optional, is the number of cha

474DREAMWEAVER API REFERENCECodeLast updated 8/27/2013ReturnsNothing.dom.source.balanceBracesTextView()AvailabilityDreamweaver 4.DescriptionThis funct

43DREAMWEAVER API REFERENCEFlash integrationLast updated 8/27/2013The following table lists the PanelWindow specifications:ReturnsOne of the following

475DREAMWEAVER API REFERENCECodeLast updated 8/27/2013ArgumentsbShiftIsDown • The bShiftIsDown argument is a Boolean value that indicates whether cont

476DREAMWEAVER API REFERENCECodeLast updated 8/27/2013dom.source.getCurrentLines()AvailabilityDreamweaver 4.DescriptionReturns the line numbers for th

477DREAMWEAVER API REFERENCECodeLast updated 8/27/2013DescriptionReturns the text string in the source between the designated offsets.ArgumentsstartOf

478DREAMWEAVER API REFERENCECodeLast updated 8/27/2013 var offset = dw.getDocumentDOM().source.getSelection()[0]; var errors = dw.getDocumentDOM().so

479DREAMWEAVER API REFERENCECodeLast updated 8/27/2013Arguments{nTimes}, {bShiftIsDown} • The nTimes argument, which is optional, is the number of wor

480DREAMWEAVER API REFERENCECodeLast updated 8/27/2013dom.source.pageUp()AvailabilityDreamweaver 4.DescriptionMoves the insertion point up the Code vi

481DREAMWEAVER API REFERENCECodeLast updated 8/27/2013DescriptionReplaces the range of source text between startOffset and endOffset with string. If s

482DREAMWEAVER API REFERENCECodeLast updated 8/27/2013dom.source.scrollLineUp()AvailabilityDreamweaver 4.DescriptionScrolls the Code view up line by l

483DREAMWEAVER API REFERENCECodeLast updated 8/27/2013dom.source.scrollTopFile()AvailabilityDreamweaver 4.DescriptionScrolls the Code view to the top

484DREAMWEAVER API REFERENCECodeLast updated 8/27/2013ReturnsA Boolean value: true if successful; false otherwise.dom.source.startOfDocument()Availabi

44DREAMWEAVER API REFERENCEFlash integrationLast updated 8/27/2013• The code PlugPlugErrorCode_extensionRegistrationFailed indicates that you were una

485DREAMWEAVER API REFERENCECodeLast updated 8/27/2013DescriptionMoves the insertion point to the top of the current page or to the top of the previou

486DREAMWEAVER API REFERENCECodeLast updated 8/27/2013ReturnsNothing.Live Code view functionsThe code displayed in Live Code view is similar to what y

487DREAMWEAVER API REFERENCECodeLast updated 8/27/2013Tag editor and tag library functionsYou can use tag editors to insert new tags, edit existing ta

488DREAMWEAVER API REFERENCECodeLast updated 8/27/2013dreamweaver.popupEditTagDialog()AvailabilityDreamweaver MX.DescriptionIf a tag is selected, this

489DREAMWEAVER API REFERENCECodeLast updated 8/27/2013dreamweaver.tagLibrary.getTagLibraryDOM()AvailabilityDreamweaver MX.DescriptionGiven the URL of

490DREAMWEAVER API REFERENCECodeLast updated 8/27/2013ReturnsA string: the name of the tag that is currently selected in the Tag Library editor; retur

491DREAMWEAVER API REFERENCECodeLast updated 8/27/2013 // "fileURL" and "prefix" have been entered by the user. // tell the Tag

492Last updated 8/27/2013Chapter 19: EnablersAdobe® Dreamweaver® CS5 enabler functions determine whether another function can perform a specific opera

493DREAMWEAVER API REFERENCEEnablersLast updated 8/27/2013dom.canArrange()AvailabilityDreamweaver 3.DescriptionChecks whether Dreamweaver can perform

494DREAMWEAVER API REFERENCEEnablersLast updated 8/27/2013dom.canClipPasteText()AvailabilityDreamweaver 3.DescriptionChecks whether Dreamweaver can pe

vDREAMWEAVER API REFERENCEContentsLast updated 8/27/2013Snippets panel functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

45DREAMWEAVER API REFERENCEFlash integrationLast updated 8/27/2013ExamplecontrolData = {}; controlData.defaultGeometry = {topleftx : 100, toplefty :

495DREAMWEAVER API REFERENCEEnablersLast updated 8/27/2013dom.canDecreaseColspan()AvailabilityDreamweaver 3.DescriptionChecks whether Dreamweaver can

496DREAMWEAVER API REFERENCEEnablersLast updated 8/27/2013dom.canDeleteTableRow()AvailabilityDreamweaver 3.DescriptionChecks whether Dreamweaver can p

497DREAMWEAVER API REFERENCEEnablersLast updated 8/27/2013DescriptionChecks whether Dreamweaver can perform an Increase Colspan operation.ArgumentsNon

498DREAMWEAVER API REFERENCEEnablersLast updated 8/27/2013ArgumentsNone.ReturnsA Boolean value: true if the selection is inside a table; false if the

499DREAMWEAVER API REFERENCEEnablersLast updated 8/27/2013ReturnsA Boolean value: true if the selection is an adjacent grouping of table cells; false

500DREAMWEAVER API REFERENCEEnablersLast updated 8/27/2013dom.canSelectTable()AvailabilityDreamweaver 3.DescriptionChecks whether Dreamweaver can perf

501DREAMWEAVER API REFERENCEEnablersLast updated 8/27/2013dom.canSplitFrame()AvailabilityDreamweaver 3.DescriptionChecks whether Dreamweaver can perfo

502DREAMWEAVER API REFERENCEEnablersLast updated 8/27/2013dom.canUndo()AvailabilityDreamweaver 3.DescriptionChecks whether Dreamweaver can perform an

503DREAMWEAVER API REFERENCEEnablersLast updated 8/27/2013dreamweaver.assetPalette.canInsertOrApply()AvailabilityDreamweaver 4.DescriptionChecks if th

504DREAMWEAVER API REFERENCEEnablersLast updated 8/27/2013dreamweaver.canClipPaste()AvailabilityDreamweaver 3.DescriptionChecks whether Dreamweaver ca

46DREAMWEAVER API REFERENCEFlash integrationLast updated 8/27/2013• The XML string containing call back function and arguments.The following example i

505DREAMWEAVER API REFERENCEEnablersLast updated 8/27/2013Example The following example calls dw.canExportTemplateDataAsXML() to determine whether Dre

506DREAMWEAVER API REFERENCEEnablersLast updated 8/27/2013ArgumentsNone.ReturnsA Boolean value: true if the selection or insertion point is within a f

507DREAMWEAVER API REFERENCEEnablersLast updated 8/27/2013ArgumentsNone.ReturnsThe name of the currently selected tag or a null value if no tag is sel

508DREAMWEAVER API REFERENCEEnablersLast updated 8/27/2013ArgumentsNone.ReturnsA Boolean value that indicates whether one or more unsaved documents ar

509DREAMWEAVER API REFERENCEEnablersLast updated 8/27/2013DescriptionChecks whether Dreamweaver can perform a Save Frameset operation on the specified

510DREAMWEAVER API REFERENCEEnablersLast updated 8/27/2013dreamweaver.canShowFindDialog()AvailabilityDreamweaver 3.DescriptionChecks whether Dreamweav

511DREAMWEAVER API REFERENCEEnablersLast updated 8/27/2013dreamweaver.cssRuleTracker.canEditSelectedRule()AvailabilityDreamweaver MX 2004.DescriptionC

512DREAMWEAVER API REFERENCEEnablersLast updated 8/27/2013DescriptionChecks the current selection to determine whether the selected style can be delet

513DREAMWEAVER API REFERENCEEnablersLast updated 8/27/2013Arguments{pane} • The pane argument, which is optional, is a string that specifies the pane

514DREAMWEAVER API REFERENCEEnablersLast updated 8/27/2013dreamweaver.cssStylePalette.canRenameSelectedStyle()AvailabilityDreamweaver MX.DescriptionCh

47DREAMWEAVER API REFERENCEFlash integrationLast updated 8/27/2013ExampleThe following example is used for setting up the menu:function initializeMenu

515DREAMWEAVER API REFERENCEEnablersLast updated 8/27/2013ReturnsA Boolean value: true if Dreamweaver can edit, delete, or duplicate the selection in

516DREAMWEAVER API REFERENCEEnablersLast updated 8/27/2013dreamweaver.resultsPalette.canPaste()AvailabilityDreamweaver MX.DescriptionChecks whether th

517DREAMWEAVER API REFERENCEEnablersLast updated 8/27/2013dreamweaver.resultsPalette.canSave()AvailabilityDreamweaver MX.DescriptionChecks whether the

518DREAMWEAVER API REFERENCEEnablersLast updated 8/27/2013dreamweaver.siteSyncDialog.canMarkDelete()AvailabilityDreamweaver 8.DescriptionThis function

519DREAMWEAVER API REFERENCEEnablersLast updated 8/27/2013dreamweaver.siteSyncDialog.canMarkPut()AvailabilityDreamweaver 8.DescriptionThis function ch

520DREAMWEAVER API REFERENCEEnablersLast updated 8/27/2013dreamweaver.snippetpalette.canInsert()AvailabilityDreamweaver MX.DescriptionChecks whether y

521DREAMWEAVER API REFERENCEEnablersLast updated 8/27/2013ReturnsA Boolean value: true if the following conditions are true; false otherwise:• A remot

522DREAMWEAVER API REFERENCEEnablersLast updated 8/27/2013ReturnsA Boolean value: true if Dreamweaver can perform the Cloaking operation on the curren

523DREAMWEAVER API REFERENCEEnablersLast updated 8/27/2013• 'site' indicates that the function uses the file selected in the Site panel.Retu

524DREAMWEAVER API REFERENCEEnablersLast updated 8/27/2013• A Boolean value. The Boolean value is returned if the first argument is the keyword remote

48DREAMWEAVER API REFERENCEFlash integrationLast updated 8/27/2013ArgumentscontrolID, javascript function call• The controlID argument is the ID of th

525DREAMWEAVER API REFERENCEEnablersLast updated 8/27/2013ArgumentsNone.ReturnsA Boolean value: true if any files or folders are selected in the Site

526DREAMWEAVER API REFERENCEEnablersLast updated 8/27/2013DescriptionChecks whether Dreamweaver can perform a Refresh [Local | Remote] operation.Argum

527DREAMWEAVER API REFERENCEEnablersLast updated 8/27/2013DescriptionDetermines whether Dreamweaver can perform a Synchronize operation.ArgumentsNone.

528DREAMWEAVER API REFERENCEEnablersLast updated 8/27/2013site.canViewAsRoot()AvailabilityDreamweaver 3.DescriptionDetermines whether Dreamweaver can

49DREAMWEAVER API REFERENCEFlash integrationLast updated 8/27/2013function helloWorld(nameStr) { alert('hello ' + nameStr); var appLangua

50Last updated 8/27/2013Chapter 7: Photoshop integrationAdobe® Dreamweaver CS5® facilitates a compact integration with Adobe® Photoshop®. Users can in

51DREAMWEAVER API REFERENCEPhotoshop integrationLast updated 8/27/2013DescriptionThis function re-creates the selected web image based on the current

52DREAMWEAVER API REFERENCEPhotoshop integrationLast updated 8/27/2013ArgumentsAbsolute local URL of the web image.ReturnsPixel width of the original

53DREAMWEAVER API REFERENCEPhotoshop integrationLast updated 8/27/2013ReturnsAbsolute local file path.dreamweaver.canUpdateSmartObjectFromOriginal()Av

54Last updated 8/27/2013Chapter 8: The database API Functions in the database API let you manage database connections and access information that is s

1Last updated 8/27/2013Chapter 1: IntroductionThe Adobe Dreamweaver CS5 API Reference describes the application programming interfaces (APIs). The API

55DREAMWEAVER API REFERENCEThe database APILast updated 8/27/2013Database connection functionsDatabase connection functions let you make and manage an

56DREAMWEAVER API REFERENCEThe database APILast updated 8/27/2013MMDB.getColdFusionDsnList()AvailabilityDreamweaver UltraDev 4.DescriptionThis functio

57DREAMWEAVER API REFERENCEThe database APILast updated 8/27/2013Note: These properties are the standard ones that Dreamweaver implements. Developers

58DREAMWEAVER API REFERENCEThe database APILast updated 8/27/2013 ConnectionString="jdbc:inetdae:velcro-qa-5:1433?database=pubs" DriverNam

59DREAMWEAVER API REFERENCEThe database APILast updated 8/27/2013MMDB.getDriverName()AvailabilityDreamweaver UltraDev 1.DescriptionThis function gets

60DREAMWEAVER API REFERENCEThe database APILast updated 8/27/2013ArgumentsconnName • The connName argument is a connection name that is specified in t

61DREAMWEAVER API REFERENCEThe database APILast updated 8/27/2013DescriptionThis function gets the ODBC DSNs from the site server. The getRDSUserName(

62DREAMWEAVER API REFERENCEThe database APILast updated 8/27/2013ArgumentsconnName • The connName argument is a connection name that is specified in t

63DREAMWEAVER API REFERENCEThe database APILast updated 8/27/2013MMDB.needToRefreshColdFusionDsnList()AvailabilityDreamweaver MX.DescriptionThis funct

64DREAMWEAVER API REFERENCEThe database APILast updated 8/27/2013MMDB.setRDSPassword()AvailabilityDreamweaver UltraDev 4.DescriptionThis function sets

2DREAMWEAVER API REFERENCEIntroductionLast updated 8/27/2013New functions in Dreamweaver CS5The following new functions are added to the Dreamweaver C

65DREAMWEAVER API REFERENCEThe database APILast updated 8/27/2013MMDB.showConnectionMgrDialog()AvailabilityDreamweaver UltraDev 1.DescriptionThis func

66DREAMWEAVER API REFERENCEThe database APILast updated 8/27/2013MMDB.showRestrictDialog()AvailabilityDreamweaver UltraDev 4.DescriptionThis function

67DREAMWEAVER API REFERENCEThe database APILast updated 8/27/2013Database access functionsDatabase access functions let you query a database. In acces

68DREAMWEAVER API REFERENCEThe database APILast updated 8/27/2013 columnArray[0] = "EmpName" columnArray[1] = "varchar" columnAr

69DREAMWEAVER API REFERENCEThe database APILast updated 8/27/2013ReturnsAn array of objects, one object for each column. Each object defines the follo

70DREAMWEAVER API REFERENCEThe database APILast updated 8/27/2013 ["EmpID", "FirstName", "LastName"]MMDB.getPrimaryKeys(

71DREAMWEAVER API REFERENCEThe database APILast updated 8/27/2013Note: Dreamweaver connects to and gets all the tables in the database whenever you mo

72DREAMWEAVER API REFERENCEThe database APILast updated 8/27/2013ArgumentsconnName, statement, paramValuesArray • The connName argument is a connectio

73DREAMWEAVER API REFERENCEThe database APILast updated 8/27/2013ReturnsAn array of strings that represents the list of columns. This function returns

74DREAMWEAVER API REFERENCEThe database APILast updated 8/27/2013ExampleThe following example retrieves the parameter objects for the specified proced

3DREAMWEAVER API REFERENCEIntroductionLast updated 8/27/2013“document.getRelatedFiles()” on page 193“document.addRelatedFile()” on page 194“document

75DREAMWEAVER API REFERENCEThe database APILast updated 8/27/2013ArgumentsconnName • The connName argument is a connection name that is specified in t

76DREAMWEAVER API REFERENCEThe database APILast updated 8/27/2013 var viewObjects = MMDB.getViews(CONN_LIST.getValue()) for (i = 0; i < viewObject

77DREAMWEAVER API REFERENCEThe database APILast updated 8/27/2013DescriptionThis function displays a dialog box that contains the results of executing

78DREAMWEAVER API REFERENCEThe database APILast updated 8/27/2013ReturnsThis function returns an error if the SQL statement or the connection string i

79Last updated 8/27/2013Chapter 9: The database connectivity API As a developer, you can create new connection types and corresponding dialog boxes fo

80DREAMWEAVER API REFERENCEThe database connectivity APILast updated 8/27/2013 function getServerModelFolderName() { return "ASP_JS"; }Yo

81DREAMWEAVER API REFERENCEThe database connectivity APILast updated 8/27/2013The applyConnection() function returns an HTML source within an include

82DREAMWEAVER API REFERENCEThe database connectivity APILast updated 8/27/2013If a connection is not found in htmlSource, a null value returns. Note:

83DREAMWEAVER API REFERENCEThe database connectivity APILast updated 8/27/2013applyConnection()AvailabilityDreamweaver UltraDev 4.DescriptionDreamweav

84DREAMWEAVER API REFERENCEThe database connectivity APILast updated 8/27/2013 <!--#include file="../Connections/MyConnection1.asp"-->

4DREAMWEAVER API REFERENCEIntroductionLast updated 8/27/2013• Function names that have the prefix dreamweaver.funcname can be abbreviated to dw.funcna

85DREAMWEAVER API REFERENCEThe database connectivity APILast updated 8/27/2013Note: If you change the format of your include file or define an include

86Last updated 8/27/2013Chapter 10: The source control integration APIThe source control integration API lets you write shared libraries. These APIs e

87DREAMWEAVER API REFERENCEThe source control integration APILast updated 8/27/2013Adding source control system functionalityYou can add source contro

88DREAMWEAVER API REFERENCEThe source control integration APILast updated 8/27/2013Argumentsvoid **connectionData, const char siteName[64]• The connec

89DREAMWEAVER API REFERENCEThe source control integration APILast updated 8/27/2013ReturnsAn integer that indicates the length of the name of the root

90DREAMWEAVER API REFERENCEThe source control integration APILast updated 8/27/2013• The remotePath argument is the path of the remote folder that the

91DREAMWEAVER API REFERENCEThe source control integration APILast updated 8/27/2013Argumentsvoid *connectionData, const char *localPathList[], const c

92DREAMWEAVER API REFERENCEThe source control integration APILast updated 8/27/2013bool SCS_Rename()DescriptionThis function renames or moves a file o

93DREAMWEAVER API REFERENCEThe source control integration APILast updated 8/27/2013bool SCS_GetConnectionInfo()DescriptionThis function displays a dia

94DREAMWEAVER API REFERENCEThe source control integration APILast updated 8/27/2013int SCS_GetNumNewFeatures()DescriptionThis function returns the num