DOCX INPUT

Provides a command that prints data on composed DOCX documents, but can also produce a variable out of its potentially edited contents for post-composing logic to use.

Commands of this library may only be used in DOCX document content.

in

A special version of the out command that, in addition producing text output in a similar way, can produce a variable out of its contents in the composed document content.

Unlike most other document content commands, in and its content control always remain in the document after being evaluated, regardless of the document's Smart content status. If the composed content is then re-evaluated in input mode, any content inside in's content control becomes the value of a new variable. To initiate an evaluation in this input mode, the readInputs command does the job if the template is a Flow template. If the template is a Controller template, this kind of evaluation happens automatically when button click event handlers are run.  

Attributes

value
Required	Value type	EL-evaluated
Yes	Any	Yes
Defines the text output of this command. The resolved value can be of any type - if the value is not a String, it is converted into one. Do note that values of certain types (such as Files) do not convert into very meaningful text content.

var
Required	Value type	EL-evaluated
Yes	String	Yes
Defines the name of the variable that will hold the String of the text content of this command's content control. Alternatively the value can be of some other type instead of String if the varParser attribute is defined.

varParser
Required	Value type	EL-evaluated
No	String	No
Specifies a Parser that converts the variable value this command generates from a String into another kind of value. The resolved String is expected to be the name of a Parser defined earlier in the logic.

required
Required	Value type	EL-evaluated
No	Boolean	Yes
Defines if this command is required to have a value to output. If this attribute's resolved value is true and the value attribute resolves into null, the user is informed with an error message. If undefined, value of false is used, allowing value to resolve into null.

format
Required	Value type	EL-evaluated
No	String	No
Specifies a Format that takes the value to output and formats into a String as according to its formatting rules. The resolved String is expected to the name of a Format defined earlier in the logic.

locked
Required	Value type	EL-evaluated
No	Boolean	Yes
Defines if this command's content control is locked, which prevents it from being deleted. If the resolved value is true, the content control will be locked.

contentLocked
Required	Value type	EL-evaluated
No	String	Yes
Defines if this command's content control's contents are locked, which prevents them from being edited. If the resolved value is true, the contents will be locked.

title
Required	Value type	EL-evaluated
No	String	Yes
Defines the title of this command's content control.