Active Class

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

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Wordprocessing.OnOffType
        DocumentFormat.OpenXml.Wordprocessing.Active

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

Syntax

'Declaration
Public Class Active _
    Inherits OnOffType
'Usage
Dim instance As Active

public class Active : OnOffType

Remarks

[ISO/IEC 29500-1 1st Edition]

17.14.1 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]

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

© ISO/IEC29500: 2008.

Thread Safety

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

See Also

Reference

Active Members

DocumentFormat.OpenXml.Wordprocessing Namespace