TX Text Control .NET for Windows Forms

IncludeTextMergingEventArgs Class

Class|Introduced in 15.0
Namespace
TXTextControl.DocumentServer
Package
TXTextControl.TextControl.WinForms.SDK from the private NuGet feed or Text Control Offline Packages
Assembly
TXDocumentServer.dll
Install
dotnet add package TXTextControl.TextControl.WinForms.SDK .NET 8 and later. For .NET Framework, reference TXDocumentServer.dll from the setup.
Inherits
  1. CancelEventArgs
  2. MergedEventArgs
  3. DataMergedEventArgs
  4. MailMerge.IncludeTextMergingEventArgs

Description

The IncludeTextMergingEventArgs class provides data for the IncludeTextMerging event.

Syntax

public class MailMerge.IncludeTextMergingEventArgs : MailMerge.DataMergedEventArgs

Examples

The following example creates an Include Text Merging Event Args instance and configures its cancel setting for a document workflow.

TXTextControl.DocumentServer.MailMerge.IncludeTextMergingEventArgs includeTextMergingEventArgs = new("document.docx", new TXTextControl.DocumentServer.Fields.IncludeText());
includeTextMergingEventArgs.Cancel = true;

Members

Constructors

ConstructorDescription
IncludeTextMergingEventArgsNot described in the reference. public IncludeTextMergingEventArgs(string filename, IncludeText includeTextField);

Properties

PropertyDescription
FilenameGets a string that indicates the file name of the IncludeText field to be merged.
IncludeTextDocumentSets a byte[] array that contains the complete data of the IncludeText document. The used format is the internal TX Text Control Unicode format.
IncludeTextFieldRepresents the currently merged INCLUDETEXT field.

Further Reading