IncludeTextField Object
Description
Represents an MS Word specific INCLUDETEXT field. Is used as a parameter for the addMergeField method.
Syntax
TXTextControl.IncludeTextFieldExamples
The following example demonstrates TXTextControl.IncludeTextField in a practical document-editing workflow. It represents an MS Word specific INCLUDETEXT field. Is used as a parameter for the addMergeField method.
function inspectIncludeTextField(includeTextField) {
console.log("TXTextControl.IncludeTextField object:", includeTextField);
}Members
Properties
| Property | Description |
|---|---|
| bookmark | Specifies the bookmark switch of the field. |
| fileName | Specifies the file name of the document that should be inserted. In the MailMerge component, the search path for the documents can be set using the DocumentServer.MailMerge.SearchPath property. |
| preserveFormatting | Specifies whether the field's formatting should be preserved. |
| text | Specifies the initial text of the field. Let this property be null to use the default text "INCLUDETEXT". |
| textFormat | Specifies the text format of the field. Possible values are defined in TXTextControl.MergeFieldTextFormat. |