Base class for FieldMergingArgs and ImageFieldMergingArgs.
Shows how to execute a mail merge with a custom callback that handles merge data in the form of HTML documents.
#include <Aspose.Words.Cpp/MailMerging/FieldMergingArgsBase.h>
Public Member Functions | |
const SharedPtr< Document > & | get_Document () const |
Returns the Document object for which the mail merge is performed. More... | |
String | get_DocumentFieldName () const |
Gets the name of the merge field as specified in the document. More... | |
const SharedPtr< FieldMergeField > & | get_Field () const |
Gets the object that represents the current merge field. More... | |
String | get_FieldName () const |
Gets the name of the merge field in the data source. More... | |
const SharedPtr< Object > & | get_FieldValue () const |
Gets the value of the field from the data source. More... | |
int32_t | get_RecordIndex () const |
Gets the zero based index of the record that is being merged. More... | |
String | get_TableName () const |
Gets the name of the data table for the current merge operation or empty string if the name is not available. More... | |
virtual const TypeInfo & | GetType () const override |
virtual bool | Is (const TypeInfo &target) const override |
void | set_FieldValue (const SharedPtr< Object > &value) |
Sets the value of the field from the data source. More... | |
Static Public Member Functions | |
static const TypeInfo & | Type () |
const System::SharedPtr< Aspose::Words::Document > & Aspose::Words::MailMerging::FieldMergingArgsBase::get_Document | ( | ) | const |
Returns the Document object for which the mail merge is performed.
Shows how to execute a mail merge with a custom callback that handles merge data in the form of HTML documents.
System::String Aspose::Words::MailMerging::FieldMergingArgsBase::get_DocumentFieldName | ( | ) | const |
Gets the name of the merge field as specified in the document.
If you have a mapping from a document field name to a different data source field name, then this is the original field name as specified in the document.
If you specified a field name prefix, for example "Image:MyFieldName" in the document, then DocumentFieldName returns field name without the prefix, that is "MyFieldName".
Shows how to execute a mail merge with a custom callback that handles merge data in the form of HTML documents.
const System::SharedPtr< Aspose::Words::Fields::FieldMergeField > & Aspose::Words::MailMerging::FieldMergingArgsBase::get_Field | ( | ) | const |
Gets the object that represents the current merge field.
Shows how to execute a mail merge with a custom callback that handles merge data in the form of HTML documents.
System::String Aspose::Words::MailMerging::FieldMergingArgsBase::get_FieldName | ( | ) | const |
Gets the name of the merge field in the data source.
If you have a mapping from a document field name to a different data source field name, then this is the mapped field name.
If you specified a field name prefix, for example "Image:MyFieldName" in the document, then FieldName returns field name without the prefix, that is "MyFieldName".
const System::SharedPtr< System::Object > & Aspose::Words::MailMerging::FieldMergingArgsBase::get_FieldValue | ( | ) | const |
Gets the value of the field from the data source.
int32_t Aspose::Words::MailMerging::FieldMergingArgsBase::get_RecordIndex | ( | ) | const |
Gets the zero based index of the record that is being merged.
System::String Aspose::Words::MailMerging::FieldMergingArgsBase::get_TableName | ( | ) | const |
Gets the name of the data table for the current merge operation or empty string if the name is not available.
|
overridevirtual |
Reimplemented from System::Object.
Reimplemented in Aspose::Words::MailMerging::FieldMergingArgs, and Aspose::Words::MailMerging::ImageFieldMergingArgs.
|
overridevirtual |
Reimplemented from System::Object.
Reimplemented in Aspose::Words::MailMerging::FieldMergingArgs, and Aspose::Words::MailMerging::ImageFieldMergingArgs.
void Aspose::Words::MailMerging::FieldMergingArgsBase::set_FieldValue | ( | const System::SharedPtr< System::Object > & | value | ) |
Sets the value of the field from the data source.
|
static |