Excel.LinkedWorkbook class
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
Remarks
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
| break |
Makes a request to break the links pointing to the linked workbook. Links in formulas are replaced with the latest fetched data. The current |
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| refresh() | Makes a request to refresh the data retrieved from the linked workbook. |
| toJSON() | Overrides the JavaScript |
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
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
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
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
Provides options for which properties of the object to load.
Returns
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
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
refresh()
Makes a request to refresh the data retrieved from the linked workbook.
refresh(): void;Returns
void
Remarks
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's 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;