-
Notifications
You must be signed in to change notification settings - Fork 64
/
word.interfaces.fontloadoptions.yml
173 lines (173 loc) · 6.75 KB
/
word.interfaces.fontloadoptions.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
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
### YamlMime:TSType
name: Word.Interfaces.FontLoadOptions
uid: 'word!Word.Interfaces.FontLoadOptions:interface'
package: word!
fullName: Word.Interfaces.FontLoadOptions
summary: Represents a font.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: interface
properties:
- name: $all
uid: 'word!Word.Interfaces.FontLoadOptions#$all:member'
package: word!
fullName: $all
summary: >-
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`<!-- -->) but not
the navigational properties (such as `Range.format.fill.color`<!-- -->).
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: '$all?: boolean;'
return:
type: boolean
- name: bold
uid: 'word!Word.Interfaces.FontLoadOptions#bold:member'
package: word!
fullName: bold
summary: >-
Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise,
false.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'bold?: boolean;'
return:
type: boolean
- name: color
uid: 'word!Word.Interfaces.FontLoadOptions#color:member'
package: word!
fullName: color
summary: 'Specifies the color for the specified font. You can provide the value in the ''\#RRGGBB'' format or the color name.'
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'color?: boolean;'
return:
type: boolean
- name: doubleStrikeThrough
uid: 'word!Word.Interfaces.FontLoadOptions#doubleStrikeThrough:member'
package: word!
fullName: doubleStrikeThrough
summary: >-
Specifies a value that indicates whether the font has a double strikethrough. True if the font is formatted as
double strikethrough text, otherwise, false.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'doubleStrikeThrough?: boolean;'
return:
type: boolean
- name: highlightColor
uid: 'word!Word.Interfaces.FontLoadOptions#highlightColor:member'
package: word!
fullName: highlightColor
summary: >-
Specifies the highlight color. To set it, use a value either in the '\#RRGGBB' format or the color name. To remove
highlight color, set it to null. The returned highlight color can be in the '\#RRGGBB' format, an empty string for
mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in
Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal",
"Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for
Windows Desktop, any other color is converted to the closest color when applied to the font.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'highlightColor?: boolean;'
return:
type: boolean
- name: italic
uid: 'word!Word.Interfaces.FontLoadOptions#italic:member'
package: word!
fullName: italic
summary: 'Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false.'
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'italic?: boolean;'
return:
type: boolean
- name: name
uid: 'word!Word.Interfaces.FontLoadOptions#name:member'
package: word!
fullName: name
summary: Specifies a value that represents the name of the font.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'name?: boolean;'
return:
type: boolean
- name: size
uid: 'word!Word.Interfaces.FontLoadOptions#size:member'
package: word!
fullName: size
summary: Specifies a value that represents the font size in points.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'size?: boolean;'
return:
type: boolean
- name: strikeThrough
uid: 'word!Word.Interfaces.FontLoadOptions#strikeThrough:member'
package: word!
fullName: strikeThrough
summary: >-
Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as
strikethrough text, otherwise, false.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'strikeThrough?: boolean;'
return:
type: boolean
- name: subscript
uid: 'word!Word.Interfaces.FontLoadOptions#subscript:member'
package: word!
fullName: subscript
summary: >-
Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript,
otherwise, false.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'subscript?: boolean;'
return:
type: boolean
- name: superscript
uid: 'word!Word.Interfaces.FontLoadOptions#superscript:member'
package: word!
fullName: superscript
summary: >-
Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript,
otherwise, false.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'superscript?: boolean;'
return:
type: boolean
- name: underline
uid: 'word!Word.Interfaces.FontLoadOptions#underline:member'
package: word!
fullName: underline
summary: Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'underline?: boolean;'
return:
type: boolean