-
Notifications
You must be signed in to change notification settings - Fork 11
/
TopBorder.xml
429 lines (355 loc) · 21.1 KB
/
TopBorder.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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
<Type Name="TopBorder" FullName="DocumentFormat.OpenXml.Wordprocessing.TopBorder">
<TypeSignature Language="C#" Value="public class TopBorder : DocumentFormat.OpenXml.Wordprocessing.BorderType" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit TopBorder extends DocumentFormat.OpenXml.Wordprocessing.BorderType" />
<TypeSignature Language="DocId" Value="T:DocumentFormat.OpenXml.Wordprocessing.TopBorder" />
<TypeSignature Language="VB.NET" Value="Public Class TopBorder
Inherits BorderType" />
<TypeSignature Language="F#" Value="type TopBorder = class
 inherit BorderType" />
<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.BorderType</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, "top")]</AttributeName>
<AttributeName Language="F#">[<DocumentFormat.OpenXml.SchemaAttr(23, "top")>]</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:top")]</AttributeName>
<AttributeName Language="F#">[<DocumentFormat.OpenXml.SchemaAttr("w:top")>]</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>Paragraph Border Above Identical Paragraphs.</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:top.</para>
</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
[!INCLUDE[openxmlnoticeiso](~/includes/openxmlnoticeiso.md)]
`top (Paragraph Border Above Identical Paragraphs)`
This element specifies the border which shall be displayed above a set of paragraphs which have the same set of paragraph border settings.
To determine if any two adjoining paragraphs shall have an individual top and bottom border or a between border, the set of borders on the two adjoining paragraphs are compared. If the border information on those two paragraphs is identical for all possible paragraphs borders, then the between border is displayed. Otherwise, the final paragraph shall use its bottom border and the following paragraph shall use its top border, respectively. If this border specifies a space attribute, that value determines the space above the text (ignoring any spacing above) which should be left before this border is drawn, specified in points.
If this element is omitted on a given paragraph, its value is determined by the setting previously set at any level of the style hierarchy (i.e. that previous setting remains unchanged). If this setting is never specified in the style hierarchy, then no between border shall be applied above identical paragraphs.
[*Example*: Consider the following two paragraphs' WordprocessingML definition:
```xml
<w:p>
<w:pPr>
<w:pBdr>
<w:top w:val="single" w:sz="24" w:space="1" w:color="F2DCDB" w:themeColor="accent2" w:themeTint="33" />
<w:left w:val="single" w:sz="24" w:space="4" w:color="B97034" w:themeColor="accent6" w:themeShade="BF" />
<w:bottom w:val="single" w:sz="24" w:space="1" w:color="F2DCDB" w:themeColor="accent2" w:themeTint="33" />
<w:right w:val="single" w:sz="24" w:space="4" w:color="C3D69B" w:themeColor="accent3" w:themeTint="99" />
<w:between w:val="single" w:sz="24" w:space="1" w:color="4F81BD" w:themeColor="accent1" />
</w:pBdr>
</w:pPr>
<w:r>
<w:t>First paragraph.</w:t>
</w:r>
</w:p>
<w:p>
<w:pPr>
<w:pBdr>
<w:top w:val="single" w:sz="24" w:space="1" w:color="F2DCDB" w:themeColor="accent2" w:themeTint="33" />
<w:left w:val="single" w:sz="24" w:space="4" w:color="B97034" w:themeColor="accent6" w:themeShade="BF" />
<w:bottom w:val="single" w:sz="24" w:space="0" w:color="F2DCDB" w:themeColor="accent2" w:themeTint="33" />
<w:right w:val="single" w:sz="24" w:space="4" w:color="C3D69B" w:themeColor="accent3" w:themeTint="99" />
<w:between w:val="single" w:sz="24" w:space="1" w:color="4F81BD" w:themeColor="accent1" />
</w:pBdr>
</w:pPr>
<w:r>
<w:t>Second paragraph.</w:t>
</w:r>
</w:p>
```
Since the paragraph border is different between the two paragraphs (the bottom space value goes from *1* to *0*), paragraph two uses its top border, which is located one point above the text in that paragraph. *end example*]
|Parent Elements|
|---------------------|
|pBdr (§17.3.1.24)|
This element’s content model is defined by the common border properties definition in §17.3.4.
[!INCLUDE[openxmlnoticeiso](~/includes/openxmlnoticeiso.md)]
`top (Table Cell Top Border)`
This element specifies the border which shall be displayed at the top of the current table cell. The appearance of this table cell border in the document shall be determined by the following settings:
- If the net tblCellSpacing element value (§17.4.45;§17.4.44;§17.4.46) applied to the cell is non-zero, then the cell border shall always be displayed
- Otherwise, the display of the border is subject to the conflict resolution algorithm defined by the tcBorders element (§17.4.67) and the tblBorders element (§17.4.40;§17.4.39)
If this element is omitted, then the top of this table cell shall not have a cell border, and its border can use the table's border settings as appropriate.
[*Example*: Consider a table in which the first cell in the first row specifies a top cell border , as follows:
R1C1
R1C2
R2C1
R2C2
This top cell border is specified using the following WordprocessingML:
```xml
<w:tc>
<w:tcPr>
… <w:tcBorders>
<w:top w:val="thinThickThinSmallGap" w:sz="24" w:space="0" w:color="FF0000"/>
</w:tcBorders>
</w:tcPr>
<w:p/>
</w:tc>
```
The top element specifies a three point border of type *thinThinThickSmallGap*. *end example*]
|Parent Elements|
|---------------------|
|tcBorders (§17.4.67)|
This element’s content model is defined by the common border properties definition in §17.3.4.
[!INCLUDE[openxmlnoticeiso](~/includes/openxmlnoticeiso.md)]
`top (Table Top Border)`
This element specifies the border which shall be displayed at the top of the current table. The appearance of this table border in the document shall be determined by the following settings:
- The display of the border is subject to the conflict resolution algorithm defined by the tcBorders element (§17.4.67) and the tblBorders element (§17.4.40;§17.4.39)
If this element is omitted, then the top of this table shall have the border specified by the associated table style. If no top border is specified in the style hierarchy, then this table shall not have a top border.
[*Example*: Consider a table in which the table properties specifies a top table border, as follows:
R1C1
R1C2
R2C1
R2C2
This top table border is specified using the following WordprocessingML:
```xml
<w:tbl>
<w:tblPr>
<w:tblBorders>
<w:top w:val="thinThickThinMediumGap" w:sz="24" w:space="0" w:color="D0D0D0" w:themeColor="accent3" w:themeTint="99"/>
</w:tblBorders>
</w:tblPr>
…</w:tbl>
```
The top element specifies a three point top table border of type *thinThinThickMediumGap*. *end example*].
|Parent Elements|
|---------------------|
|tblBorders (§17.4.39); tblBorders (§17.4.40)|
This element’s content model is defined by the common border properties definition in §17.3.4.
[!INCLUDE[openxmlnoticeiso](~/includes/openxmlnoticeiso.md)]
`top (Top Border)`
This element specifies the presentation and display of the page border displayed at the top of each page in this section.
[*Example*: Consider a section in which all pages must have a top border consisting of a repeated image of balloons, like this:
5cba059f-89ed-4087-86ae-32fc8ff26a57
This border would result in the following WordprocessingML:
```xml
<w:sectPr>
… <w:pgBorders>
<w:top w:val="balloons3Colors" …/>
</w:pgBorders>
…</w:sectPr>
```
Because the page only has a border at the top, only the top element is specified within the set of page borders. *end example*]
When a document has a top border that is relative to the page edges (using an offsetFrom attribute value of *page* on pgBorders), it shall span the top edge of the page at the location defined by its properties, stopping when:
- It intersects with the corresponding left or right page border (if one is specified)
- It reaches the edge of the page.
[*Example*: In the example above, no left or right border was specified in the WordprocessingML, so a consumer must draw the border from one edge of the page to the other. *end example*]
When a document has a top border that is relative to the text (using the offsetFrom attribute value of *text* on pgBorders), it shall only span the necessary width to satisfy the requirement of spanning the width of the text.
When a document has custom border art specified by attributes topLeft, topRight, and/or id, it shall use the corresponding relationship part item as an image for the top left corner, top right corner, and/or top border, respectively. If the corresponding relationship part item cannot be resolved the consumer shall use the border specified by the value of the val attribute. If the corresponding value of the val attribute cannot be resolved no top left corner, top right corner, or top border is present when the page is displayed.
When a document has a custom border art specified by attribute id without specifying either attributes topRight and/or topLeft, the top border as resolved by the corresponding relationship part item of attribute id shall span to the corners not specified by topRight and/or topLeft attributes.
|Parent Elements|
|---------------------|
|pgBorders (§17.6.10)|
[*Note*: The W3C XML Schema definition of this element’s content model (CT_TopPageBorder) is located in §A.1. *end note*]
[!INCLUDE[openxmlnoticeiso](~/includes/openxmlnoticeiso.md)]
`top (Top Border for HTML div)`
This element specifies the border which shall be displayed at the top of the boundaries of the current HTML *div* object.
If this element is omitted, then this HTML *div* object shall not have a top border.
[*Example*: Consider a simple HTML document defined as follows:
```xml
<html>
<body>
<div style=" border-left-style:solid; border-right-style:groove; border-right-width:1px; border-top-style:dashed; border-top-width:3px; border-bottom-style:outset; border-bottom-width:3px">
<p>paragraph of text</p>
</div>
</body>
</html>
```
This HTML would therefore normally appear as follows (image scaled appropriately):
80f86de9-0ded-4cb3-8002-c4d4140efec0
Now, when this document is saved in the WordprocessingML format, the information stored on the *div* elements is stored in the web setting part as follows:
```xml
<w:divs>
<w:div w:id="1785730240">
… <w:divBdr>
<w:top w:val="dashed" w:sz="18" w:space="7" w:color="auto" />
<w:left w:val="single" w:sz="24" w:space="4" w:color="auto" />
<w:bottom w:val="outset" w:sz="18" w:color="auto" />
<w:right w:val="threeDEngrave" w:sz="6" w:color="auto" />
</w:divBdr>
</w:div>
</w:divs>
```
The top element specifies border information about the top border for the single HTML *div* structure in the document; in this case, a 2.25 point bottom border of type *dashed*. The initial 3 pixel border was converted to 2.25 points using the following logic:
*end example*]
|Parent Elements|
|---------------------|
|divBdr (§17.15.2.7)|
This element’s content model is defined by the common border properties definition in §17.3.4.
[!INCLUDE[openxmlnoticeiso](~/includes/openxmlcopyrightiso.md)]
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TopBorder ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:DocumentFormat.OpenXml.Wordprocessing.TopBorder.#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 TopBorder 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.TopBorder.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="topBorder.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.TopBorder.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.TopBorder.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>