Recipients Class

Inclusion/Exclusion Data for Data Source.When the object is serialized out as xml, its qualified name is w:recipients. Defines Recipients.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlCompositeElement
      DocumentFormat.OpenXml.OpenXmlPartRootElement
        DocumentFormat.OpenXml.Wordprocessing.Recipients

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

Syntax

'Declaration
<ChildElementInfoAttribute(GetType(RecipientData))> _
Public Class Recipients _
    Inherits OpenXmlPartRootElement
'Usage
Dim instance As Recipients
[ChildElementInfoAttribute(typeof(RecipientData))]
public class Recipients : OpenXmlPartRootElement

Remarks

The following table lists the possible child types:

  • RecipientData <w:recipientData>

[ISO/IEC 29500-1 1st Edition]

17.14.29 recipients (Inclusion/Exclusion Data for Data Source)

This element specifies all of the inclusion/exclusion data for the contents of the specified mail merge data source. It is the root element for the Mail Merge Recipient Data part.

[Example: Consider a document which is the source document for a mail merge operation. If two records of the three specified by the data source were excluded from the mail merge, the resulting recipient data part would appear as follows:

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

The recipients element contains all of the recipient inclusion/exclusion data for this mail merge document. end example]

Child Elements

Subclause

recipientData (Data About Single Data Source Record)

§17.14.27

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

© 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

Recipients Members

DocumentFormat.OpenXml.Wordprocessing Namespace