-
Notifications
You must be signed in to change notification settings - Fork 62
/
excel.interfaces.worksheetloadoptions.yml
116 lines (116 loc) · 4.6 KB
/
excel.interfaces.worksheetloadoptions.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
### YamlMime:TSType
name: Excel.Interfaces.WorksheetLoadOptions
uid: 'excel!Excel.Interfaces.WorksheetLoadOptions:interface'
package: excel!
fullName: Excel.Interfaces.WorksheetLoadOptions
summary: >-
An Excel worksheet is a grid of cells. It can contain data, tables, charts, etc. To learn more about the worksheet
object model, read [Work with worksheets using the Excel JavaScript
API](https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-worksheets)<!-- -->.
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.WorksheetLoadOptions#$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: charts
uid: 'excel!Excel.Interfaces.WorksheetLoadOptions#charts:member'
package: excel!
fullName: charts
summary: Returns a collection of charts that are part of the worksheet.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'charts?: Excel.Interfaces.ChartCollectionLoadOptions;'
return:
type: '<xref uid="excel!Excel.Interfaces.ChartCollectionLoadOptions:interface" />'
- name: id
uid: 'excel!Excel.Interfaces.WorksheetLoadOptions#id:member'
package: excel!
fullName: id
summary: >-
Returns a value that uniquely identifies the worksheet in a given workbook. The value of the identifier remains
the same even when the worksheet is renamed or moved.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'id?: boolean;'
return:
type: boolean
- name: name
uid: 'excel!Excel.Interfaces.WorksheetLoadOptions#name:member'
package: excel!
fullName: name
summary: The display name of the worksheet. The name must be fewer than 32 characters.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'name?: boolean;'
return:
type: boolean
- name: position
uid: 'excel!Excel.Interfaces.WorksheetLoadOptions#position:member'
package: excel!
fullName: position
summary: The zero-based position of the worksheet within the workbook.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'position?: boolean;'
return:
type: boolean
- name: protection
uid: 'excel!Excel.Interfaces.WorksheetLoadOptions#protection:member'
package: excel!
fullName: protection
summary: Returns the sheet protection object for a worksheet.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'protection?: Excel.Interfaces.WorksheetProtectionLoadOptions;'
return:
type: '<xref uid="excel!Excel.Interfaces.WorksheetProtectionLoadOptions:interface" />'
- name: tables
uid: 'excel!Excel.Interfaces.WorksheetLoadOptions#tables:member'
package: excel!
fullName: tables
summary: Collection of tables that are part of the worksheet.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'tables?: Excel.Interfaces.TableCollectionLoadOptions;'
return:
type: '<xref uid="excel!Excel.Interfaces.TableCollectionLoadOptions:interface" />'
- name: visibility
uid: 'excel!Excel.Interfaces.WorksheetLoadOptions#visibility:member'
package: excel!
fullName: visibility
summary: The visibility of the worksheet.
remarks: >-
\[ [API set: ExcelApi 1.1 for reading visibility; 1.2 for setting
it.](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
isPreview: false
isDeprecated: false
syntax:
content: 'visibility?: boolean;'
return:
type: boolean