Description

The ImageMergedEventArgs class provides data for the ImageMerged event.

Syntax

public class MailMerge.ImageMergedEventArgs : EventArgs

Public Class MailMerge.ImageMergedEventArgs
    Inherits EventArgs

Examples

The following example creates an Image Merged Event Args instance and configures its descriptive text setting for a document workflow.

TXTextControl.DocumentServer.MailMerge.ImageMergedEventArgs imageMergedEventArgs = new(System.Drawing.Image.FromFile(@"Images\icon.png"), "CustomerName", 100);
imageMergedEventArgs.DescriptiveText = "Quarterly sales by region";

Dim imageMergedEventArgs As New TXTextControl.DocumentServer.MailMerge.ImageMergedEventArgs(System.Drawing.Image.FromFile("Images\icon.png"), "CustomerName", 100)
imageMergedEventArgs.DescriptiveText = "Quarterly sales by region"

Members

Constructors

Constructor	Description
ImageMergedEventArgs	Not described in the reference. `public ImageMergedEventArgs(System.Drawing.Image image, string name, int id);`

Properties

Property	Description
DataRow	Gets the data row which is used to supply the current image with merge content.
DescriptiveText	Gets or sets the descriptive text of the image. This property can be used to replace the descriptive text.
ID	Gets the ID of the merged image.
Image	Gets or sets the merged image. This allows the merge result to be subsequently changed.
MergeBlockName	If the image is part of a merge block, this property returns the name of the block. If not, an empty string is returned.
Merged	Gets a boolean value that indicates whether the current image has been merged successfully or not.
Name	Gets the name of the merged image.
NestingDepth	If the image is part of a merge block, this property returns the one-based nesting depth of the block. Otherwise 0 is returned.
SubTextPartID	Gets the ID of the subtext part the image is part of. Is 0 if the image is not part of a subtext part.
SubTextPartNumber	Gets the 1-based number of the subtext part the image is part of. Is 0 if the image is not part of a subtext part.