Aspose::Words::Settings::OdsoFieldMapData Class Reference

Detailed Description

Specifies how a column in the external data source shall be mapped to the predefined merge fields within the document.

Microsoft Word provides some predefined merge field names that it allows to insert into a document as MERGEFIELD or use in the ADDRESSBLOCK or GREETINGLINE fields. The information specified in OdsoFieldMapData allows to map one column in the external data source to a single predefined merge field.

See also
Aspose::Words::Settings::OdsoFieldMapDataCollection
Aspose::Words::Settings::Odso

#include <Aspose.Words.Cpp/Settings/OdsoFieldMapData.h>

+ Inheritance diagram for Aspose::Words::Settings::OdsoFieldMapData:

Public Member Functions

 OdsoFieldMapData ()
 
SharedPtr< OdsoFieldMapDataClone ()
 Returns a deep clone of this object. More...
 
int32_t get_Column () const
 Specifies the zero-based index of the column within an external data source which shall be mapped to the local name of a specific MERGEFIELD field. The default value is 0. More...
 
String get_MappedName () const
 Specifies the predefined merge field name which shall be mapped to the column number specified by the Column property within this field mapping. The default value is an empty string. More...
 
String get_Name () const
 Specifies the column name within an external data source for the column whose index is specified by the Column property. The default value is an empty string. More...
 
OdsoFieldMappingType get_Type () const
 Specifies if a given mail merge field has been mapped to a column in the given external data source or not. The default value is Default. More...
 
virtual const TypeInfoGetType () const override
 
virtual bool Is (const TypeInfo &target) const override
 
void set_Column (int32_t value)
 Specifies the zero-based index of the column within an external data source which shall be mapped to the local name of a specific MERGEFIELD field. The default value is 0. More...
 
void set_MappedName (String value)
 Specifies the predefined merge field name which shall be mapped to the column number specified by the Column property within this field mapping. The default value is an empty string. More...
 
void set_Name (String value)
 Specifies the column name within an external data source for the column whose index is specified by the Column property. The default value is an empty string. More...
 
void set_Type (OdsoFieldMappingType value)
 Specifies if a given mail merge field has been mapped to a column in the given external data source or not. The default value is Default. More...
 

Static Public Member Functions

static const TypeInfoType ()
 

Constructor & Destructor Documentation

◆ OdsoFieldMapData()

Aspose::Words::Settings::OdsoFieldMapData::OdsoFieldMapData ( )

Member Function Documentation

◆ Clone()

System::SharedPtr<Aspose::Words::Settings::OdsoFieldMapData> Aspose::Words::Settings::OdsoFieldMapData::Clone ( )

Returns a deep clone of this object.

◆ get_Column()

int32_t Aspose::Words::Settings::OdsoFieldMapData::get_Column ( ) const

Specifies the zero-based index of the column within an external data source which shall be mapped to the local name of a specific MERGEFIELD field. The default value is 0.

◆ get_MappedName()

System::String Aspose::Words::Settings::OdsoFieldMapData::get_MappedName ( ) const

Specifies the predefined merge field name which shall be mapped to the column number specified by the Column property within this field mapping. The default value is an empty string.

◆ get_Name()

System::String Aspose::Words::Settings::OdsoFieldMapData::get_Name ( ) const

Specifies the column name within an external data source for the column whose index is specified by the Column property. The default value is an empty string.

◆ get_Type()

Aspose::Words::Settings::OdsoFieldMappingType Aspose::Words::Settings::OdsoFieldMapData::get_Type ( ) const

Specifies if a given mail merge field has been mapped to a column in the given external data source or not. The default value is Default.

◆ GetType()

virtual const System::TypeInfo& Aspose::Words::Settings::OdsoFieldMapData::GetType ( ) const
overridevirtual

Reimplemented from System::Object.

◆ Is()

virtual bool Aspose::Words::Settings::OdsoFieldMapData::Is ( const System::TypeInfo target) const
overridevirtual

Reimplemented from System::Object.

◆ set_Column()

void Aspose::Words::Settings::OdsoFieldMapData::set_Column ( int32_t  value)

Specifies the zero-based index of the column within an external data source which shall be mapped to the local name of a specific MERGEFIELD field. The default value is 0.

◆ set_MappedName()

void Aspose::Words::Settings::OdsoFieldMapData::set_MappedName ( System::String  value)

Specifies the predefined merge field name which shall be mapped to the column number specified by the Column property within this field mapping. The default value is an empty string.

◆ set_Name()

void Aspose::Words::Settings::OdsoFieldMapData::set_Name ( System::String  value)

Specifies the column name within an external data source for the column whose index is specified by the Column property. The default value is an empty string.

◆ set_Type()

void Aspose::Words::Settings::OdsoFieldMapData::set_Type ( Aspose::Words::Settings::OdsoFieldMappingType  value)

Specifies if a given mail merge field has been mapped to a column in the given external data source or not. The default value is Default.

◆ Type()

static const System::TypeInfo& Aspose::Words::Settings::OdsoFieldMapData::Type ( )
static