DocumentAssemblyOptions Leave feedback
On this page
Inheritance: java.lang.Object
public final class DocumentAssemblyOptions
A utility class providing constants. Specifies options controlling behavior of DocumentAssembler while assembling a document.
| Field | Description |
|---|---|
| NONE | Specifies default options. |
| ALLOW_MISSING_MEMBERS | Specifies that missing object members should be treated as null literals by the assembler. |
| UPDATE_FIELDS_AND_FORMULAS | Specifies that fields of result Word Processing documents and formulas of result Spreadsheet documents should be updated by the assembler. |
| REMOVE_EMPTY_PARAGRAPHS | Specifies that the assembler should remove paragraphs becoming empty after template syntax tags are removed or replaced with empty values. |
| INLINE_ERROR_MESSAGES | Specifies that the assembler should inline template syntax error messages into output documents. |
| USE_SPREADSHEET_DATA_TYPES | Relates to Spreadsheet documents only. |
| length |
public static final int NONE
Specifies default options.
public static final int ALLOW_MISSING_MEMBERS
Specifies that missing object members should be treated as null literals by the assembler. This option affects only access to instance (that is, non-static) object members and extension methods. If this option is not set, the assembler throws an exception when encounters a missing object member.
public static final int UPDATE_FIELDS_AND_FORMULAS
Specifies that fields of result Word Processing documents and formulas of result Spreadsheet documents should be updated by the assembler.
public static final int REMOVE_EMPTY_PARAGRAPHS
Specifies that the assembler should remove paragraphs becoming empty after template syntax tags are removed or replaced with empty values. At the moment, this option is supported only for templates of Word Processing, Presentation, and Email file formats.
public static final int INLINE_ERROR_MESSAGES
Specifies that the assembler should inline template syntax error messages into output documents. If this option is not set, the assembler throws an exception when encounters a syntax error.
public static final int USE_SPREADSHEET_DATA_TYPES
Relates to Spreadsheet documents only. Specifies that evaluated expression results should be mapped to corresponding Spreadsheet data types, which also affects their default formatting within cells. If this option is not set, expression results are always written as strings by the assembler. This option has no effect when expression results are formatted using template syntax - expression results are always written as strings then as well.
public static final int length
public static String getName(int documentAssemblyOptions)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| documentAssemblyOptions | int |
Returns: java.lang.String
public static Set getNames(int documentAssemblyOptions)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| documentAssemblyOptions | int |
Returns: java.util.Set
public static String toString(int documentAssemblyOptions)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| documentAssemblyOptions | int |
Returns: java.lang.String
public static int fromName(String documentAssemblyOptionsName)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| documentAssemblyOptionsName | java.lang.String |
Returns: int
public static int fromNames(Set documentAssemblyOptionsNames)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| documentAssemblyOptionsNames | java.util.Set |
Returns: int
public static int[] getValues()
Returns: int[]
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
