-
Notifications
You must be signed in to change notification settings - Fork 61
/
word.borderlocation.yml
80 lines (70 loc) · 2.94 KB
/
word.borderlocation.yml
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
### YamlMime:TSEnum
name: Word.BorderLocation
uid: 'word!Word.BorderLocation:enum'
package: word!
fullName: Word.BorderLocation
summary: ''
remarks: >-
\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-formatting.yaml
// Gets border details about the first table in the document.
await Word.run(async (context) => {
const firstTable = context.document.body.tables.getFirst();
const borderLocation = Word.BorderLocation.top;
const border = firstTable.getBorder(borderLocation);
border.load(["type", "color", "width"]);
await context.sync();
console.log(`Details about the ${borderLocation} border of the first table:`, `- Color: ${border.color}`, `- Type: ${border.type}`, `- Width: ${border.width} points`);
});
```
isPreview: false
isDeprecated: false
fields:
- name: all
uid: 'word!Word.BorderLocation.all:member'
package: word!
summary: '* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
value: '"All"'
- name: bottom
uid: 'word!Word.BorderLocation.bottom:member'
package: word!
summary: '* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
value: '"Bottom"'
- name: inside
uid: 'word!Word.BorderLocation.inside:member'
package: word!
summary: '* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
value: '"Inside"'
- name: insideHorizontal
uid: 'word!Word.BorderLocation.insideHorizontal:member'
package: word!
summary: '* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
value: '"InsideHorizontal"'
- name: insideVertical
uid: 'word!Word.BorderLocation.insideVertical:member'
package: word!
summary: '* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
value: '"InsideVertical"'
- name: left
uid: 'word!Word.BorderLocation.left:member'
package: word!
summary: '* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
value: '"Left"'
- name: outside
uid: 'word!Word.BorderLocation.outside:member'
package: word!
summary: '* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
value: '"Outside"'
- name: right
uid: 'word!Word.BorderLocation.right:member'
package: word!
summary: '* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
value: '"Right"'
- name: top
uid: 'word!Word.BorderLocation.top:member'
package: word!
summary: '* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
value: '"Top"'