-
Notifications
You must be signed in to change notification settings - Fork 63
/
excel.binding.yml
301 lines (276 loc) · 10.6 KB
/
excel.binding.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
### YamlMime:TSType
name: Excel.Binding
uid: 'excel!Excel.Binding:class'
package: excel!
fullName: Excel.Binding
summary: Represents an Office.js binding that is defined in the workbook.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: class
properties:
- name: context
uid: 'excel!Excel.Binding#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: id
uid: 'excel!Excel.Binding#id:member'
package: excel!
fullName: id
summary: Represents the binding identifier.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly id: string;'
return:
type: string
- name: type
uid: 'excel!Excel.Binding#type:member'
package: excel!
fullName: type
summary: Returns the type of the binding. See `Excel.BindingType` for details.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly type: Excel.BindingType | "Range" | "Table" | "Text";'
return:
type: '<xref uid="excel!Excel.BindingType:enum" /> | "Range" | "Table" | "Text"'
methods:
- name: delete()
uid: 'excel!Excel.Binding#delete:member(1)'
package: excel!
fullName: delete()
summary: Deletes the binding.
remarks: '\[ [API set: ExcelApi 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'delete(): void;'
return:
type: void
description: ''
- name: getRange()
uid: 'excel!Excel.Binding#getRange:member(1)'
package: excel!
fullName: getRange()
summary: Returns the range represented by the binding. Will throw an error if the binding is not of the correct type.
remarks: |-
\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
await Excel.run(async (context) => {
const binding = context.workbook.bindings.getItemAt(0);
const range = binding.getRange();
range.load('cellCount');
await context.sync();
console.log(range.cellCount);
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'getRange(): Excel.Range;'
return:
type: '<xref uid="excel!Excel.Range:class" />'
description: ''
- name: getTable()
uid: 'excel!Excel.Binding#getTable:member(1)'
package: excel!
fullName: getTable()
summary: Returns the table represented by the binding. Will throw an error if the binding is not of the correct type.
remarks: |-
\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
await Excel.run(async (context) => {
const binding = context.workbook.bindings.getItemAt(0);
const table = binding.getTable();
table.load('name');
await context.sync();
console.log(table.name);
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'getTable(): Excel.Table;'
return:
type: '<xref uid="excel!Excel.Table:class" />'
description: ''
- name: getText()
uid: 'excel!Excel.Binding#getText:member(1)'
package: excel!
fullName: getText()
summary: Returns the text represented by the binding. Will throw an error if the binding is not of the correct type.
remarks: |-
\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
await Excel.run(async (context) => {
const binding = context.workbook.bindings.getItemAt(0);
const text = binding.getText();
binding.load('text');
await context.sync();
console.log(text);
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'getText(): OfficeExtension.ClientResult<string>;'
return:
type: '<xref uid="office!OfficeExtension.ClientResult:class" /><string>'
description: ''
- name: load(options)
uid: 'excel!Excel.Binding#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.BindingLoadOptions): Excel.Binding;'
parameters:
- id: options
description: Provides options for which properties of the object to load.
type: '<xref uid="excel!Excel.Interfaces.BindingLoadOptions:interface" />'
return:
type: '<xref uid="excel!Excel.Binding:class" />'
description: ''
- name: load(propertyNames)
uid: 'excel!Excel.Binding#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.Binding;'
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.Binding:class" />'
description: |-
#### Examples
```TypeScript
await Excel.run(async (context) => {
const binding = context.workbook.bindings.getItemAt(0);
binding.load('type');
await context.sync();
console.log(binding.type);
});
```
- name: load(propertyNamesAndPaths)
uid: 'excel!Excel.Binding#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.Binding;
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.Binding:class" />'
description: ''
- name: toJSON()
uid: 'excel!Excel.Binding#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.Binding object is an API object, the `toJSON` method returns a plain
JavaScript object (typed as `Excel.Interfaces.BindingData`<!-- -->) that contains shallow copies of any loaded
child properties from the original object.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'toJSON(): Excel.Interfaces.BindingData;'
return:
type: '<xref uid="excel!Excel.Interfaces.BindingData:interface" />'
description: ''
events:
- name: onDataChanged
uid: 'excel!Excel.Binding#onDataChanged:member'
package: excel!
fullName: onDataChanged
summary: Occurs when data or formatting within the binding is changed.
remarks: >-
\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/data-changed.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const salesTable = sheet.tables.getItem("SalesTable");
const salesByQuarterBinding = context.workbook.bindings.add(salesTable.getRange(), "Table", "SalesByQuarter");
salesByQuarterBinding.onDataChanged.add(onSalesDataChanged);
console.log("The data changed handler is registered.");
await context.sync();
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'readonly onDataChanged: OfficeExtension.EventHandlers<Excel.BindingDataChangedEventArgs>;'
return:
type: >-
<xref uid="office!OfficeExtension.EventHandlers:class" /><<xref
uid="excel!Excel.BindingDataChangedEventArgs:interface" />>
- name: onSelectionChanged
uid: 'excel!Excel.Binding#onSelectionChanged:member'
package: excel!
fullName: onSelectionChanged
summary: >-
Occurs when the selected content in the binding is changed.
*Note**: If multiple, discontiguous cells are selected, `Binding.onSelectionChanged` only reports row and
column information for one selection. Use `Worksheet.onSelectionChanged` for multiple selected ranges.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.BindingSelectionChangedEventArgs>;'
return:
type: >-
<xref uid="office!OfficeExtension.EventHandlers:class" /><<xref
uid="excel!Excel.BindingSelectionChangedEventArgs:interface" />>
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'