Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

ExcelScript.WorkbookLinksRefreshMode enum

Package:
ExcelScript

Represents the refresh mode of the workbook links.

Remarks

Used by

Examples

/**
 * This script refreshes all the links to external workbooks, 
 * if the linked workbook refresh mode is set to manual.
 * To learn about linked workbooks, see https://support.microsoft.com/office/c98d1803-dd75-4668-ac6a-d7cca2a9b95f.
 */
function main(workbook: ExcelScript.Workbook) {
 // Check the refresh mode.
 if (workbook.getLinkedWorkbookRefreshMode() === ExcelScript.WorkbookLinksRefreshMode.manual) {
 console.log("Refreshing workbook links");

 // Trigger a refresh of linked workbook content.
 workbook.refreshAllLinksToLinkedWorkbooks();
 }
}

Fields

automatic

The workbook links are updated at a set interval determined by the Excel application.
manual

The workbook links are updated manually.

Feedback

Was this page helpful?