-
Notifications
You must be signed in to change notification settings - Fork 11
/
RecipientDataReference.xml
245 lines (230 loc) · 14.4 KB
/
RecipientDataReference.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
<Type Name="RecipientDataReference" FullName="DocumentFormat.OpenXml.Wordprocessing.RecipientDataReference">
<TypeSignature Language="C#" Value="public class RecipientDataReference : DocumentFormat.OpenXml.Wordprocessing.RelationshipType" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit RecipientDataReference extends DocumentFormat.OpenXml.Wordprocessing.RelationshipType" />
<TypeSignature Language="DocId" Value="T:DocumentFormat.OpenXml.Wordprocessing.RecipientDataReference" />
<TypeSignature Language="VB.NET" Value="Public Class RecipientDataReference
Inherits RelationshipType" />
<TypeSignature Language="F#" Value="type RecipientDataReference = class
 inherit RelationshipType" />
<AssemblyInfo>
<AssemblyName>DocumentFormat.OpenXml</AssemblyName>
<AssemblyVersion>0.0.1.0</AssemblyVersion>
<AssemblyVersion>2.7.2.0</AssemblyVersion>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
<AssemblyVersion>2.8.1.0</AssemblyVersion>
<AssemblyVersion>2.9.0.0</AssemblyVersion>
<AssemblyVersion>2.9.1.0</AssemblyVersion>
<AssemblyVersion>2.10.0.0</AssemblyVersion>
<AssemblyVersion>2.10.1.0</AssemblyVersion>
<AssemblyVersion>2.11.0.0</AssemblyVersion>
<AssemblyVersion>2.11.1.0</AssemblyVersion>
<AssemblyVersion>2.11.2.0</AssemblyVersion>
<AssemblyVersion>2.11.3.0</AssemblyVersion>
<AssemblyVersion>2.12.0.0</AssemblyVersion>
<AssemblyVersion>2.12.1.0</AssemblyVersion>
<AssemblyVersion>2.12.2.0</AssemblyVersion>
<AssemblyVersion>2.12.3.0</AssemblyVersion>
<AssemblyVersion>2.13.0.0</AssemblyVersion>
<AssemblyVersion>2.13.1.0</AssemblyVersion>
<AssemblyVersion>2.14.0.0</AssemblyVersion>
<AssemblyVersion>2.15.0.0</AssemblyVersion>
<AssemblyVersion>2.16.0.0</AssemblyVersion>
<AssemblyVersion>2.17.1.0</AssemblyVersion>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
<AssemblyVersion>2.19.0.0</AssemblyVersion>
<AssemblyVersion>2.20.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.0.1.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>DocumentFormat.OpenXml.Wordprocessing.RelationshipType</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="openxml-2.10.0;openxml-2.10.1;openxml-2.11.0;openxml-2.9.0;openxml-2.9.1">
<AttributeName Language="C#">[DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2007)]</AttributeName>
<AttributeName Language="F#">[<DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2007)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="openxml-2.10.0;openxml-2.10.1;openxml-2.11.0;openxml-2.12.0;openxml-2.12.1;openxml-2.12.2;openxml-2.12.3;openxml-2.13.0;openxml-2.13.1;openxml-2.14.0">
<AttributeName Language="C#">[DocumentFormat.OpenXml.SchemaAttr(23, "recipientData")]</AttributeName>
<AttributeName Language="F#">[<DocumentFormat.OpenXml.SchemaAttr(23, "recipientData")>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="openxml-2.15.0;openxml-2.16.0;openxml-2.17.1;openxml-2.18.0;openxml-2.19.0;openxml-2.20.0">
<AttributeName Language="C#">[DocumentFormat.OpenXml.SchemaAttr("w:recipientData")]</AttributeName>
<AttributeName Language="F#">[<DocumentFormat.OpenXml.SchemaAttr("w:recipientData")>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="openxml-2.7.1;openxml-2.7.2;openxml-2.8.0;openxml-2.8.1;openxml-2.9.0;openxml-2.9.1">
<AttributeName Language="C#">[System.CodeDom.Compiler.GeneratedCode("DomGen", "2.0")]</AttributeName>
<AttributeName Language="F#">[<System.CodeDom.Compiler.GeneratedCode("DomGen", "2.0")>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="openxml-3.0.1">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(0)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="openxml-3.0.1">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
<para>Reference to Inclusion/Exclusion Data for Data Source.</para>
<para>This class is available in Office 2007 and above.</para>
<para>When the object is serialized out as xml, it's qualified name is w:recipientData.</para>
</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
[!INCLUDE[openxmlnoticeiso](~/includes/openxmlnoticeiso.md)]
**recipientData (Reference to Inclusion/Exclusion Data for Data Source)**
This element shall specify a reference to the part which contains data about whether the set of records in the associated data source have been explicitly included or excluded from the specified mail merge. Only those records which must not be used to generate merged WordprocessingML documents shall be stored within the referenced part, as all records shall be merged by default as part of the mail merge operation. [*Guidance*: Applications can choose to store only those records which are excluded for efficiency, or a list of all records in order to determine which set of records were added/removed between mail merge operations. *end guidance*]
[*Rationale*: When defining a mail merge, it is possible that a user wishes to connect to a specified data source, but specify only a subset of the records returned by the query specified by the query element (§17.14.26) which must be merged as part of the mail merge operation. This element allows applications to utilize a separate part to store this information, either the shared part defined by /IEC 29500, or an application-defined part as needed. *end rationale*]
If the relationship type of the relationship specified by this element is not *http://schemas.openxmlformats.org/officeDocument/2006/mailMergeRecipientData*, is not present, or does not have a TargetMode attribute value of *Internal*, then the document shall be considered non-conformant. If an application cannot process external content of the content type specified by the targeted part, then it can be ignored.
/IEC 29500 defines one shared mechanism for storing this data: using the Mail Merge Recipient Data part. This mechanism shall be used if the associated data source has a column which can be used as the unique key. However, when using data sources which do not have a unique key, applications can store their own part (of an application-defined content type) using this relationship.
[*Example*: Consider a WordprocessingML document which is a mail merge source document, containing inclusion/exclusion data for the data source. The document settings part would contain the mail merge data:
```xml
<w:settings>
… <w:mailMerge>
…
<w:odso>
… <w:recipientData r:id="recipient1" />
</w:odso>
</w:mailMerge>
</w:settings>
```
The recipientData element specifies that the external content targeted by the relationship with an ID of *recipient1* contains the recipient inclusion/exclusion data for the mail merge operation. Examining the contents of the corresponding relationship part item, we can see the targets for that relationship:
```xml
<Relationships … >
… <Relationship Id="recipient1" TargetMode="Internal" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/mailMergeRecipientData" Target="recipientData.xml" />
…</Relationships>
```
The corresponding relationship part item shows that the file containing this data is located next to the main document and is named *recipientData.xml*. *end example*]
|Parent Elements|
|---------------------|
|odso (§17.14.25)|
[*Note*: The W3C XML Schema definition of this element’s content model (CT_Rel) is located in §A.1. *end note*]
[!INCLUDE[openxmlnoticeiso](~/includes/openxmlcopyrightiso.md)]
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public RecipientDataReference ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:DocumentFormat.OpenXml.Wordprocessing.RecipientDataReference.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>DocumentFormat.OpenXml</AssemblyName>
<AssemblyVersion>0.0.1.0</AssemblyVersion>
<AssemblyVersion>2.7.2.0</AssemblyVersion>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
<AssemblyVersion>2.8.1.0</AssemblyVersion>
<AssemblyVersion>2.9.0.0</AssemblyVersion>
<AssemblyVersion>2.9.1.0</AssemblyVersion>
<AssemblyVersion>2.10.0.0</AssemblyVersion>
<AssemblyVersion>2.10.1.0</AssemblyVersion>
<AssemblyVersion>2.11.0.0</AssemblyVersion>
<AssemblyVersion>2.11.1.0</AssemblyVersion>
<AssemblyVersion>2.11.2.0</AssemblyVersion>
<AssemblyVersion>2.11.3.0</AssemblyVersion>
<AssemblyVersion>2.12.0.0</AssemblyVersion>
<AssemblyVersion>2.12.1.0</AssemblyVersion>
<AssemblyVersion>2.12.2.0</AssemblyVersion>
<AssemblyVersion>2.12.3.0</AssemblyVersion>
<AssemblyVersion>2.13.0.0</AssemblyVersion>
<AssemblyVersion>2.13.1.0</AssemblyVersion>
<AssemblyVersion>2.14.0.0</AssemblyVersion>
<AssemblyVersion>2.15.0.0</AssemblyVersion>
<AssemblyVersion>2.16.0.0</AssemblyVersion>
<AssemblyVersion>2.17.1.0</AssemblyVersion>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
<AssemblyVersion>2.19.0.0</AssemblyVersion>
<AssemblyVersion>2.20.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.0.1.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the RecipientDataReference class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CloneNode">
<MemberSignature Language="C#" Value="public override DocumentFormat.OpenXml.OpenXmlElement CloneNode (bool deep);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class DocumentFormat.OpenXml.OpenXmlElement CloneNode(bool deep) cil managed" />
<MemberSignature Language="DocId" Value="M:DocumentFormat.OpenXml.Wordprocessing.RecipientDataReference.CloneNode(System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function CloneNode (deep As Boolean) As OpenXmlElement" />
<MemberSignature Language="F#" Value="override this.CloneNode : bool -> DocumentFormat.OpenXml.OpenXmlElement" Usage="recipientDataReference.CloneNode deep" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>DocumentFormat.OpenXml</AssemblyName>
<AssemblyVersion>0.0.1.0</AssemblyVersion>
<AssemblyVersion>2.7.2.0</AssemblyVersion>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
<AssemblyVersion>2.8.1.0</AssemblyVersion>
<AssemblyVersion>2.9.0.0</AssemblyVersion>
<AssemblyVersion>2.9.1.0</AssemblyVersion>
<AssemblyVersion>2.10.0.0</AssemblyVersion>
<AssemblyVersion>2.10.1.0</AssemblyVersion>
<AssemblyVersion>2.11.0.0</AssemblyVersion>
<AssemblyVersion>2.11.1.0</AssemblyVersion>
<AssemblyVersion>2.11.2.0</AssemblyVersion>
<AssemblyVersion>2.11.3.0</AssemblyVersion>
<AssemblyVersion>2.12.0.0</AssemblyVersion>
<AssemblyVersion>2.12.1.0</AssemblyVersion>
<AssemblyVersion>2.12.2.0</AssemblyVersion>
<AssemblyVersion>2.12.3.0</AssemblyVersion>
<AssemblyVersion>2.13.0.0</AssemblyVersion>
<AssemblyVersion>2.13.1.0</AssemblyVersion>
<AssemblyVersion>2.14.0.0</AssemblyVersion>
<AssemblyVersion>2.15.0.0</AssemblyVersion>
<AssemblyVersion>2.16.0.0</AssemblyVersion>
<AssemblyVersion>2.17.1.0</AssemblyVersion>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
<AssemblyVersion>2.19.0.0</AssemblyVersion>
<AssemblyVersion>2.20.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.0.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>DocumentFormat.OpenXml.OpenXmlElement</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="deep" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="deep">true to recursively clone the subtree under the specified node; false to clone only the node itself.</param>
<summary>Creates a duplicate of this node.</summary>
<returns>Returns the cloned node.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="LocalName">
<MemberSignature Language="C#" Value="public override string LocalName { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string LocalName" />
<MemberSignature Language="DocId" Value="P:DocumentFormat.OpenXml.Wordprocessing.RecipientDataReference.LocalName" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property LocalName As String" />
<MemberSignature Language="F#" Value="member this.LocalName : string" Usage="DocumentFormat.OpenXml.Wordprocessing.RecipientDataReference.LocalName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>DocumentFormat.OpenXml</AssemblyName>
<AssemblyVersion>0.0.1.0</AssemblyVersion>
<AssemblyVersion>2.7.2.0</AssemblyVersion>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
<AssemblyVersion>2.8.1.0</AssemblyVersion>
<AssemblyVersion>2.9.0.0</AssemblyVersion>
<AssemblyVersion>2.9.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>