BlockMergingEventArgs 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 - Mail
Merge. Block Merging Event Args
- Cancel
Description
The BlockMergingEventArgs class provides data for the BlockMerging event.
Syntax
public class MailMerge.BlockMergingEventArgs : CancelEventArgsPublic Class MailMerge.BlockMergingEventArgs
Inherits CancelEventArgsExamples
The following example creates a Block Merging Event Args instance and configures its cancel setting for a document workflow.
TXTextControl.DocumentServer.MailMerge.BlockMergingEventArgs blockMergingEventArgs = new("CustomerName", Array.Empty<TXTextControl.DocumentServer.DataSources.IDataRowAdapter>());
blockMergingEventArgs.Cancel = true;Dim blockMergingEventArgs As New TXTextControl.DocumentServer.MailMerge.BlockMergingEventArgs("CustomerName", Array.Empty(Of TXTextControl.DocumentServer.DataSources.IDataRowAdapter)())
blockMergingEventArgs.Cancel = TrueMembers
Constructors
| Constructor | Description |
|---|---|
| BlockMergingEventArgs | Not described in the reference. public BlockMergingEventArgs(string blockName, IDataRowAdapter[] data, int subTextPartID, int subTextPartNumber); |
Properties
| Property | Description |
|---|---|
| BlockData | Gets the block data as an array of data rows. Each data row implements the IDataRowAdapter interface. |
| BlockName | Gets the name of the merge block the event was fired for. |
| ColumnNames | Gets the column names of the table supplying the data for the block. |
| SubTextPartID | Gets the ID of the subtext part that represents the block. |
| SubTextPartNumber | Gets the 1-based number of the subtext part that represents the block. |