BackgroundResource
BackgroundResource is an enumeration for the types of background resources for a Print section (see background and section).
A Print section can be retrieved in script using merge.template.contexts.ContextType.sections["section name"], for example merge.template.contexts.PRINT.sections["Section EN"].
| Field | Description |
|---|---|
| DATAMAPPER_PDF | A PDF file retrieved via the active data mapping configuration. This can be the PDF file that was used as input file, or another type of input file, converted to PDF. |
| NONE | No PDF background. |
| RESOURCE_PDF | A PDF or other image file which is stored in the template or on the network. Note that it isn't possible to use a remotely stored image file as a section's background. |
Example
The following script sets the background for a section called 'Policy' to RESOURCE_PDF and specifies a path for it, using a data value:
Copy
// Enable the section background and specify that the PDF should be read
// from a resource file rather than using a PDF DataMapper background
merge.template.contexts.PRINT.sections['Policy'].background.source = BackgroundResource.RESOURCE_PDF;
// Specify the path
var resourceUrl = 'images/policy-' + record.fields.policy + '.pdf';
merge.template.contexts.PRINT.sections['Policy'].background.url = resourceUrl;
Note: To learn how to set a PDF file as a background image on a Print section without a Control Script, see Using a PDF file or other image as background.