Aspose::Words::MailMerging::FieldMergingArgs class
Contents
[
Hide
]FieldMergingArgs class
Provides data for the MergeField event. To learn more, visit the Mail Merge and Reporting documentation article.
class FieldMergingArgs : public Aspose::Words::MailMerging::FieldMergingArgsBase
Methods
| Method | Description |
|---|---|
| get_Document() const | Returns the Document object for which the mail merge is performed. |
| get_DocumentFieldName() const | Gets the name of the merge field as specified in the document. |
| get_Field() const | Gets the object that represents the current merge field. |
| get_FieldName() const | Gets the name of the merge field in the data source. |
| get_FieldValue() const | Gets the value of the field from the data source. |
| get_RecordIndex() const | Gets the zero based index of the record that is being merged. |
| get_TableName() const | Gets the name of the data table for the current merge operation or empty string if the name is not available. |
| get_Text() const | Gets or sets the text that will be inserted into the document for the current merge field. |
| GetType() const override | |
| Is(const System::TypeInfo&) const override | |
| set_FieldValue(const System::SharedPtr<System::Object>&) | Sets the value of the field from the data source. |
| set_Text(const System::String&) | Setter for Aspose::Words::MailMerging::FieldMergingArgs::get_Text. |
| static Type() |
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.
See Also
- Class FieldMergingArgsBase
- Namespace Aspose::Words::MailMerging
- Library Aspose.Words for C++