TX Text Control .NET for Windows Forms

FieldMergedEventArgs 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.FieldMergedEventArgs

Description

The FieldMergedEventArgs class provides data for the FieldMerged event.

Syntax

public class MailMerge.FieldMergedEventArgs : MailMerge.DataMergedEventArgs

Examples

The following example creates a Field Merged Event Args instance and configures its cancel setting for a document workflow.

TXTextControl.DocumentServer.MailMerge.FieldMergedEventArgs fieldMergedEventArgs = new(new TXTextControl.DocumentServer.Fields.DateField(), new byte[] { 1 }, true);
fieldMergedEventArgs.Cancel = true;

Members

Constructors

ConstructorDescription
FieldMergedEventArgsNot described in the reference. public FieldMergedEventArgs(MailMergeFieldAdapter mergeField, byte[] fieldData, bool merged);

Properties

PropertyDescription
CancelGets or sets a value indicating whether the current merge process should be canceled.
DataRowGets the data row which is used to supply the current field with merge content.
MailMergeFieldAdapterGets or sets a MailMergeFieldAdapter that contains the already merged field. The complete field can be changed in this event.
MergeBlockNameIf the merge field is part of a merge block, this property returns the name of the block. If not, an empty string is returned.
MergedGets a bool value that indicates whether the current field has been merged successfully or not.
MergedFieldGets or sets a byte array that contains the complete data of the merged field. The used format is the internal TX Text Control Unicode format.
NestingDepthIf the merge field is part of a merge block, this property returns the one-based nesting depth of the block. Otherwise 0 is returned.
SubTextPartIDGets the ID of the subtext part the field is part of. Is 0 if the field is not part of a subtext part.
SubTextPartNumberGets the 1-based number of the subtext part the field is part of. Is 0 if the field is not part of a subtext part.
TableCellIf the merge field is inside of a table, this property returns the containing table cell as a TXTextControl.TableCell instance or null otherwise.

Further Reading