User Guide

The Data Sources API 297
Returns
Dreamweaver expects a Boolean value: true if the function has handled the edit;
false otherwise.
findDynamicSources()
Availability
Dreamweaver UltraDev 1.
Description
Returns the top-level nodes from the data source tree that appears in the Dynamic Data or the
Dynamic Text dialog box or in the Bindings panel. Each data source file has an implementation
of the
findDynamicSources() function. When Dreamweaver refreshes the tree, Dreamweaver
reads through all the files in the DataSources folder and calls the
findDynamicSources()
function in each file.
Returns
Dreamweaver expects an array of JavaScript objects where each object can have as many as
five attributes, which are described in the following list:
• The title property is the label string that appears to the right of the icon for each parent
node. The
title property is always required.
• The imageFile property is the path of a file that contains the icon (a GIF image), which
represents the parent node in the tree control in the Dynamic Data or the Dynamic Text dialog
box or in the Bindings panel. The
imageFile property is required.
• The allowDelete property is optional. If this property is set to a value of false, when the
user clicks this node in the Bindings panel, the Minus (-) button is disabled. If the property is
set to the value
true, the Minus (-) button is enabled. If the property is not defined, the
default is the value
true.
• The dataSource property is the simple name of the file in which the findDynamicSources()
function is defined. For example, the
findDynamicSources() function in the Session.htm
file, which is located in the Configuration/DataSources/ASP_Js folder, sets the
dataSource
property to session.htm. The
dataSource property is required.
• The name property is the name of the server behavior that is associated with the data source, if
one exists. Some data sources, such as recordsets, are associated with server behaviors. When
you create a recordset and name it
rsAuthors, the name property must equal rsAuthors. The
name property is always defined, but can be an empty string ("") if no server behavior is
associated with the data source (such as a session variable).
Note: A JavaScript class that defines these properties exists in the DataSourceClass.js file, which is
located in the Configuration/Shared/Common/Scripts folder.
generateDynamicDataRef()
Availability
Dreamweaver UltraDev 1.
Description
Generates the dynamic data object for a child node.