# MailMerge.FieldMergedEventArgs Class

> The FieldMergedEventArgs class provides data for the FieldMerged event.

- **Product:** TX Text Control .NET Server
- **Section:** Reference
- **Kind:** Class
- **Introduced:** 15.0
- **Namespace:** `TXTextControl.DocumentServer`
- **Package:** `TXTextControl.TextControl.Core.SDK` (assembly `TXDocumentServer.Core.dll`, from the private NuGet feed or Text Control Offline Packages)
- **Package:** `TXTextControl.TextControl.ASP.SDK` (assembly `TXDocumentServer.dll`, from the private NuGet feed or Text Control Offline Packages)
- **.NET Framework:** reference `TXDocumentServer.dll` from the setup
- **Inherits:** `System.ComponentModel.CancelEventArgs` › `TXTextControl.DocumentServer.MailMerge.MergedEventArgs` › `TXTextControl.DocumentServer.MailMerge.DataMergedEventArgs`
- **Path:** TX Text Control .NET Server > Reference > TXTextControl.DocumentServer > MailMerge.FieldMergedEventArgs Class
- **1255 words**
- **Web URL:** https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver/mailmerge-fieldmergedeventargs/
- **LLMs URL:** https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver/mailmerge-fieldmergedeventargs/llms.txt
- **LLMs-Full URL:** https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver/mailmerge-fieldmergedeventargs/llms-full.txt

---

### Description

The FieldMergedEventArgs class provides data for the [FieldMerged](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver/mailmerge/fieldmerged-event/llms-full.txt) event.

### Syntax

```csharp
public class MailMerge.FieldMergedEventArgs : MailMerge.DataMergedEventArgs
```

```vbnet
Public Class MailMerge.FieldMergedEventArgs
    Inherits MailMerge.DataMergedEventArgs
```

### Examples

The following example creates a Field Merged Event Args instance and configures its cancel setting for a document workflow.

```csharp
TXTextControl.DocumentServer.MailMerge.FieldMergedEventArgs fieldMergedEventArgs = new(new TXTextControl.DocumentServer.Fields.DateField(), new byte[] { 1 }, true);
fieldMergedEventArgs.Cancel = true;
```

```vbnet
Dim fieldMergedEventArgs As New TXTextControl.DocumentServer.MailMerge.FieldMergedEventArgs(New TXTextControl.DocumentServer.Fields.DateField(), New Byte() { 1 }, True)
fieldMergedEventArgs.Cancel = True
```

---

## In This Section

- [MailMerge.FieldMergedEventArgs.Cancel Property](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver/mailmerge-fieldmergedeventargs/cancel-property/llms-full.txt): Gets or sets a value indicating whether the current merge process should be canceled.
- [MailMerge.FieldMergedEventArgs.DataRow Property](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver/mailmerge-fieldmergedeventargs/datarow-property/llms-full.txt): Gets the data row which is used to supply the current field with merge content.
- [MailMerge.FieldMergedEventArgs.MailMergeFieldAdapter Property](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver/mailmerge-fieldmergedeventargs/mailmergefieldadapter-property/llms-full.txt): Gets or sets a MailMergeFieldAdapter that contains the already merged field. The complete field can be changed in this event.
- [MailMerge.FieldMergedEventArgs.MergeBlockName Property](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver/mailmerge-fieldmergedeventargs/mergeblockname-property/llms-full.txt): If the merge field is part of a merge block, this property returns the name of the block. If not, an empty string is returned.
- [MailMerge.FieldMergedEventArgs.Merged Property](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver/mailmerge-fieldmergedeventargs/merged-property/llms-full.txt): Gets a bool value that indicates whether the current field has been merged successfully or not.
- [MailMerge.FieldMergedEventArgs.MergedField Property](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver/mailmerge-fieldmergedeventargs/mergedfield-property/llms-full.txt): Gets or sets a byte array that contains the complete data of the merged field. The used format is the internal TX Text Control Unicode format.
- [MailMerge.FieldMergedEventArgs.NestingDepth Property](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver/mailmerge-fieldmergedeventargs/nestingdepth-property/llms-full.txt): If the merge field is part of a merge block, this property returns the one-based nesting depth of the block. Otherwise 0 is returned.
- [MailMerge.FieldMergedEventArgs.SubTextPartID Property](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver/mailmerge-fieldmergedeventargs/subtextpartid-property/llms-full.txt): Gets the ID of the subtext part the field is part of. Is 0 if the field is not part of a subtext part.
- [MailMerge.FieldMergedEventArgs.SubTextPartNumber Property](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver/mailmerge-fieldmergedeventargs/subtextpartnumber-property/llms-full.txt): Gets 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.
- [MailMerge.FieldMergedEventArgs.TableCell Property](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver/mailmerge-fieldmergedeventargs/tablecell-property/llms-full.txt): If the merge field is inside of a table, this property returns the containing table cell as a TXTextControl.TableCell instance or null otherwise.

---

## Nearby

- **Previous:** [MailMerge.FieldMerged Event](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver/mailmerge/fieldmerged-event/llms-full.txt)
- **Next:** [MailMerge.FieldMergedEventArgs.Cancel Property](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver/mailmerge-fieldmergedeventargs/cancel-property/llms-full.txt)