-
Notifications
You must be signed in to change notification settings - Fork 66
/
excel.dataconnectioncollection.yml
68 lines (68 loc) · 2.71 KB
/
excel.dataconnectioncollection.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
### YamlMime:TSType
name: Excel.DataConnectionCollection
uid: 'excel!Excel.DataConnectionCollection:class'
package: excel!
fullName: Excel.DataConnectionCollection
summary: Represents a collection of all the data connections that are part of the workbook.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: class
properties:
- name: context
uid: 'excel!Excel.DataConnectionCollection#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" />'
methods:
- name: refreshAll()
uid: 'excel!Excel.DataConnectionCollection#refreshAll:member(1)'
package: excel!
fullName: refreshAll()
summary: >-
Refreshes data connections in the collection, such as from a PivotTable to a Power BI dataset, or a Data Model to
a table or range in the same workbook. Data connections unsupported by this method are: Power Query connections,
data connections outside the original workbook (except Power BI connections), and connections to data protected by
a firewall.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'refreshAll(): void;'
return:
type: void
description: ''
- name: toJSON()
uid: 'excel!Excel.DataConnectionCollection#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.DataConnectionCollection` object is an API object, the `toJSON` method
returns a plain JavaScript object (typed as `Excel.Interfaces.DataConnectionCollectionData`<!-- -->) that contains
shallow copies of any loaded child properties from the original object.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: |-
toJSON(): {
[key: string]: string;
};
return:
type: |-
{
[key: string]: string;
}
description: ''
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'