FieldMergingArgs class
FieldMergingArgs class
Provides data for the MergeField event. To learn more, visit the Mail Merge and Reporting documentation article.
Remarks
The MergeField event occurs during mail merge when a simple mail merge field is encountered in the document. You can respond to this event to return text for the mail merge engine to insert into the document.
Inheritance: FieldMergingArgs → FieldMergingArgsBase
Properties
| Name | Description |
|---|---|
| document | Returns the FieldMergingArgsBase.document object for which the mail merge is performed. (Inherited from FieldMergingArgsBase) |
| document_field_name | Gets the name of the merge field as specified in the document. (Inherited from FieldMergingArgsBase) |
| field | Gets the object that represents the current merge field. (Inherited from FieldMergingArgsBase) |
| field_name | Gets the name of the merge field in the data source. (Inherited from FieldMergingArgsBase) |
| field_value | Gets or sets the value of the field from the data source. (Inherited from FieldMergingArgsBase) |
| record_index | Gets the zero based index of the record that is being merged. (Inherited from FieldMergingArgsBase) |
| table_name | Gets the name of the data table for the current merge operation or empty string if the name is not available. (Inherited from FieldMergingArgsBase) |
| text | Gets or sets the text that will be inserted into the document for the current merge field. |
See Also
- module aspose.words.mailmerging
- class FieldMergingArgsBase
- class IFieldMergingCallback