OdsoFieldMapData class

OdsoFieldMapData class

Specifies how a column in the external data source shall be mapped to the predefined merge fields within the document. To learn more, visit the Mail Merge and Reporting documentation article.

Remarks

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.

Constructors

NameDescription
OdsoFieldMapData()The default constructor.

Properties

NameDescription
columnSpecifies 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.
mapped_nameSpecifies the predefined merge field name which shall be mapped to the column number specified by the OdsoFieldMapData.column property within this field mapping. The default value is an empty string.
nameSpecifies the column name within an external data source for the column whose index is specified by the OdsoFieldMapData.column property. The default value is an empty string.
typeSpecifies if a given mail merge field has been mapped to a column in the given external data source or not. The default value is OdsoFieldMappingType.DEFAULT.

Methods

NameDescription
clone()Returns a deep clone of this object.

See Also