Excel.LinkedWorkbookCollection class

Package:

excel

Represents a collection of linked workbook objects.

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.
items	Gets the loaded child items in this collection.
workbookLinksRefreshMode	Represents the update mode of the workbook links. The mode is same for all of the workbook links present in the workbook.

Methods

breakAllLinks()	Breaks all the links to the linked workbooks. Once the links are broken, any formulas referencing workbook links are removed entirely and replaced with the most recently retrieved values.
getItem(key)	Gets information about a linked workbook by its URL.
getItemOrNullObject(key)	Gets information about a linked workbook by its URL. If the workbook does not exist, then this method returns an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.
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.
refreshAll()	Makes a request to refresh all the workbook links.
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.LinkedWorkbookCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.LinkedWorkbookCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

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

items

Gets the loaded child items in this collection.

readonly items: Excel.LinkedWorkbook[];

Property Value

Excel.LinkedWorkbook[]

workbookLinksRefreshMode

Represents the update mode of the workbook links. The mode is same for all of the workbook links present in the workbook.

workbookLinksRefreshMode: Excel.WorkbookLinksRefreshMode | "Manual" | "Automatic";

Property Value

Excel.WorkbookLinksRefreshMode | "Manual" | "Automatic"

Remarks

[ API set: ExcelApiOnline 1.1 ]

Method Details

breakAllLinks()

Breaks all the links to the linked workbooks. Once the links are broken, any formulas referencing workbook links are removed entirely and replaced with the most recently retrieved values.

breakAllLinks(): void;

Returns

void

Remarks

[ API set: ExcelApiOnline 1.1 ]

getItem(key)

Gets information about a linked workbook by its URL.

getItem(key: string): Excel.LinkedWorkbook;

Parameters

key

string

The URL of the linked workbook.

Returns

Excel.LinkedWorkbook

The linked workbook with the given URL.

Remarks

[ API set: ExcelApiOnline 1.1 ]

getItemOrNullObject(key)

Gets information about a linked workbook by its URL. If the workbook does not exist, then this method returns an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.

getItemOrNullObject(key: string): Excel.LinkedWorkbook;

Parameters

key

string

The URL of the linked workbook.

Returns

Excel.LinkedWorkbook

The linked workbook with given URL.

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.LinkedWorkbookCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.LinkedWorkbookCollection;

Parameters

options

Excel.Interfaces.LinkedWorkbookCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.LinkedWorkbookCollection

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.LinkedWorkbookCollection;

Parameters

propertyNames

string | string[]

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

Returns

Excel.LinkedWorkbookCollection

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?: OfficeExtension.LoadOption): Excel.LinkedWorkbookCollection;

Parameters

propertyNamesAndPaths

OfficeExtension.LoadOption

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.LinkedWorkbookCollection

refreshAll()

Makes a request to refresh all the workbook links.

refreshAll(): 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.LinkedWorkbookCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.LinkedWorkbookCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

toJSON(): Excel.Interfaces.LinkedWorkbookCollectionData;

Returns

Excel.Interfaces.LinkedWorkbookCollectionData