-
Notifications
You must be signed in to change notification settings - Fork 63
/
excel.interfaces.worksheetcustompropertyloadoptions.yml
51 lines (51 loc) · 1.92 KB
/
excel.interfaces.worksheetcustompropertyloadoptions.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
### YamlMime:TSType
name: Excel.Interfaces.WorksheetCustomPropertyLoadOptions
uid: 'excel!Excel.Interfaces.WorksheetCustomPropertyLoadOptions:interface'
package: excel!
fullName: Excel.Interfaces.WorksheetCustomPropertyLoadOptions
summary: Represents a worksheet-level custom property.
remarks: '\[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: interface
properties:
- name: $all
uid: 'excel!Excel.Interfaces.WorksheetCustomPropertyLoadOptions#$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: key
uid: 'excel!Excel.Interfaces.WorksheetCustomPropertyLoadOptions#key:member'
package: excel!
fullName: key
summary: >-
Gets the key of the custom property. Custom property keys are case-insensitive. The key is limited to 255
characters (larger values will cause an `InvalidArgument` error to be thrown.)
remarks: '\[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'key?: boolean;'
return:
type: boolean
- name: value
uid: 'excel!Excel.Interfaces.WorksheetCustomPropertyLoadOptions#value:member'
package: excel!
fullName: value
summary: Gets or sets the value of the custom property.
remarks: '\[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'value?: boolean;'
return:
type: boolean