Menu

composeDOCXContent

Evaluates the Word content commands within the specified DOCX document. The result of the evaluation will be a copy of the DOCX document with whatever modifications the content commands caused.

This command triggers an evaluation process specifically only for Word content commands, not the older content control -based tags produced through the Dynamo Office Add-in. Use the composeContent command for composing contents of legacy DOCX templates.

Child commands

  • evaluateTag
    Optional. Add one or more of these to limit the commands that are evaluated. 

Attributes

var

Required
Value type
EL-evaluated
Yes String
No
Defines the name of the variable placed into the variable context whose value is the evaluated document File.
template

Required Value type EL-evaluated
No
File
Yes
Defines the DOCX template whose content is evaluated.
title
Required Value type EL-evaluated
No String Yes
Defines a title for the composed DOCX document.

If undefined, the title of the File defined through template is used as the title.
customProperties
Required Value type EL-evaluated
No Map Yes
Defines custom properties to be added into the composed DOCX document. Each entry in the resolved Map value produces a custom property, with the entry's key being the name of the property and the entry's value being the value of the property.

If the template already contains custom properties, a property sharing the name of an existing property will not be added as properties with duplicate names are not allowed. An error message will appear if this occurs.
recomposable
Required Value type EL-evaluated
No Boolean Yes
Defines if the evaluated document is recomposable. This kind of document retains its content command -defining content controls and can be composed again with this command with all the content commands behaving as if they were evaluated for the first time.

Examples

Use composeDOCXContent command within an Online template's Flow to create Word output. Simply load a Word file that includes content commands and use composeDOCXContent to compose the document.

<load var="wordFile" contentDocumentId="xxxx">
<composeDOCXContent var="composedDocx" template="${wordFile}" title="Example Word document">

Comments

0 comments