-
Notifications
You must be signed in to change notification settings - Fork 13
/
SubDocumentReference.xml
270 lines (249 loc) · 14.6 KB
/
SubDocumentReference.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
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
<Type Name="SubDocumentReference" FullName="DocumentFormat.OpenXml.Wordprocessing.SubDocumentReference">
<TypeSignature Language="C#" Value="public class SubDocumentReference : DocumentFormat.OpenXml.Wordprocessing.RelationshipType" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SubDocumentReference extends DocumentFormat.OpenXml.Wordprocessing.RelationshipType" />
<TypeSignature Language="DocId" Value="T:DocumentFormat.OpenXml.Wordprocessing.SubDocumentReference" />
<TypeSignature Language="VB.NET" Value="Public Class SubDocumentReference
Inherits RelationshipType" />
<TypeSignature Language="F#" Value="type SubDocumentReference = 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, "subDoc")]</AttributeName>
<AttributeName Language="F#">[<DocumentFormat.OpenXml.SchemaAttr(23, "subDoc")>]</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:subDoc")]</AttributeName>
<AttributeName Language="F#">[<DocumentFormat.OpenXml.SchemaAttr("w:subDoc")>]</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>Anchor for Subdocument Location.</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:subDoc.</para>
</summary>
<remarks>
<format type="text/markdown"><]
`subDoc (Anchor for Subdocument Location)`
This element specifies a location within a master document for the insertion of the contents of a specified subdocument. The specified subdocument's contents should appear at the specified location within the master document as needed, but shall remain part of the separate file specified by the subdocument location. The location of the subdocument shall be specified by the relationship whose Id attribute matches the id attribute on this element.
If the relationship type of the relationship specified by this element is not http://schemas.openxmlformats.org/officeDocument/2006/subDocument, is not present, or does not have a TargetMode attribute value of *External*, then the document shall be considered non-conformant.
When a subdocument is displayed at the specified location within the master document, the following logic determines how the styles and formatting of the subdocument and associated master document shall be handled:
- All direct formatting in the subdocument is retained.
- For each style in each subdocument:
*If a style with the same styleId attribute value exists in the master document, display the contents of the subdocument using the style in the master document.*
*Otherwise, import the style into the master document and display the content using the original style.*
*If a subsequent subdocument also contains a style with the same styleId attribute value, the latter’s style is ignored and the content is displayed using the version of the style imported into the master document.*
[*Example*: Consider a book consisting of three chapters, two of which have been divided into subdocuments as follows (the red rectangle indicates the bounds of each subdocument's contents):
35b1894c-1477-4693-aeec-f0baccc69f21
The resulting master document would consist of its own WordprocessingML content as well as subdocument anchors in the appropriate locations:
```xml
<w:body>
<w:p>
… <w:r>
<w:t>My Book</w:t>
</w:r>
</w:p>
<w:p>
<w:r>
<w:t>Once upon a time…</w:t>
</w:r>
</w:p>
<w:p>
<w:subDoc r:id="subDocRel1" />
</w:p>
<w:p>
<w:subDoc r:id="subDocRel2" />
</w:p>
<w:sectPr>
… </w:sectPr>
</w:body>
```
The two subDoc elements specify that the subdocuments targeted by the relationships with an ID of subDocRel1 and subDocRel2 must be imported in that order after the content of the first two paragraphs of content. Examining the contents of the corresponding relationship part item, we can see the targets for those relationships:
```xml
<Relationships … >
… <Relationship Id="subDocRel1" TargetMode="External" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/subDocument" Target="Chapter1.docx" />
<Relationship Id="subDocRel2" TargetMode="External" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/subDocument" Target="Chapter2.docx" />
…</Relationships>
```
The corresponding relationship part item shows that the two files to be imported are located in the same location as the current file and name *Chapter1.docx* and *Chapter2.docx* respectively. *end example*]
|Parent Elements|
|---------------------|
|bdo (§17.3.2.3); customXml (§17.5.1.3); dir (§17.3.2.8); fldSimple (§17.16.19); hyperlink (§17.16.22); p (§17.3.1.22); sdtContent (§17.5.2.36); smartTag (§17.5.1.9)|
[*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 SubDocumentReference ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:DocumentFormat.OpenXml.Wordprocessing.SubDocumentReference.#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 SubDocumentReference 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.SubDocumentReference.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="subDocumentReference.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.SubDocumentReference.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.SubDocumentReference.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>