User Guide

150 Chapter 11: Application
dreamweaver.showDynamicDataDialog()
Availability
Dreamweaver UltraDev 1.
Description
Displays the Dynamic Data or the Dynamic Text dialog box, and waits for the user to dismiss the
dialog box. If the user clicks OK, the
showDynamicDataDialog() function returns a string to
insert into the user’s document. (This string returns from the Data Sources API function,
generateDynamicDataRef(), and passes to the Data Format API function,
formatDynamicDataRef(); the return value from formatDynamicDataRef() is the one that the
showDynamicDataDialog() function returns.)
Arguments
source
, {title}
• The source argument is a string that contains source code, which represents the dynamic data
object. It is the same string that a previous call to this function returned. The function uses the
contents of the
source argument to initialize all the dialog box controls, so 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 any of the nodes in the tree. If the string matches a node, that node is
selected when the dialog box appears. You can also pass an empty string, which does not
initialize the dialog box. For example, a dialog box is not initialized when used to create a
new item.
• The title argument, which is optional, is a string that contains the text to display in the title
bar of the dialog box. If this argument is not supplied, Dreamweaver displays Dynamic Data in
the title bar.
Returns
A string that represents the dynamic data object, if the user clicks OK.
000_DW_API_Print.book Page 150 Wednesday, August 20, 2003 9:14 AM