1.7

Designer Scripts API
This page lists the global objects and functions that are available in scripts, created inside the
Scripts pane. Click through to an object or function to get a description and examples.
If you are not familiar with writing scripts, see "Writing your own scripts" on page552.
Control Scripts
Control Scripts are a special kind of Designer Scripts. They don't touch the content of the
sections themselves, but they change the way a template is outputted, for example by selecting
or omitting sections from the output. For more information about Control Scripts and their use,
see "Control Scripts" on page570. Features that are specific to Control Scripts are listed in the
"Control Script API" on page841.
Objects
Object Description
"results" on
page810
This object is used to manipulate the content of the template. It contains the
HTML element or set of HTML elements that match the selector of the script,
specified in the script editor.
This object is not available in Control Scripts, because that type of script
doesn't have a selector (see "Control Scripts" on page570).
"record" on
page807
The record in the main data set that is currently being merged. To get the
value of a field in the record, use record.fields['fieldname'] or
record.fields.fieldname.
"logger" on
page802
Global object that allows you to log messages.
locale Defines which locale to use. See "Locale" on page520.
"formatter"
on page797
Global object that allows you to format values (such as a date or number).
"automation" This object encapsulates the properties of the Workflow process that
Page 786