-
Notifications
You must be signed in to change notification settings - Fork 61
/
excel.rangefont.yml
314 lines (309 loc) · 11.8 KB
/
excel.rangefont.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
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
### YamlMime:TSType
name: Excel.RangeFont
uid: 'excel!Excel.RangeFont:class'
package: excel!
fullName: Excel.RangeFont
summary: 'This object represents the font attributes (font name, font size, color, etc.) for an object.'
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: class
properties:
- name: bold
uid: 'excel!Excel.RangeFont#bold:member'
package: excel!
fullName: bold
summary: Represents the bold status of the font.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'bold: boolean;'
return:
type: boolean
- name: color
uid: 'excel!Excel.RangeFont#color:member'
package: excel!
fullName: color
summary: 'HTML color code representation of the text color (e.g., \#FF0000 represents Red).'
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'color: string;'
return:
type: string
- name: context
uid: 'excel!Excel.RangeFont#context:member'
package: excel!
fullName: context
summary: >-
The request context associated with the object. This connects the add-in's process to the Office host
application's process.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'context: RequestContext;'
return:
type: '<xref uid="excel!Excel.RequestContext:class" />'
- name: italic
uid: 'excel!Excel.RangeFont#italic:member'
package: excel!
fullName: italic
summary: Specifies the italic status of the font.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'italic: boolean;'
return:
type: boolean
- name: name
uid: 'excel!Excel.RangeFont#name:member'
package: excel!
fullName: name
summary: 'Font name (e.g., "Calibri"). The name''s length should not be greater than 31 characters.'
remarks: |-
\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
// Change the font of the selected range to "Impact".
await Excel.run(async (context) => {
const selection = context.workbook.getSelectedRange();
selection.format.font.name = "Impact";
await context.sync();
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'name: string;'
return:
type: string
- name: size
uid: 'excel!Excel.RangeFont#size:member'
package: excel!
fullName: size
summary: Font size.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'size: number;'
return:
type: number
- name: strikethrough
uid: 'excel!Excel.RangeFont#strikethrough:member'
package: excel!
fullName: strikethrough
summary: >-
Specifies the strikethrough status of font. A `null` value indicates that the entire range doesn't have a uniform
strikethrough setting.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'strikethrough: boolean;'
return:
type: boolean
- name: subscript
uid: 'excel!Excel.RangeFont#subscript:member'
package: excel!
fullName: subscript
summary: >-
Specifies the subscript status of font. Returns `true` if all the fonts of the range are subscript. Returns
`false` if all the fonts of the range are superscript or normal (neither superscript, nor subscript). Returns
`null` otherwise.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'subscript: boolean;'
return:
type: boolean
- name: superscript
uid: 'excel!Excel.RangeFont#superscript:member'
package: excel!
fullName: superscript
summary: >-
Specifies the superscript status of font. Returns `true` if all the fonts of the range are superscript. Returns
`false` if all the fonts of the range are subscript or normal (neither superscript, nor subscript). Returns `null`
otherwise.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'superscript: boolean;'
return:
type: boolean
- name: tintAndShade
uid: 'excel!Excel.RangeFont#tintAndShade:member'
package: excel!
fullName: tintAndShade
summary: >-
Specifies a double that lightens or darkens a color for the range font. The value is between -1 (darkest) and 1
(brightest), with 0 for the original color. A `null` value indicates that the entire range doesn't have a uniform
font `tintAndShade` setting.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'tintAndShade: number;'
return:
type: number
- name: underline
uid: 'excel!Excel.RangeFont#underline:member'
package: excel!
fullName: underline
summary: Type of underline applied to the font. See `Excel.RangeUnderlineStyle` for details.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'underline: Excel.RangeUnderlineStyle | "None" | "Single" | "Double" | "SingleAccountant" | "DoubleAccountant";'
return:
type: >-
<xref uid="excel!Excel.RangeUnderlineStyle:enum" /> | "None" | "Single" | "Double" | "SingleAccountant" |
"DoubleAccountant"
methods:
- name: load(options)
uid: 'excel!Excel.RangeFont#load:member(1)'
package: excel!
fullName: load(options)
summary: >-
Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
the properties.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'load(options?: Excel.Interfaces.RangeFontLoadOptions): Excel.RangeFont;'
parameters:
- id: options
description: Provides options for which properties of the object to load.
type: '<xref uid="excel!Excel.Interfaces.RangeFontLoadOptions:interface" />'
return:
type: '<xref uid="excel!Excel.RangeFont:class" />'
description: ''
- name: load(propertyNames)
uid: 'excel!Excel.RangeFont#load:member(2)'
package: excel!
fullName: load(propertyNames)
summary: >-
Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
the properties.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'load(propertyNames?: string | string[]): Excel.RangeFont;'
parameters:
- id: propertyNames
description: A comma-delimited string or an array of strings that specify the properties to load.
type: 'string | string[]'
return:
type: '<xref uid="excel!Excel.RangeFont:class" />'
description: |-
#### Examples
```TypeScript
await Excel.run(async (context) => {
const sheetName = "Sheet1";
const rangeAddress = "F:G";
const worksheet = context.workbook.worksheets.getItem(sheetName);
const range = worksheet.getRange(rangeAddress);
const rangeFont = range.format.font;
rangeFont.load('name');
await context.sync();
console.log(rangeFont.name);
});
```
- name: load(propertyNamesAndPaths)
uid: 'excel!Excel.RangeFont#load:member(3)'
package: excel!
fullName: load(propertyNamesAndPaths)
summary: >-
Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
the properties.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: |-
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.RangeFont;
parameters:
- id: propertyNamesAndPaths
description: >-
`propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and
`propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
type: |-
{
select?: string;
expand?: string;
}
return:
type: '<xref uid="excel!Excel.RangeFont:class" />'
description: ''
- name: 'set(properties, options)'
uid: 'excel!Excel.RangeFont#set:member(1)'
package: excel!
fullName: 'set(properties, options)'
summary: >-
Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate
properties, or another API object of the same type.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'set(properties: Interfaces.RangeFontUpdateData, options?: OfficeExtension.UpdateOptions): void;'
parameters:
- id: properties
description: >-
A JavaScript object with properties that are structured isomorphically to the properties of the object on
which the method is called.
type: '<xref uid="excel!Excel.Interfaces.RangeFontUpdateData:interface" />'
- id: options
description: Provides an option to suppress errors if the properties object tries to set any read-only properties.
type: '<xref uid="office!OfficeExtension.UpdateOptions:interface" />'
return:
type: void
description: ''
- name: set(properties)
uid: 'excel!Excel.RangeFont#set:member(2)'
package: excel!
fullName: set(properties)
summary: 'Sets multiple properties on the object at the same time, based on an existing loaded object.'
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'set(properties: Excel.RangeFont): void;'
parameters:
- id: properties
description: ''
type: '<xref uid="excel!Excel.RangeFont:class" />'
return:
type: void
description: ''
- name: toJSON()
uid: 'excel!Excel.RangeFont#toJSON:member(1)'
package: excel!
fullName: toJSON()
summary: >-
Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to
`JSON.stringify()`<!-- -->. (`JSON.stringify`<!-- -->, in turn, calls the `toJSON` method of the object that is
passed to it.) Whereas the original Excel.RangeFont object is an API object, the `toJSON` method returns a plain
JavaScript object (typed as `Excel.Interfaces.RangeFontData`<!-- -->) that contains shallow copies of any loaded
child properties from the original object.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'toJSON(): Excel.Interfaces.RangeFontData;'
return:
type: '<xref uid="excel!Excel.Interfaces.RangeFontData:interface" />'
description: ''
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'