-
Notifications
You must be signed in to change notification settings - Fork 62
/
excel.interfaces.tablecollectionloadoptions.yml
148 lines (146 loc) · 6.15 KB
/
excel.interfaces.tablecollectionloadoptions.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
### YamlMime:TSType
name: Excel.Interfaces.TableCollectionLoadOptions
uid: 'excel!Excel.Interfaces.TableCollectionLoadOptions:interface'
package: excel!
fullName: Excel.Interfaces.TableCollectionLoadOptions
summary: 'Represents a collection of all the tables that are part of the workbook or worksheet, depending on how it was reached.'
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.TableCollectionLoadOptions#$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: columns
uid: 'excel!Excel.Interfaces.TableCollectionLoadOptions#columns:member'
package: excel!
fullName: columns
summary: 'For EACH ITEM in the collection: Represents a collection of all the columns in the table.'
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'columns?: Excel.Interfaces.TableColumnCollectionLoadOptions;'
return:
type: '<xref uid="excel!Excel.Interfaces.TableColumnCollectionLoadOptions:interface" />'
- name: id
uid: 'excel!Excel.Interfaces.TableCollectionLoadOptions#id:member'
package: excel!
fullName: id
summary: >-
For EACH ITEM in the collection: Returns a value that uniquely identifies the table in a given workbook. The value
of the identifier remains the same even when the table is renamed.
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.TableCollectionLoadOptions#name:member'
package: excel!
fullName: name
summary: >-
For EACH ITEM in the collection: Name of the table.
The set name of the table must follow the guidelines specified in the [Rename an Excel
table](https://support.microsoft.com/office/fbf49a4f-82a3-43eb-8ba2-44d21233b114) article.
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: rows
uid: 'excel!Excel.Interfaces.TableCollectionLoadOptions#rows:member'
package: excel!
fullName: rows
summary: 'For EACH ITEM in the collection: Represents a collection of all the rows in the table.'
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'rows?: Excel.Interfaces.TableRowCollectionLoadOptions;'
return:
type: '<xref uid="excel!Excel.Interfaces.TableRowCollectionLoadOptions:interface" />'
- name: showHeaders
uid: 'excel!Excel.Interfaces.TableCollectionLoadOptions#showHeaders:member'
package: excel!
fullName: showHeaders
summary: >-
For EACH ITEM in the collection: Specifies if the header row is visible. This value can be set to show or remove
the header row.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'showHeaders?: boolean;'
return:
type: boolean
- name: showTotals
uid: 'excel!Excel.Interfaces.TableCollectionLoadOptions#showTotals:member'
package: excel!
fullName: showTotals
summary: >-
For EACH ITEM in the collection: Specifies if the total row is visible. This value can be set to show or remove
the total row.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'showTotals?: boolean;'
return:
type: boolean
- name: sort
uid: 'excel!Excel.Interfaces.TableCollectionLoadOptions#sort:member'
package: excel!
fullName: sort
summary: 'For EACH ITEM in the collection: Represents the sorting for the table.'
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'sort?: Excel.Interfaces.TableSortLoadOptions;'
return:
type: '<xref uid="excel!Excel.Interfaces.TableSortLoadOptions:interface" />'
- name: style
uid: 'excel!Excel.Interfaces.TableCollectionLoadOptions#style:member'
package: excel!
fullName: style
summary: >-
For EACH ITEM in the collection: Constant value that represents the table style. Possible values are:
"TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28",
"TableStyleDark1" through "TableStyleDark11". A custom user-defined style present in the workbook can also be
specified.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'style?: boolean;'
return:
type: boolean
- name: worksheet
uid: 'excel!Excel.Interfaces.TableCollectionLoadOptions#worksheet:member'
package: excel!
fullName: worksheet
summary: 'For EACH ITEM in the collection: The worksheet containing the current table.'
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'worksheet?: Excel.Interfaces.WorksheetLoadOptions;'
return:
type: '<xref uid="excel!Excel.Interfaces.WorksheetLoadOptions:interface" />'