template

The template object represents the template with all its contexts and sections. It is used frequently in Control Scripts (see Control Scripts and Control Script API).

It is retrieved via the merge object: merge.template (see merge).

Which contexts are available in the template can be queried using merge.template.contexts. To get access to a specific context, you have to specify the ContextType (see ContextType).

Field Type Description
contexts Array Array of contexts (see context) available in the template. The contexts contain the sections (see section).
media Array Media available to this template (see Media). For each of them you can specify, enable and position the stationery's front and back.
properties Properties

This object contains all default properties of the template as well as any custom properties. (On the menu, select File > Properties to view and complement the file properties. See File Properties dialog).

Example

The following Control Script retrieves two Print sections. Then, depending on a value in the current record, it enables one section or the other, so that only one of the two sections appears in the output.

var printSections = merge.template.contexts.PRINT.sections;
printSections['Section EN'].enabled = false;
printSections['Section FR'].enabled = false;

if(record.fields.Language === 'FR'){
	printSections['Section FR'].enabled = true;
} else {
	printSections['Section EN'].enabled = true;
}
  
  • Last Topic Update: 17, October, 2017 05:16 AM
  • Last Published: 23, May, 2019 01:55 PM