ImageFieldMergedEventArgs Class
- Namespace
TXTextControl.DocumentServer
- Package
TXTextControl.from the private NuGet feed or Text Control Offline PackagesTextControl. WinForms. SDK
- Assembly
TXDocumentServer.dll
- Install
dotnet add package TXTextControl..NET 8 and later. For .NET Framework, referenceTextControl. WinForms. SDK TXDocumentServer.from the setup.dll
- Inherits
- Cancel
Event Args - MergedEventArgs
- Mail
Merge. Image Field Merged Event Args
- Cancel
Description
The ImageFieldMergedEventArgs class provides data for the ImageFieldMerged event.
Syntax
public class MailMerge.ImageFieldMergedEventArgs : MailMerge.MergedEventArgsPublic Class MailMerge.ImageFieldMergedEventArgs
Inherits MailMerge.MergedEventArgsExamples
The following example creates an Image Field Merged Event Args instance and configures its cancel setting for a document workflow.
TXTextControl.DocumentServer.MailMerge.ImageFieldMergedEventArgs imageFieldMergedEventArgs = new("CustomerName", "document.docx", new TXTextControl.Image { FileName = @"Images\company-logo.png", Name = "CompanyLogo", DescriptiveText = "Company logo" }, true);
imageFieldMergedEventArgs.Cancel = true;Dim imageFieldMergedEventArgs As New TXTextControl.DocumentServer.MailMerge.ImageFieldMergedEventArgs("CustomerName", "document.docx", New TXTextControl.Image With { .FileName = "Images\company-logo.png", .Name = "CompanyLogo", .DescriptiveText = "Company logo" }, True)
imageFieldMergedEventArgs.Cancel = TrueMembers
Constructors
| Constructor | Description |
|---|---|
| ImageFieldMergedEventArgs | Not described in the reference. public ImageFieldMergedEventArgs(string fieldName, string filename, Image image, bool merged); |
Properties
| Property | Description |
|---|---|
| FieldName | Gets the name of the merged field. |
| Filename | Gets the filename of the merged image. |
| Image | Gets or sets the image that has been merged into the field. This allows to subsequently change the merge result. |
| MergeBlockName | If the image field is part of a merge block, this property returns the name of the block. If not, an empty string is returned. |
| Merged | Gets a bool value that indicates whether the current field has been merged successfully or not. |
| NestingDepth | If the image field is part of a merge block, this property returns the one-based nesting depth of the block. Otherwise 0 is returned. |
| TableCell | If the image field is inside of a table, this property returns the containing table cell as a TXTextControl.TableCell instance or null otherwise. |