Active class

Office 2013 and later

Record Is Included in Mail Merge. When the object is serialized out as xml, its qualified name is w:active.

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

No code example is currently available or this language may not be supported.

[ISO/IEC 29500-1 1st Edition]

active (Record Is Included in Mail Merge)

This element specifies whether a specific record from the specified external data source shall be imported into a merged WordprocessingML document when the mail merge defined for a source document is performed. If this element's val attribute is false, then the record specified by the parent element shall not used to create a merged document.

If this element is omitted for a given record, the data record associated with it shall be imported into a merged WordprocessingML document when the mail merge is performed.

[Example: Consider the following fragment from a source WordprocessingML document that is connected to an external data source containing two records, one of which is not imported into a merged WordprocessingML document when the conforming hosting application performs the data import.

<w:recipients>
  <w:recipientData>
    <w:active w:val="false" />
    …    <w:uniqueTag>1126664175</w:uniqueTag>
  </w:recipientData>
  <w:recipientData>
    …    <w:uniqueTag>
1530576378</w:uniqueTag>
  </w:recipientData
>
</w:recipients>

In this XML fragment, the external data record who is identified by the uniqueTag element (§17.14.35) with a val attribute equal to 1126664175 is not imported into a merged document as the active element associated with it has a val attribute equal to false. Conversely, the external data record associated with the uniqueTag element with a val attribute equal to 1530576378 is imported into a merged document, as its active element has been omitted (implying the default value of true). end example]

Parent Elements

recipientData (§17.14.27)

This element’s content model is defined by the common boolean property definition in §17.17.4.

© 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: