Extension Data Manager functions

The APIs in this section comprise the Extension Data Manager (EDM). You can programmatically access and manipulate the data that is contained in the group and participant files by calling these functions. The EDM performs in the following manner:

• The EDM performs all EDML file input/output for group and participant files.

• The EDM acts as a server model filter by performing all data requests for the current server model.

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 (depending on the level of information you need) of comma-separated node qualifiers that includes group or participant name, subblock (if any), and field name.

Returns

Dreamweaver expects a field value. If a value is not specified, Dreamweaver uses the default value.

Example

The following example retrieves the location attribute value for the insertText tag of the recordset_main participant:

 dw.getExtDataValue("recordset_main", "insertText", "location"); 

dreamweaver.getExtDataArray()

Availability

Dreamweaver UltraDev 4.

Description

This function retrieves an array of values from an EDML file for the specified nodes.

Arguments

 qualifier(s) 

• The qualifier(s) argument is a variable-length list of comma-separated node qualifiers, including group or participant name, subblock (if any), and field name.

Returns

Dreamweaver expects an array of child-node names.

dreamweaver.getExtParticipants()

Availability

Dreamweaver UltraDev 4.

Description

This function retrieves the list of participants from an EDML group file or participant files.

Arguments

 value, qualifier(s) 

• The value argument is a property value, or it is blank and is ignored. For example dreamweaver.getExtParticipants("", "participant");

• The qualifier(s) argument is a variable-length list of comma-separated node qualifiers of the required property.

Returns

Dreamweaver expects an array of participant names that have the specified property, if it is given, and the property matches the specified value, if it is given.

dreamweaver.getExtGroups()

Availability

Dreamweaver UltraDev 4.

Description

Retrieves the name of the group, which is the equivalent to the server behavior's name, from an EDML group file.

Arguments

 value, qualifier(s) 

• The value argument is a property value or is blank to ignore.

• The qualifier(s) argument is a variable length list of comma-separated node qualifiers of the required property.

Returns

Dreamweaver expects an array of group names that have the specified property, if it is given, and the property matches the specified value, if it is given.

dreamweaver.refreshExtData()

Availability

Dreamweaver UltraDev 4.

Description

Reloads all extension data files.

NOTE

This is a new Note table. It is attached to a ta Table_anchor paragraph tag. To create one, copy and paste from the reference page.

TIP

You can make a useful command from this function, letting edits to server-behavior EDML files be reloaded without restarting Dreamweaver.

Arguments

None.

Returns

Dreamweaver expects reloaded data.