Excel.LinkedDataTypeCollection class

Package:

excel

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents a collection of linked data types.

Extends

OfficeExtension.ClientObject

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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.

Methods

getCount()	Gets the number of linked data types in the collection.
getItem(key)	Gets a linked data type by service ID.
getItemAt(index)	Gets a linked data type by its index in the collection.
getItemOrNullObject(key)	Gets a linked data type by ID. If the linked data type doesn't 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.
requestRefreshAll()	Makes a request to refresh all the linked data types in the collection. If the service is busy or otherwise temporarily inaccessible, the request will not be fulfilled.
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.LinkedDataTypeCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.LinkedDataTypeCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

Property Details

context

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the loaded child items in this collection.

readonly items: Excel.LinkedDataType[];

Property Value

Excel.LinkedDataType[]

Method Details

getCount()

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the number of linked data types in the collection.

getCount(): OfficeExtension.ClientResult<number>;

Returns

OfficeExtension.ClientResult<number>

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

getItem(key)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets a linked data type by service ID.

getItem(key: number): Excel.LinkedDataType;

Parameters

key

number

The ID of the linked data type.

Returns

Excel.LinkedDataType

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

getItemAt(index)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets a linked data type by its index in the collection.

getItemAt(index: number): Excel.LinkedDataType;

Parameters

index

number

The index of the linked data type object in the collection.

Returns

Excel.LinkedDataType

The linked data type at the given index.

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

getItemOrNullObject(key)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets a linked data type by ID. If the linked data type doesn't exist, then this method returns an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.

getItemOrNullObject(key: number): Excel.LinkedDataType;

Parameters

key

number

The service ID of the linked data type.

Returns

Excel.LinkedDataType

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

load(options)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

Parameters

options

Excel.Interfaces.LinkedDataTypeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.LinkedDataTypeCollection

load(propertyNames)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

Parameters

propertyNames

string | string[]

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

Returns

Excel.LinkedDataTypeCollection

load(propertyNamesAndPaths)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

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

requestRefreshAll()

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Makes a request to refresh all the linked data types in the collection. If the service is busy or otherwise temporarily inaccessible, the request will not be fulfilled.

requestRefreshAll(): void;

Returns

void

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

toJSON()

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

toJSON(): Excel.Interfaces.LinkedDataTypeCollectionData;

Returns

Excel.Interfaces.LinkedDataTypeCollectionData