Movatterモバイル変換


[0]ホーム

URL:


Skip to main contentSkip to in-page navigation

This browser is no longer supported.

Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support.

Download Microsoft EdgeMore info about Internet Explorer and Microsoft Edge
Table of contentsExit focus mode

Excel.LinkedEntityDataDomainCreateOptions interface

Package:
excel

Represents options that are used to create theLinkedEntityDataDomain object being added to theLinkedEntityDataDomainCollection.

Properties

dataProvider

Specifies the name of the data provider for the linked entity data domain.

id

Specifies the ID of the linked entity data domain. This ID must be unique across all linked entity data domains defined by this Office Add-in.

loadFunctionId

Specifies the ID of the custom function that will be called on demand to resolve or refresh theLinkedEntityCellValue objects of this linked entity data domain. For further information, seeAutogenerate JSON metadata for custom functions: ID.

name

Specifies the name of the linked entity data domain. This name must be unique across all linked entity data domains defined by this Office Add-in.

periodicRefreshInterval

Specifies the frequency, in seconds, at whichLinkedEntityCellValue objects of this linked entity data domain are refreshed automatically. The minimum valid value is 300. This property is required if thesupportedRefreshModes array contains the value "Periodic". This property only applies if therefreshMode of the linked entity data domain is set to "Periodic".

supportedRefreshModes

Specifies all the refresh modes supported by the linked entity data domain. The default value is["Manual"], which is always supported even if not specified. The refresh mode saved in the workbook is loaded as the default refresh mode of the linked entity data domain on the next workbook open. If the refresh mode was not saved in the workbook, the first value in the array is set as the default refresh mode of the linked entity data domain. If the array has the value "Periodic", theperiodicRefreshInterval property must also be set for the linked entity data domain.

Property Details

dataProvider

Specifies the name of the data provider for the linked entity data domain.

dataProvider: string;

Property Value

string

Remarks

[API set: ExcelApi 1.19 ]

id

Specifies the ID of the linked entity data domain. This ID must be unique across all linked entity data domains defined by this Office Add-in.

id: string;

Property Value

string

Remarks

[API set: ExcelApi 1.19 ]

loadFunctionId

Specifies the ID of the custom function that will be called on demand to resolve or refresh theLinkedEntityCellValue objects of this linked entity data domain. For further information, seeAutogenerate JSON metadata for custom functions: ID.

loadFunctionId: string;

Property Value

string

Remarks

[API set: ExcelApi 1.19 ]

name

Specifies the name of the linked entity data domain. This name must be unique across all linked entity data domains defined by this Office Add-in.

name: string;

Property Value

string

Remarks

[API set: ExcelApi 1.19 ]

periodicRefreshInterval

Specifies the frequency, in seconds, at whichLinkedEntityCellValue objects of this linked entity data domain are refreshed automatically. The minimum valid value is 300. This property is required if thesupportedRefreshModes array contains the value "Periodic". This property only applies if therefreshMode of the linked entity data domain is set to "Periodic".

periodicRefreshInterval?: number;

Property Value

number

Remarks

[API set: ExcelApi 1.19 ]

supportedRefreshModes

Specifies all the refresh modes supported by the linked entity data domain. The default value is["Manual"], which is always supported even if not specified. The refresh mode saved in the workbook is loaded as the default refresh mode of the linked entity data domain on the next workbook open. If the refresh mode was not saved in the workbook, the first value in the array is set as the default refresh mode of the linked entity data domain. If the array has the value "Periodic", theperiodicRefreshInterval property must also be set for the linked entity data domain.

supportedRefreshModes?: Excel.LinkedEntityDataDomainRefreshMode[];

Property Value

Remarks

[API set: ExcelApi 1.19 ]

Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, seeour contributor guide.

Feedback

Was this page helpful?

YesNo

In this article

Was this page helpful?

YesNo