MergeField Object
Description
Represents an MS Word specific MERGEFIELD field. Is used as a parameter for the addMergeField method.
Syntax
TXTextControl.MergeFieldExamples
The following example demonstrates TXTextControl.MergeField in a practical document-editing workflow. It represents an MS Word specific MERGEFIELD field. Is used as a parameter for the addMergeField method.
function inspectMergeField(mergeField) {
console.log("TXTextControl.MergeField object:", mergeField);
}Members
Properties
| Property | Description |
|---|---|
| dateTimeFormat | Specifies a string format which is applied to date / time values. Is equivalent to the MS Word field flag “\@”. |
| name | Specifies the name of the field. |
| numericFormat | Specifies a string format which is applied to numeric values. Is equivalent to the MS Word field flag “\#”. |
| preserveFormatting | Specifies whether the field's formatting should be preserved. |
| text | Specifies the text of the field. |
| textAfter | Specifies the text of the field that is displayed after the field's text. |
| textBefore | Specifies the text of the field that is displayed before the field's text. |
| textFormat | Specifies the text format of the field. Possible values are defined in TXTextControl.MergeFieldTextFormat. |