TX Text Control .NET for Windows Forms

FrameMergedEventArgs Class

Class|Introduced in 34.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.FrameMergedEventArgs
Derived
BarcodeMergedEventArgs, ChartMergedEventArgs

Description

The FrameMergedEventArgs class is the base class for all event argument classes that provide information about a frame that has been merged during a mail merge operation.

Syntax

public abstract class MailMerge.FrameMergedEventArgs : EventArgs

Examples

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

Console.WriteLine($"Frame: {frameMergedEventArgs.Frame}");
Console.WriteLine("Frame Merged Event Args is ready for use.");

Members

Properties

PropertyDescription
DataRowGets the data row which is used to supply the current frame with merge content.
FrameGets the frame that has been merged.
MergeBlockNameIf the frame is part of a merge block, this property returns the name of the block. If not, an empty string is returned.
NestingDepthIf the frame 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 frame is part of. Is 0 if the frame is not part of a subtext part.
SubTextPartNumberGets the 1-based number of the subtext part the frame is part of. Is 0 if the frame is not part of a subtext part.