TX Text Control .NET for Windows Forms

FormFieldMergedEventArgs Class

Class|Introduced in 30.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. EventArgs
  2. MailMerge.FormFieldMergedEventArgs

Description

The FormFieldMergedEventArgs class provides data for the FormFieldMerged event.

Syntax

public class MailMerge.FormFieldMergedEventArgs : EventArgs

Examples

The following example includes the form field value from a Form Field Merged Event Args object in application diagnostics. The created object is then available to the surrounding document workflow.

Console.WriteLine($"Form Field: {formFieldMergedEventArgs.FormField}");
Console.WriteLine("Form Field Merged Event Args is ready for use.");

Members

Properties

PropertyDescription
DataRowGets the data row which is used to supply the current field with merge content.
FormFieldGets the already merged FormField.
MergeBlockNameIf the form field is part of a merge block, this property returns the name of the block. If not, an empty string is returned.
MergedGets a boolean value that indicates whether the current field has been merged successfully or not.
NestingDepthIf the form 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 form field is inside of a table, this property returns the containing table cell as a TXTextControl.TableCell instance or null otherwise.