MailMergeFieldType class

Office 2013 and later

Merge Field Mapping. When the object is serialized out as xml, its qualified name is w:type.

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Wordprocessing.MailMergeFieldType

Namespace:  DocumentFormat.OpenXml.Wordprocessing
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

public class MailMergeFieldType : OpenXmlLeafElement

[ISO/IEC 29500-1 1st Edition]

type (Merge Field Mapping)

This element specifies if a given mail merge field has been mapped to a column in the given external data source or not.

If this element is omitted, then the field mapping shall be considered to be of type null (i.e. not mapped).

[Example: Consider the WordprocessingML for a single field mapping within a mail merge source document:

<w:odso>
  …  <w:fieldMapData>
    <w:type w:val="dbColumn" />
    <w:name w:val="Country" />
    <w:mappedName w:val="Country or Region" />
    <w:column w:val="9" />
    …  </w:fieldMapData>
</w:odso>

In this example, the country column within the given external data source must be mapped to the mail merge field Country or Region, as specified by the type element's val attribute being equal to dbColumn. end example]

Parent Elements

fieldMapData (§17.14.15)

Attributes

Description

val (Merge Field Mapping Type)

Specifies if the given mail merge field has been mapped to a column in the given external data source (i.e. if the merge field mapping is active or not).

[Example: Consider the following WordprocessingML fragment for a mail merge source or merged document:

<w:type w:val="null" />

In this example, the given mail merge field must not be mapped to a column in the given external data source, as specified by the type element's val attribute being equal to null. end example]

The possible values for this attribute are defined by the ST_MailMergeOdsoFMDFieldType simple type (§17.18.55).

[Note: The W3C XML Schema definition of this element’s content model (CT_MailMergeOdsoFMDFieldType) is located in §A.1. end note]

© ISO/IEC29500: 2008.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show: