-
Notifications
You must be signed in to change notification settings - Fork 62
/
excel.interfaces.rangeformatloadoptions.yml
137 lines (137 loc) · 5.61 KB
/
excel.interfaces.rangeformatloadoptions.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
### YamlMime:TSType
name: Excel.Interfaces.RangeFormatLoadOptions
uid: 'excel!Excel.Interfaces.RangeFormatLoadOptions:interface'
package: excel!
fullName: Excel.Interfaces.RangeFormatLoadOptions
summary: 'A format object encapsulating the range''s font, fill, borders, alignment, and other properties.'
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: interface
properties:
- name: $all
uid: 'excel!Excel.Interfaces.RangeFormatLoadOptions#$all:member'
package: excel!
fullName: $all
summary: >-
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`<!-- -->) but not the
navigational properties (e.g.: `Range.format.fill.color`<!-- -->).
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: '$all?: boolean;'
return:
type: boolean
- name: borders
uid: 'excel!Excel.Interfaces.RangeFormatLoadOptions#borders:member'
package: excel!
fullName: borders
summary: Collection of border objects that apply to the overall range.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'borders?: Excel.Interfaces.RangeBorderCollectionLoadOptions;'
return:
type: '<xref uid="excel!Excel.Interfaces.RangeBorderCollectionLoadOptions:interface" />'
- name: columnWidth
uid: 'excel!Excel.Interfaces.RangeFormatLoadOptions#columnWidth:member'
package: excel!
fullName: columnWidth
summary: >-
Specifies the width of all columns within the range. If the column widths are not uniform, `null` will be
returned.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'columnWidth?: boolean;'
return:
type: boolean
- name: fill
uid: 'excel!Excel.Interfaces.RangeFormatLoadOptions#fill:member'
package: excel!
fullName: fill
summary: Returns the fill object defined on the overall range.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'fill?: Excel.Interfaces.RangeFillLoadOptions;'
return:
type: '<xref uid="excel!Excel.Interfaces.RangeFillLoadOptions:interface" />'
- name: font
uid: 'excel!Excel.Interfaces.RangeFormatLoadOptions#font:member'
package: excel!
fullName: font
summary: Returns the font object defined on the overall range.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'font?: Excel.Interfaces.RangeFontLoadOptions;'
return:
type: '<xref uid="excel!Excel.Interfaces.RangeFontLoadOptions:interface" />'
- name: horizontalAlignment
uid: 'excel!Excel.Interfaces.RangeFormatLoadOptions#horizontalAlignment:member'
package: excel!
fullName: horizontalAlignment
summary: Represents the horizontal alignment for the specified object. See `Excel.HorizontalAlignment` for details.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'horizontalAlignment?: boolean;'
return:
type: boolean
- name: protection
uid: 'excel!Excel.Interfaces.RangeFormatLoadOptions#protection:member'
package: excel!
fullName: protection
summary: Returns the format protection object for a range.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'protection?: Excel.Interfaces.FormatProtectionLoadOptions;'
return:
type: '<xref uid="excel!Excel.Interfaces.FormatProtectionLoadOptions:interface" />'
- name: rowHeight
uid: 'excel!Excel.Interfaces.RangeFormatLoadOptions#rowHeight:member'
package: excel!
fullName: rowHeight
summary: 'The height of all rows in the range. If the row heights are not uniform, `null` will be returned.'
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'rowHeight?: boolean;'
return:
type: boolean
- name: verticalAlignment
uid: 'excel!Excel.Interfaces.RangeFormatLoadOptions#verticalAlignment:member'
package: excel!
fullName: verticalAlignment
summary: Represents the vertical alignment for the specified object. See `Excel.VerticalAlignment` for details.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'verticalAlignment?: boolean;'
return:
type: boolean
- name: wrapText
uid: 'excel!Excel.Interfaces.RangeFormatLoadOptions#wrapText:member'
package: excel!
fullName: wrapText
summary: >-
Specifies if Excel wraps the text in the object. A `null` value indicates that the entire range doesn't have a
uniform wrap setting
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'wrapText?: boolean;'
return:
type: boolean