Class MergeFieldEventArgs
Represents the MergeField event that occurs during mail merge operation.
Namespace: Syncfusion.DocIO.DLS
Assembly: Syncfusion.DocIO.Base.dll
Syntax
public class MergeFieldEventArgs : EventArgsConstructors
MergeFieldEventArgs(IWordDocument, String, Int32, IWMergeField, Object)
Initializes a new instance of MergeFieldEventArgs class for the specified document with table name, row index, field and its value.
Declaration
public MergeFieldEventArgs(IWordDocument doc, string tableName, int rowIndex, IWMergeField field, object value)Parameters
| Type | Name | Description |
|---|---|---|
| IWordDocument | doc | The IWordDocument instance. |
| System.String | tableName | The name of the table to perform merge. |
| System.Int32 | rowIndex | The row index in the table. |
| IWMergeField | field | The IWMergeField instance. |
| System.Object | value | An System.Object that specifies field value. |
Properties
CharacterFormat
Gets the character format of the field. Read-only.
Declaration
public WCharacterFormat CharacterFormat { get; }Property Value
| Type | Description |
|---|---|
| WCharacterFormat | The WCharacterFormat instance that specifies the character format. |
CurrentMergeField
Gets the current merge field. Read-only.
Declaration
public IWMergeField CurrentMergeField { get; }Property Value
| Type | Description |
|---|---|
| IWMergeField | The current IWMergeField instance. |
Document
Gets the document instance. Read-only.
Declaration
public IWordDocument Document { get; }Property Value
| Type | Description |
|---|---|
| IWordDocument | The IWordDocument object. |
FieldName
Gets the merge field Name. Read-only.
Declaration
public string FieldName { get; }Property Value
| Type | Description |
|---|---|
| System.String | The string that specifies the merge field name. |
FieldValue
Gets the merge field value. Read-only.
Declaration
public object FieldValue { get; }Property Value
| Type | Description |
|---|---|
| System.Object | An System.Object that specifies the field value. |
GroupName
Gets the owner group name of the merge field.
Declaration
public string GroupName { get; }Property Value
| Type |
|---|
| System.String |
RowIndex
Gets the row index. Read-only.
Declaration
public int RowIndex { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 | The integer that specifies the row index. |
TableName
Gets the table name. Read-only.
Declaration
public string TableName { get; }Property Value
| Type | Description |
|---|---|
| System.String | The string that specifies the table name. |
Text
Gets or sets the field value.
Declaration
public string Text { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The string that specifies the field value. |
TextRange
Gets the TextRange. Read-only
Declaration
public WTextRange TextRange { get; }Property Value
| Type |
|---|
| WTextRange |