Excel.LinkedWorkbook class

Package:

excel

Contains information about a linked workbook. If a workbook has links pointing to data in another workbook, the second workbook is linked to the first workbook. In this scenario, the second workbook is called the "linked workbook".

Extends

OfficeExtension.ClientObject

Remarks

[ API set: ExcelApiOnline 1.1 ]

Properties

context	The request context associated with the object. This connects the add-in's process to the Office host application's process.
id	The original URL pointing to the linked workbook. It is unique across all linked workbooks in the collection.

Methods

breakLinks()	Makes a request to break the links pointing to the linked workbook. Links in formulas are replaced with the latest fetched data. The current LinkedWorkbook object is invalidated and removed from LinkedWorkbookCollection.
load(options)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
refresh()	Makes a request to refresh the data retrieved from the linked workbook.
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.LinkedWorkbook object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.LinkedWorkbookData) 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

Excel.RequestContext

id

The original URL pointing to the linked workbook. It is unique across all linked workbooks in the collection.

readonly id: string;

Property Value

string

Remarks

[ API set: ExcelApiOnline 1.1 ]

Method Details

breakLinks()

Makes a request to break the links pointing to the linked workbook. Links in formulas are replaced with the latest fetched data. The current LinkedWorkbook object is invalidated and removed from LinkedWorkbookCollection.

breakLinks(): void;

Returns

void

Remarks

[ API set: ExcelApiOnline 1.1 ]

load(options)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(options?: Excel.Interfaces.LinkedWorkbookLoadOptions): Excel.LinkedWorkbook;

Parameters

options

Excel.Interfaces.LinkedWorkbookLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.LinkedWorkbook

load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): Excel.LinkedWorkbook;

Parameters

propertyNames

string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

Excel.LinkedWorkbook

load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.LinkedWorkbook;

Parameters

propertyNamesAndPaths

{ select?: string; expand?: string; }

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.

Returns

Excel.LinkedWorkbook

refresh()

Makes a request to refresh the data retrieved from the linked workbook.

refresh(): void;

Returns

void

Remarks

[ API set: ExcelApiOnline 1.1 ]

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.LinkedWorkbook object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.LinkedWorkbookData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.LinkedWorkbookData;

Returns

Excel.Interfaces.LinkedWorkbookData