Excel.DataConnectionCollection class

Represents a collection of all the Data Connections that are part of the workbook or worksheet.

[ API set: ExcelApi 1.7 ]

Extends
OfficeExtension.ClientObject

Properties

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

Methods

refreshAll()

Refreshes all the Data Connections in the collection.

[ API set: ExcelApi 1.7 ]

toJSON()

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.

Property Details

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

Method Details

refreshAll()

Refreshes all the Data Connections in the collection.

[ API set: ExcelApi 1.7 ]

refreshAll(): void;

Returns

void

toJSON()

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.

toJSON(): {
            [key: string]: string;
        };

Returns

{ [key: string]: string; }