IncludeText Class
- Namespace
TXTextControl.DocumentServer. Fields
- Package
TXTextControl.from the private NuGet feed or Text Control Offline PackagesTextControl. WinForms. SDK
- Assembly
TXDocumentServer.dll
- Install
dotnet add package TXTextControl..NET 8 and later. For .NET Framework, referenceTextControl. WinForms. SDK TXDocumentServer.from the setup.dll
- Inherits
- Field
Adapter - Mail
Merge Field Adapter - Include
Text
- Field
Description
The IncludeText class implements the MS Word specific INCLUDETEXT field. This field must be used in combination with an ApplicationField that should be modified using this adapter.
Syntax
public sealed class IncludeText : MailMergeFieldAdapterPublic NotInheritable Class IncludeText
Inherits MailMergeFieldAdapterExamples
The following example creates an Include Text instance and configures its filename setting for a document workflow.
TXTextControl.DocumentServer.Fields.IncludeText includeText = new();
includeText.Filename = "document.docx";Dim includeText As New TXTextControl.DocumentServer.Fields.IncludeText()
includeText.Filename = "document.docx"Members
Constructors
| Constructor | Description |
|---|---|
| IncludeText | Initializes a new instance of the IncludeText class. |
| MailMergeFieldAdapter | Initializes a new instance of the MailMergeFieldAdapter class. (Inherited from MailMergeFieldAdapter.) |
Properties
| Property | Description |
|---|---|
| Bookmark | Gets and sets the bookmark switch of the field. |
| Filename | Gets and sets 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. (Inherited from MailMergeFieldAdapter.) |
| TextFormat | Gets and sets the text format of the field. |
Fields
| Field | Description |
|---|---|
| TYPE_NAME | Not described in the reference. public const string TYPE_NAME = "INCLUDETEXT"; |