From 8fb3e852c26eb25d82d596c94b678bf5a5bc5ed1 Mon Sep 17 00:00:00 2001 From: Alex Jerabek <38896772+AlexJerabek@users.noreply.github.com> Date: Tue, 24 Sep 2019 14:54:09 -0700 Subject: [PATCH] [office-js, office-js-preview] Updating with latest definitions from the CDN (#38491) * Excel * Word * Extra newlines * Autofill * Autofill * Autofill --- types/office-js-preview/index.d.ts | 6707 +++++++++++++++------------- types/office-js/index.d.ts | 5576 ++++++++++++----------- 2 files changed, 6699 insertions(+), 5584 deletions(-) diff --git a/types/office-js-preview/index.d.ts b/types/office-js-preview/index.d.ts index 79460590ab..143ba3c951 100644 --- a/types/office-js-preview/index.d.ts +++ b/types/office-js-preview/index.d.ts @@ -18892,7 +18892,7 @@ declare namespace Excel { } /** * - * Provides information about the worksheet row hidden change event. + * Provides information about the worksheet's row hidden change event. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -18908,7 +18908,7 @@ declare namespace Excel { address: string; /** * - * Gets the change type that represents how the RowHiddenChanged event is triggered. See Excel.RowHiddenChangeType for details. + * Gets the type of change that represents how the event was triggered. See `Excel.RowHiddenChangeType` for details. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -19020,7 +19020,7 @@ declare namespace Excel { interface TableFilteredEventArgs { /** * - * Represents the id of the table in which the filter is applied.. + * Represents the id of the table in which the filter is applied. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -19114,7 +19114,7 @@ declare namespace Excel { } /** * - * Provides information about the worksheet that raised the RowSorted event. + * Provides information about the row-sorted event and its related worksheet. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -19122,7 +19122,7 @@ declare namespace Excel { interface WorksheetRowSortedEventArgs { /** * - * Gets the range address that represents the sorted areas of a specific worksheet. + * Gets the range address that represents the sorted areas of a specific worksheet. Only rows changed as a result of the sort operation are returned. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -19155,7 +19155,7 @@ declare namespace Excel { } /** * - * Provides information about the worksheet that raised the ColumnSorted event. + * Provides information about the column-sorted event and its related worksheet. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -19163,7 +19163,7 @@ declare namespace Excel { interface WorksheetColumnSortedEventArgs { /** * - * Gets the range address that represents the sorted areas of a specific worksheet. + * Gets the range address that represents the sorted areas of a specific worksheet. Only columns changed as a result of the sort operation are returned. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -19225,7 +19225,7 @@ declare namespace Excel { } /** * - * Provides information about the worksheet that raised the left-clicked/tapped event. + * Provides information about the left-clicked/tapped event and its related worksheet. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -19670,7 +19670,7 @@ declare namespace Excel { */ class Runtime extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Toggle JavaScript events in the current task pane or content add-in. @@ -19693,23 +19693,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.Runtime): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.Runtime` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.Runtime` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Runtime` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.RuntimeLoadOptions): Excel.Runtime; - load(option?: string | string[]): Excel.Runtime; - load(option?: { + load(options?: Excel.Interfaces.RuntimeLoadOptions): Excel.Runtime; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Runtime; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.Runtime; @@ -19727,7 +19727,7 @@ declare namespace Excel { */ class Application extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns the Iterative Calculation settings. @@ -19805,23 +19805,23 @@ declare namespace Excel { */ suspendScreenUpdatingUntilNextSync(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.Application` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.Application` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Application` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ApplicationLoadOptions): Excel.Application; - load(option?: string | string[]): Excel.Application; - load(option?: { + load(options?: Excel.Interfaces.ApplicationLoadOptions): Excel.Application; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Application; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.Application; @@ -19839,7 +19839,7 @@ declare namespace Excel { */ class IterativeCalculation extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * True if Excel will use iteration to resolve circular references. @@ -19876,23 +19876,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.IterativeCalculation): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.IterativeCalculation` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.IterativeCalculation` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.IterativeCalculation` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.IterativeCalculationLoadOptions): Excel.IterativeCalculation; - load(option?: string | string[]): Excel.IterativeCalculation; - load(option?: { + load(options?: Excel.Interfaces.IterativeCalculationLoadOptions): Excel.IterativeCalculation; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.IterativeCalculation; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.IterativeCalculation; @@ -19905,13 +19905,13 @@ declare namespace Excel { /** * * Workbook is the top level object which contains related workbook objects such as worksheets, tables, ranges, etc. - * To learn more about the workbook object model, read {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-workbooks | Work with workbooks using the Excel JavaScript API}. + To learn more about the workbook object model, read {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-workbooks | Work with workbooks using the Excel JavaScript API}. * * [Api set: ExcelApi 1.1] */ class Workbook extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the Excel application instance that contains this workbook. Read-only. @@ -20230,23 +20230,23 @@ declare namespace Excel { */ save(saveBehavior?: "Save" | "Prompt"): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.Workbook` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.Workbook` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Workbook` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.WorkbookLoadOptions): Excel.Workbook; - load(option?: string | string[]): Excel.Workbook; - load(option?: { + load(options?: Excel.Interfaces.WorkbookLoadOptions): Excel.Workbook; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Workbook; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.Workbook; @@ -20291,7 +20291,7 @@ declare namespace Excel { */ class WorkbookProtection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Indicates if the workbook is protected. Read-Only. @@ -20318,23 +20318,23 @@ declare namespace Excel { */ unprotect(password?: string): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.WorkbookProtection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.WorkbookProtection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.WorkbookProtection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.WorkbookProtectionLoadOptions): Excel.WorkbookProtection; - load(option?: string | string[]): Excel.WorkbookProtection; - load(option?: { + load(options?: Excel.Interfaces.WorkbookProtectionLoadOptions): Excel.WorkbookProtection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.WorkbookProtection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.WorkbookProtection; @@ -20352,24 +20352,19 @@ declare namespace Excel { */ class WorkbookCreated extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.WorkbookCreated` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.WorkbookCreated` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.WorkbookCreated` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. - * - * @param options Provides options for which properties of the object to load. + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(option?: string | string[]): Excel.WorkbookCreated; - load(option?: { + load(propertyNames?: string | string[]): Excel.WorkbookCreated; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.WorkbookCreated; @@ -20382,13 +20377,13 @@ declare namespace Excel { /** * * An Excel worksheet is a grid of cells. It can contain data, tables, charts, etc. - * To learn more about the worksheet object model, read {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-worksheets | Work with worksheets using the Excel JavaScript API}. + To learn more about the worksheet object model, read {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-worksheets | Work with worksheets using the Excel JavaScript API}. * * [Api set: ExcelApi 1.1] */ class Worksheet extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the AutoFilter object of the worksheet. Read-Only. @@ -20759,23 +20754,23 @@ declare namespace Excel { */ showOutlineLevels(rowLevels: number, columnLevels: number): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.Worksheet` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.Worksheet` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Worksheet` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.WorksheetLoadOptions): Excel.Worksheet; - load(option?: string | string[]): Excel.Worksheet; - load(option?: { + load(options?: Excel.Interfaces.WorksheetLoadOptions): Excel.Worksheet; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Worksheet; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.Worksheet; @@ -20808,7 +20803,7 @@ declare namespace Excel { readonly onChanged: OfficeExtension.EventHandlers; /** * - * Occurs when sorting on columns. + * Occurs when one or more columns have been sorted. This happens as the result of a left-to-right sort operation. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @@ -20846,7 +20841,7 @@ declare namespace Excel { readonly onFormatChanged: OfficeExtension.EventHandlers; /** * - * Occurs when row hidden state changed on a specific worksheet. + * Occurs when the hidden state of one or more rows has changed on a specific worksheet. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @@ -20856,7 +20851,7 @@ declare namespace Excel { readonly onRowHiddenChanged: OfficeExtension.EventHandlers; /** * - * Occurs when sorting on rows. + * Occurs when one or more rows have been sorted. This happens as the result of a top-to-bottom sort operation. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @@ -20877,9 +20872,9 @@ declare namespace Excel { * * Occurs when left-clicked/tapped operation happens in the worksheet. This event will not be fired when clicking in the following cases: * - * - The user drags the mouse for multi-selection. - * - * - The user selects a cell in the mode when cell arguments are selected for formula references. + - The user drags the mouse for multi-selection. + + - The user selects a cell in the mode when cell arguments are selected for formula references. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @@ -20901,7 +20896,7 @@ declare namespace Excel { */ class WorksheetCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.Worksheet[]; /** @@ -20993,23 +20988,23 @@ declare namespace Excel { */ getLast(visibleOnly?: boolean): Excel.Worksheet; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.WorksheetCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.WorksheetCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.WorksheetCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.WorksheetCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.WorksheetCollection; - load(option?: string | string[]): Excel.WorksheetCollection; - load(option?: OfficeExtension.LoadOption): Excel.WorksheetCollection; + load(options?: Excel.Interfaces.WorksheetCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.WorksheetCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.WorksheetCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.WorksheetCollection; /** * * Occurs when any worksheet in the workbook is activated. @@ -21048,7 +21043,7 @@ declare namespace Excel { readonly onChanged: OfficeExtension.EventHandlers; /** * - * Occurs when sorting on columns. + * Occurs when one or more columns have been sorted. This happens as the result of a left-to-right sort operation. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @@ -21095,7 +21090,7 @@ declare namespace Excel { readonly onFormatChanged: OfficeExtension.EventHandlers; /** * - * Occurs when any worksheet in the workbook has row hidden state changed. + * Occurs when the hidden state of one or more rows has changed on a specific worksheet. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @@ -21105,7 +21100,7 @@ declare namespace Excel { readonly onRowHiddenChanged: OfficeExtension.EventHandlers; /** * - * Occurs when sorting on rows. + * Occurs when one or more rows have been sorted. This happens as the result of a top-to-bottom sort operation. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @@ -21126,9 +21121,9 @@ declare namespace Excel { * * Occurs when left-clicked/tapped operation happens in the worksheet collection. This event will not be fired when clicking in the following cases: * - * - The user drags the mouse for multi-selection. - * - * - The user selects a cell in the mode when cell arguments are selected for formula references. + - The user drags the mouse for multi-selection. + + - The user selects a cell in the mode when cell arguments are selected for formula references. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @@ -21150,7 +21145,7 @@ declare namespace Excel { */ class WorksheetProtection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Sheet protection options. Read-only. @@ -21185,23 +21180,23 @@ declare namespace Excel { */ unprotect(password?: string): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.WorksheetProtection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.WorksheetProtection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.WorksheetProtection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.WorksheetProtectionLoadOptions): Excel.WorksheetProtection; - load(option?: string | string[]): Excel.WorksheetProtection; - load(option?: { + load(options?: Excel.Interfaces.WorksheetProtectionLoadOptions): Excel.WorksheetProtection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.WorksheetProtection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.WorksheetProtection; @@ -21322,7 +21317,7 @@ declare namespace Excel { */ class WorksheetFreezePanes extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Sets the frozen cells in the active worksheet view. @@ -21386,13 +21381,14 @@ declare namespace Excel { /** * * Range represents a set of one or more contiguous cells such as a cell, a row, a column, block of cells, etc. - * To learn more about how ranges are used throughout the API, read {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-ranges | Work with ranges using the Excel JavaScript API} and {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-ranges-advanced | Work with ranges using the Excel JavaScript API (advanced)}. + To learn more about how ranges are used throughout the API, read {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-ranges | Work with ranges using the Excel JavaScript API} + and {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-ranges-advanced | Work with ranges using the Excel JavaScript API (advanced)}. * * [Api set: ExcelApi 1.1] */ class Range extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Collection of ConditionalFormats that intersect the range. Read-only. @@ -21565,9 +21561,11 @@ declare namespace Excel { numberFormat: any[][]; /** * - * Represents Excel's number format code for the given range, based on the language settings of the user. - When setting number format local to a range, the value argument can be either a single value (string) or a two-dimensional array. If the argument is a single value, it will be applied to all cells in the range. - Excel does not perform any language or format coercion when getting or setting the `numberFormatLocal` property. Any returned text uses the locally-formatted strings based on the language specified in the system settings. + * Represents Excel's number format code for the given range, based on the language settings of the user.​ + When setting number format local to a range, the value argument can be either a single value (string) or a two-dimensional array. + If the argument is a single value, it will be applied to all cells in the range.​ + Excel does not perform any language or format coercion when getting or setting the `numberFormatLocal` property. + Any returned text uses the locally-formatted strings based on the language specified in the system settings. * * [Api set: ExcelApi 1.7] */ @@ -21596,8 +21594,8 @@ declare namespace Excel { /** * * Represents if ALL the cells would be saved as an array formula. - Returns true if ALL cells would be saved as an array, or false if ALL cells would NOT be saved as an array formula. - Returns null if there is a mixture of cells that would and would not be saved as an array formula. + Returns true if ALL cells would be saved as an array formula, or false if ALL cells would NOT be saved as an array formula. + Returns null if some cells would be saved as an array formula and some would not be. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -21666,30 +21664,28 @@ declare namespace Excel { set(properties: Excel.Range): void; /** * - * Fills range from the current range to the destination range using the specified AutoFill logic. - * The destination range can be null, or can extend the source either horizontally or vertically. - * If the destination range is null, data is filled out based on the surrounding cells (which is the behavior when double-clicking the UI’s range fill handle). - * - * For more information, read {@link https://support.office.com/article/video-use-autofill-and-flash-fill-2e79a709-c814-4b27-8bc2-c4dc84d49464 | Use AutoFill and Flash Fill}. + * Fills range from the current range to the destination range using the specified AutoFill logic. +The destination range can be null, or can extend the source either horizontally or vertically. +Discontiguous ranges are not supported. +For more information, read {@link https://support.office.com/article/video-use-autofill-and-flash-fill-2e79a709-c814-4b27-8bc2-c4dc84d49464 | Use AutoFill and Flash Fill}. * * [Api set: ExcelApi 1.9, ExcelApi BETA (PREVIEW ONLY) for null `destinationRange`] * - * @param destinationRange The destination range to fill. Discontiguous ranges are not supported. - * @param autoFillType The type of AutoFill. Specifies how the destination range is to be filled, based on the contents of the current range. Default is "FillDefault". + * @param destinationRange The destination range to autofill. If the destination range is null, data is filled out based on the surrounding cells (which is the behavior when double-clicking the UI’s range fill handle). + * @param autoFillType The type of autofill. Specifies how the destination range is to be filled, based on the contents of the current range. Default is "FillDefault". */ autoFill(destinationRange: Range | string, autoFillType?: Excel.AutoFillType): void; /** * - * Fills range from the current range to the destination range using the specified AutoFill logic. - * The destination range can be null, or can extend the source either horizontally or vertically. - * If the destination range is null, data is filled out based on the surrounding cells (which is the behavior when double-clicking the UI’s range fill handle). - * - * For more information, read {@link https://support.office.com/article/video-use-autofill-and-flash-fill-2e79a709-c814-4b27-8bc2-c4dc84d49464 | Use AutoFill and Flash Fill}. + * Fills range from the current range to the destination range using the specified AutoFill logic. +The destination range can be null, or can extend the source either horizontally or vertically. +Discontiguous ranges are not supported. +For more information, read {@link https://support.office.com/article/video-use-autofill-and-flash-fill-2e79a709-c814-4b27-8bc2-c4dc84d49464 | Use AutoFill and Flash Fill}. * * [Api set: ExcelApi 1.9, ExcelApi BETA (PREVIEW ONLY) for null `destinationRange`] * - * @param destinationRange The destination range to fill. Discontiguous ranges are not supported. - * @param autoFillType The type of AutoFill. Specifies how the destination range is to be filled, based on the contents of the current range. Default is "FillDefault". + * @param destinationRange The destination range to autofill. If the destination range is null, data is filled out based on the surrounding cells (which is the behavior when double-clicking the UI’s range fill handle). + * @param autoFillType The type of autofill. Specifies how the destination range is to be filled, based on the contents of the current range. Default is "FillDefault". */ autoFill(destinationRange: Range | string, autoFillType?: "FillDefault" | "FillCopy" | "FillSeries" | "FillFormats" | "FillValues" | "FillDays" | "FillWeekdays" | "FillMonths" | "FillYears" | "LinearTrend" | "GrowthTrend" | "FlashFill"): void; /** @@ -21737,11 +21733,11 @@ declare namespace Excel { /** * * Copies cell data or formatting from the source range or RangeAreas to the current range. - The destination range can be of different size than the source range or RangeAreas. The destination will be expanded automatically if it is smaller than the source. + The destination range can be a different size than the source range or RangeAreas. The destination will be expanded automatically if it is smaller than the source. * * [Api set: ExcelApi 1.9] * - * @param sourceRange The source range or RangeAreas to copy from. When the source RangeAreas has multiple ranges, it must in the outline form which can be created by removing full rows or columns from a rectangular range. + * @param sourceRange The source range or RangeAreas to copy from. When the source RangeAreas has multiple ranges, their form must be able to be created by removing full rows or columns from a rectangular range. * @param copyType The type of cell data or formatting to copy over. Default is "All". * @param skipBlanks True if to skip blank cells in the source range. Default is false. * @param transpose True if to transpose the cells in the destination range. Default is false. @@ -21750,11 +21746,11 @@ declare namespace Excel { /** * * Copies cell data or formatting from the source range or RangeAreas to the current range. - The destination range can be of different size than the source range or RangeAreas. The destination will be expanded automatically if it is smaller than the source. + The destination range can be a different size than the source range or RangeAreas. The destination will be expanded automatically if it is smaller than the source. * * [Api set: ExcelApi 1.9] * - * @param sourceRange The source range or RangeAreas to copy from. When the source RangeAreas has multiple ranges, it must in the outline form which can be created by removing full rows or columns from a rectangular range. + * @param sourceRange The source range or RangeAreas to copy from. When the source RangeAreas has multiple ranges, their form must be able to be created by removing full rows or columns from a rectangular range. * @param copyType The type of cell data or formatting to copy over. Default is "All". * @param skipBlanks True if to skip blank cells in the source range. Default is false. * @param transpose True if to transpose the cells in the destination range. Default is false. @@ -21787,7 +21783,7 @@ declare namespace Excel { * * @param text The string to find. * @param criteria Additional search criteria, including the search direction and whether the search needs to match the entire cell or be case sensitive. - * @returns The Range which matched the search criteria. + * @returns The Range object representing the first cell that contains a value matching the search text and criteria. */ find(text: string, criteria: Excel.SearchCriteria): Excel.Range; /** @@ -22310,32 +22306,32 @@ declare namespace Excel { */ unmerge(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.Range` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.Range` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Range` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.RangeLoadOptions): Excel.Range; - load(option?: string | string[]): Excel.Range; - load(option?: { + load(options?: Excel.Interfaces.RangeLoadOptions): Excel.Range; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Range; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.Range; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created. + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created. */ track(): Excel.Range; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `context.trackedObjects.remove(thisObject)`. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect. */ untrack(): Excel.Range; /** @@ -22398,13 +22394,13 @@ declare namespace Excel { /** * * RangeAreas represents a collection of one or more rectangular ranges in the same worksheet. - * To learn how to use discontinguous ranges, read {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-multiple-ranges | Work with multiple ranges simultaneously in Excel add-ins}. + To learn how to use discontinguous ranges, read {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-multiple-ranges | Work with multiple ranges simultaneously in Excel add-ins}. * * [Api set: ExcelApi 1.9] */ class RangeAreas extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns a collection of rectangular ranges that comprise this RangeAreas object. @@ -22550,11 +22546,11 @@ declare namespace Excel { /** * * Copies cell data or formatting from the source range or RangeAreas to the current RangeAreas. - The destination rangeAreas can be of different size than the source range or RangeAreas. The destination will be expanded automatically if it is smaller than the source. + The destination rangeAreas can be a different size than the source range or RangeAreas. The destination will be expanded automatically if it is smaller than the source. * * [Api set: ExcelApi 1.9] * - * @param sourceRange The source range or RangeAreas to copy from. When the source RangeAreas has multiple ranges, it must be in the outline form which can be created by removing full rows or columns from a rectangular range. + * @param sourceRange The source range or RangeAreas to copy from. When the source RangeAreas has multiple ranges, their form must able to be created by removing full rows or columns from a rectangular range. * @param copyType The type of cell data or formatting to copy over. Default is "All". * @param skipBlanks True if to skip blank cells in the source range or RangeAreas. Default is false. * @param transpose True if to transpose the cells in the destination RangeAreas. Default is false. @@ -22563,11 +22559,11 @@ declare namespace Excel { /** * * Copies cell data or formatting from the source range or RangeAreas to the current RangeAreas. - The destination rangeAreas can be of different size than the source range or RangeAreas. The destination will be expanded automatically if it is smaller than the source. + The destination rangeAreas can be a different size than the source range or RangeAreas. The destination will be expanded automatically if it is smaller than the source. * * [Api set: ExcelApi 1.9] * - * @param sourceRange The source range or RangeAreas to copy from. When the source RangeAreas has multiple ranges, it must be in the outline form which can be created by removing full rows or columns from a rectangular range. + * @param sourceRange The source range or RangeAreas to copy from. When the source RangeAreas has multiple ranges, their form must able to be created by removing full rows or columns from a rectangular range. * @param copyType The type of cell data or formatting to copy over. Default is "All". * @param skipBlanks True if to skip blank cells in the source range or RangeAreas. Default is false. * @param transpose True if to transpose the cells in the destination RangeAreas. Default is false. @@ -22692,32 +22688,32 @@ declare namespace Excel { */ setDirty(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.RangeAreas` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.RangeAreas` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.RangeAreas` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.RangeAreasLoadOptions): Excel.RangeAreas; - load(option?: string | string[]): Excel.RangeAreas; - load(option?: { + load(options?: Excel.Interfaces.RangeAreasLoadOptions): Excel.RangeAreas; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.RangeAreas; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.RangeAreas; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created. + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created. */ track(): Excel.RangeAreas; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `context.trackedObjects.remove(thisObject)`. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect. */ untrack(): Excel.RangeAreas; /** @@ -23207,7 +23203,7 @@ declare namespace Excel { */ class RangeView extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents a collection of range views associated with the range. Read-only. @@ -23314,23 +23310,23 @@ declare namespace Excel { */ getRange(): Excel.Range; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.RangeView` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.RangeView` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.RangeView` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.RangeViewLoadOptions): Excel.RangeView; - load(option?: string | string[]): Excel.RangeView; - load(option?: { + load(options?: Excel.Interfaces.RangeViewLoadOptions): Excel.RangeView; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.RangeView; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.RangeView; @@ -23348,7 +23344,7 @@ declare namespace Excel { */ class RangeViewCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.RangeView[]; /** @@ -23368,23 +23364,23 @@ declare namespace Excel { */ getItemAt(index: number): Excel.RangeView; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.RangeViewCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.RangeViewCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.RangeViewCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.RangeViewCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.RangeViewCollection; - load(option?: string | string[]): Excel.RangeViewCollection; - load(option?: OfficeExtension.LoadOption): Excel.RangeViewCollection; + load(options?: Excel.Interfaces.RangeViewCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.RangeViewCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.RangeViewCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.RangeViewCollection; /** * 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.RangeViewCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.RangeViewCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -23399,7 +23395,7 @@ declare namespace Excel { */ class SettingCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.Setting[]; /** @@ -23438,23 +23434,23 @@ declare namespace Excel { */ getItemOrNullObject(key: string): Excel.Setting; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.SettingCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.SettingCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.SettingCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.SettingCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SettingCollection; - load(option?: string | string[]): Excel.SettingCollection; - load(option?: OfficeExtension.LoadOption): Excel.SettingCollection; + load(options?: Excel.Interfaces.SettingCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SettingCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.SettingCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.SettingCollection; /** * * Occurs when the Settings in the document are changed. @@ -23478,7 +23474,7 @@ declare namespace Excel { */ class Setting extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; private static DateJSONPrefix; private static DateJSONSuffix; private static replaceStringDateWithDate; @@ -23518,23 +23514,23 @@ declare namespace Excel { */ delete(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.Setting` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.Setting` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Setting` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.SettingLoadOptions): Excel.Setting; - load(option?: string | string[]): Excel.Setting; - load(option?: { + load(options?: Excel.Interfaces.SettingLoadOptions): Excel.Setting; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Setting; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.Setting; @@ -23552,7 +23548,7 @@ declare namespace Excel { */ class NamedItemCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.NamedItem[]; /** @@ -23605,23 +23601,23 @@ declare namespace Excel { */ getItemOrNullObject(name: string): Excel.NamedItem; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.NamedItemCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.NamedItemCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.NamedItemCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.NamedItemCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.NamedItemCollection; - load(option?: string | string[]): Excel.NamedItemCollection; - load(option?: OfficeExtension.LoadOption): Excel.NamedItemCollection; + load(options?: Excel.Interfaces.NamedItemCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.NamedItemCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.NamedItemCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.NamedItemCollection; /** * 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.NamedItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.NamedItemCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -23636,7 +23632,7 @@ declare namespace Excel { */ class NamedItem extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns an object containing values and types of the named item. Read-only. @@ -23743,23 +23739,23 @@ declare namespace Excel { */ getRangeOrNullObject(): Excel.Range; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.NamedItem` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.NamedItem` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.NamedItem` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.NamedItemLoadOptions): Excel.NamedItem; - load(option?: string | string[]): Excel.NamedItem; - load(option?: { + load(options?: Excel.Interfaces.NamedItemLoadOptions): Excel.NamedItem; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.NamedItem; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.NamedItem; @@ -23777,7 +23773,7 @@ declare namespace Excel { */ class NamedItemArrayValues extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the types for each item in the named item array @@ -23793,23 +23789,23 @@ declare namespace Excel { */ readonly values: any[][]; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.NamedItemArrayValues` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.NamedItemArrayValues` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.NamedItemArrayValues` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.NamedItemArrayValuesLoadOptions): Excel.NamedItemArrayValues; - load(option?: string | string[]): Excel.NamedItemArrayValues; - load(option?: { + load(options?: Excel.Interfaces.NamedItemArrayValuesLoadOptions): Excel.NamedItemArrayValues; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.NamedItemArrayValues; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.NamedItemArrayValues; @@ -23827,7 +23823,7 @@ declare namespace Excel { */ class Binding extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents binding identifier. Read-only. @@ -23871,23 +23867,23 @@ declare namespace Excel { */ getText(): OfficeExtension.ClientResult; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.Binding` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.Binding` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Binding` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.BindingLoadOptions): Excel.Binding; - load(option?: string | string[]): Excel.Binding; - load(option?: { + load(options?: Excel.Interfaces.BindingLoadOptions): Excel.Binding; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Binding; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.Binding; @@ -23923,7 +23919,7 @@ declare namespace Excel { */ class BindingCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.Binding[]; /** @@ -24036,23 +24032,23 @@ declare namespace Excel { */ getItemOrNullObject(id: string): Excel.Binding; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.BindingCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.BindingCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.BindingCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.BindingCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.BindingCollection; - load(option?: string | string[]): Excel.BindingCollection; - load(option?: OfficeExtension.LoadOption): Excel.BindingCollection; + load(options?: Excel.Interfaces.BindingCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.BindingCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.BindingCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.BindingCollection; /** * 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.BindingCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.BindingCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -24067,7 +24063,7 @@ declare namespace Excel { */ class TableCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.Table[]; /** @@ -24122,23 +24118,23 @@ declare namespace Excel { */ getItemOrNullObject(key: string): Excel.Table; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.TableCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.TableCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.TableCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.TableCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableCollection; - load(option?: string | string[]): Excel.TableCollection; - load(option?: OfficeExtension.LoadOption): Excel.TableCollection; + load(options?: Excel.Interfaces.TableCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TableCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.TableCollection; /** * * Occurs when new table is added in a workbook. @@ -24190,7 +24186,7 @@ declare namespace Excel { */ class TableScopedCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.Table[]; /** @@ -24217,23 +24213,23 @@ declare namespace Excel { */ getItem(key: string): Excel.Table; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.TableScopedCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.TableScopedCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.TableScopedCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.TableScopedCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableScopedCollection; - load(option?: string | string[]): Excel.TableScopedCollection; - load(option?: OfficeExtension.LoadOption): Excel.TableScopedCollection; + load(options?: Excel.Interfaces.TableScopedCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableScopedCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TableScopedCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.TableScopedCollection; /** * 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.TableScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.TableScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -24243,13 +24239,13 @@ declare namespace Excel { /** * * Represents an Excel table. - * To learn more about the table object model, read {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-tables | Work with tables using the Excel JavaScript API}. + To learn more about the table object model, read {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-tables | Work with tables using the Excel JavaScript API}. * * [Api set: ExcelApi 1.1] */ class Table extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the AutoFilter object of the table. Read-Only. @@ -24441,23 +24437,23 @@ declare namespace Excel { */ reapplyFilters(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.Table` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.Table` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Table` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.TableLoadOptions): Excel.Table; - load(option?: string | string[]): Excel.Table; - load(option?: { + load(options?: Excel.Interfaces.TableLoadOptions): Excel.Table; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Table; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.Table; @@ -24503,7 +24499,7 @@ declare namespace Excel { */ class TableColumnCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.TableColumn[]; /** @@ -24559,23 +24555,23 @@ declare namespace Excel { */ getItemOrNullObject(key: number | string): Excel.TableColumn; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.TableColumnCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.TableColumnCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.TableColumnCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.TableColumnCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableColumnCollection; - load(option?: string | string[]): Excel.TableColumnCollection; - load(option?: OfficeExtension.LoadOption): Excel.TableColumnCollection; + load(options?: Excel.Interfaces.TableColumnCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableColumnCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TableColumnCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.TableColumnCollection; /** * 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.TableColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.TableColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -24590,7 +24586,7 @@ declare namespace Excel { */ class TableColumn extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Retrieve the filter applied to the column. Read-only. @@ -24676,23 +24672,23 @@ declare namespace Excel { */ getTotalRowRange(): Excel.Range; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.TableColumn` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.TableColumn` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.TableColumn` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.TableColumnLoadOptions): Excel.TableColumn; - load(option?: string | string[]): Excel.TableColumn; - load(option?: { + load(options?: Excel.Interfaces.TableColumnLoadOptions): Excel.TableColumn; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TableColumn; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.TableColumn; @@ -24715,7 +24711,7 @@ declare namespace Excel { */ class TableRowCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.TableRow[]; /** @@ -24762,23 +24758,23 @@ declare namespace Excel { */ getItemAt(index: number): Excel.TableRow; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.TableRowCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.TableRowCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.TableRowCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.TableRowCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableRowCollection; - load(option?: string | string[]): Excel.TableRowCollection; - load(option?: OfficeExtension.LoadOption): Excel.TableRowCollection; + load(options?: Excel.Interfaces.TableRowCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableRowCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TableRowCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.TableRowCollection; /** * 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.TableRowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.TableRowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -24798,7 +24794,7 @@ declare namespace Excel { */ class TableRow extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns the index number of the row within the rows collection of the table. Zero-indexed. Read-only. @@ -24842,23 +24838,23 @@ declare namespace Excel { */ getRange(): Excel.Range; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.TableRow` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.TableRow` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.TableRow` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.TableRowLoadOptions): Excel.TableRow; - load(option?: string | string[]): Excel.TableRow; - load(option?: { + load(options?: Excel.Interfaces.TableRowLoadOptions): Excel.TableRow; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TableRow; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.TableRow; @@ -24871,13 +24867,13 @@ declare namespace Excel { /** * * Represents the data validation applied to the current range. - * To learn more about the data validation object model, read {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-data-validation | Add data validation to Excel ranges}. + To learn more about the data validation object model, read {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-data-validation | Add data validation to Excel ranges}. * * [Api set: ExcelApi 1.8] */ class DataValidation extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Error alert when user enters invalid data. @@ -24958,23 +24954,23 @@ declare namespace Excel { */ getInvalidCellsOrNullObject(): Excel.RangeAreas; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.DataValidation` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.DataValidation` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.DataValidation` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.DataValidationLoadOptions): Excel.DataValidation; - load(option?: string | string[]): Excel.DataValidation; - load(option?: { + load(options?: Excel.Interfaces.DataValidationLoadOptions): Excel.DataValidation; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.DataValidation; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.DataValidation; @@ -25049,7 +25045,7 @@ declare namespace Excel { */ class RemoveDuplicatesResult extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Number of duplicated rows removed by the operation. @@ -25065,23 +25061,23 @@ declare namespace Excel { */ readonly uniqueRemaining: number; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.RemoveDuplicatesResult` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.RemoveDuplicatesResult` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.RemoveDuplicatesResult` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.RemoveDuplicatesResultLoadOptions): Excel.RemoveDuplicatesResult; - load(option?: string | string[]): Excel.RemoveDuplicatesResult; - load(option?: { + load(options?: Excel.Interfaces.RemoveDuplicatesResultLoadOptions): Excel.RemoveDuplicatesResult; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.RemoveDuplicatesResult; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.RemoveDuplicatesResult; @@ -25269,7 +25265,7 @@ declare namespace Excel { */ class RangeFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Collection of border objects that apply to the overall range. Read-only. @@ -25404,6 +25400,18 @@ declare namespace Excel { set(properties: Interfaces.RangeFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.RangeFormat): void; + /** + * + * Adjusts the indentation of the range formatting. The indent value ranges from 0 to 250. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + * + * @param amount The number of character spaces by which the current indent is adjusted. This value should be between -250 and 250. + **Note**: If the amount would raise the indent level above 250, the indent level stays with 250. + Similarly, if the amount would lower the indent level below 0, the indent level stays 0. + */ + adjustIndent(amount: number): void; /** * * Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns. @@ -25419,23 +25427,23 @@ declare namespace Excel { */ autofitRows(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.RangeFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.RangeFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.RangeFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.RangeFormatLoadOptions): Excel.RangeFormat; - load(option?: string | string[]): Excel.RangeFormat; - load(option?: { + load(options?: Excel.Interfaces.RangeFormatLoadOptions): Excel.RangeFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.RangeFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.RangeFormat; @@ -25453,7 +25461,7 @@ declare namespace Excel { */ class FormatProtection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Indicates if Excel hides the formula for the cells in the range. A null value indicates that the entire range doesn't have uniform formula hidden setting. @@ -25483,23 +25491,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.FormatProtection): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.FormatProtection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.FormatProtection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.FormatProtection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.FormatProtectionLoadOptions): Excel.FormatProtection; - load(option?: string | string[]): Excel.FormatProtection; - load(option?: { + load(options?: Excel.Interfaces.FormatProtectionLoadOptions): Excel.FormatProtection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.FormatProtection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.FormatProtection; @@ -25517,10 +25525,10 @@ declare namespace Excel { */ class RangeFill extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * - * HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange") + * HTML color code representing the color of the background, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange") * * [Api set: ExcelApi 1.1] */ @@ -25579,23 +25587,23 @@ declare namespace Excel { */ clear(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.RangeFill` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.RangeFill` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.RangeFill` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.RangeFillLoadOptions): Excel.RangeFill; - load(option?: string | string[]): Excel.RangeFill; - load(option?: { + load(options?: Excel.Interfaces.RangeFillLoadOptions): Excel.RangeFill; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.RangeFill; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.RangeFill; @@ -25613,7 +25621,7 @@ declare namespace Excel { */ class RangeBorder extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange"). @@ -25665,23 +25673,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.RangeBorder): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.RangeBorder` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.RangeBorder` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.RangeBorder` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.RangeBorderLoadOptions): Excel.RangeBorder; - load(option?: string | string[]): Excel.RangeBorder; - load(option?: { + load(options?: Excel.Interfaces.RangeBorderLoadOptions): Excel.RangeBorder; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.RangeBorder; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.RangeBorder; @@ -25699,7 +25707,7 @@ declare namespace Excel { */ class RangeBorderCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.RangeBorder[]; /** @@ -25745,23 +25753,23 @@ declare namespace Excel { */ getItemAt(index: number): Excel.RangeBorder; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.RangeBorderCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.RangeBorderCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.RangeBorderCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.RangeBorderCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.RangeBorderCollection; - load(option?: string | string[]): Excel.RangeBorderCollection; - load(option?: OfficeExtension.LoadOption): Excel.RangeBorderCollection; + load(options?: Excel.Interfaces.RangeBorderCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.RangeBorderCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.RangeBorderCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.RangeBorderCollection; /** * 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.RangeBorderCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.RangeBorderCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -25776,7 +25784,7 @@ declare namespace Excel { */ class RangeFont extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the bold status of font. @@ -25869,23 +25877,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.RangeFont): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.RangeFont` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.RangeFont` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.RangeFont` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.RangeFontLoadOptions): Excel.RangeFont; - load(option?: string | string[]): Excel.RangeFont; - load(option?: { + load(options?: Excel.Interfaces.RangeFontLoadOptions): Excel.RangeFont; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.RangeFont; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.RangeFont; @@ -25903,7 +25911,7 @@ declare namespace Excel { */ class ChartCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.Chart[]; /** @@ -25971,23 +25979,23 @@ declare namespace Excel { */ getItemOrNullObject(name: string): Excel.Chart; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartCollection; - load(option?: string | string[]): Excel.ChartCollection; - load(option?: OfficeExtension.LoadOption): Excel.ChartCollection; + load(options?: Excel.Interfaces.ChartCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ChartCollection; /** * * Occurs when a chart is activated. @@ -26033,13 +26041,13 @@ declare namespace Excel { /** * * Represents a chart object in a workbook. - * To learn more about the Chart object model, see {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-charts | Work with charts using the Excel JavaScript API}. + To learn more about the Chart object model, see {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-charts | Work with charts using the Excel JavaScript API}. * * [Api set: ExcelApi 1.1] */ class Chart extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents chart axes. Read-only. @@ -26295,23 +26303,23 @@ declare namespace Excel { */ setPosition(startCell: Range | string, endCell?: Range | string): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.Chart` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.Chart` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Chart` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartLoadOptions): Excel.Chart; - load(option?: string | string[]): Excel.Chart; - load(option?: { + load(options?: Excel.Interfaces.ChartLoadOptions): Excel.Chart; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Chart; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.Chart; @@ -26347,7 +26355,7 @@ declare namespace Excel { */ class ChartPivotOptions extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Specifies whether or not to display the axis field buttons on a PivotChart. The ShowAxisFieldButtons property corresponds to the "Show Axis Field Buttons" command on the "Field Buttons" drop-down list of the "Analyze" tab, which is available when a PivotChart is selected. @@ -26391,23 +26399,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartPivotOptions): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartPivotOptions` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartPivotOptions` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartPivotOptions` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartPivotOptionsLoadOptions): Excel.ChartPivotOptions; - load(option?: string | string[]): Excel.ChartPivotOptions; - load(option?: { + load(options?: Excel.Interfaces.ChartPivotOptionsLoadOptions): Excel.ChartPivotOptions; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartPivotOptions; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartPivotOptions; @@ -26425,7 +26433,7 @@ declare namespace Excel { */ class ChartAreaFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the border format of chart area, which includes color, linestyle, and weight. Read-only. @@ -26476,23 +26484,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartAreaFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartAreaFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartAreaFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartAreaFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartAreaFormatLoadOptions): Excel.ChartAreaFormat; - load(option?: string | string[]): Excel.ChartAreaFormat; - load(option?: { + load(options?: Excel.Interfaces.ChartAreaFormatLoadOptions): Excel.ChartAreaFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartAreaFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartAreaFormat; @@ -26510,7 +26518,7 @@ declare namespace Excel { */ class ChartSeriesCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.ChartSeries[]; /** @@ -26547,23 +26555,23 @@ declare namespace Excel { */ getItemAt(index: number): Excel.ChartSeries; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartSeriesCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartSeriesCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartSeriesCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartSeriesCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartSeriesCollection; - load(option?: string | string[]): Excel.ChartSeriesCollection; - load(option?: OfficeExtension.LoadOption): Excel.ChartSeriesCollection; + load(options?: Excel.Interfaces.ChartSeriesCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartSeriesCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartSeriesCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ChartSeriesCollection; /** * 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.ChartSeriesCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartSeriesCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -26578,7 +26586,7 @@ declare namespace Excel { */ class ChartSeries extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Encapsulates the bin options for histogram charts and pareto charts. Read-only. @@ -26952,23 +26960,23 @@ declare namespace Excel { */ setXAxisValues(sourceData: Range): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartSeries` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartSeries` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartSeries` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartSeriesLoadOptions): Excel.ChartSeries; - load(option?: string | string[]): Excel.ChartSeries; - load(option?: { + load(options?: Excel.Interfaces.ChartSeriesLoadOptions): Excel.ChartSeries; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartSeries; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartSeries; @@ -26986,7 +26994,7 @@ declare namespace Excel { */ class ChartSeriesFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the fill format of a chart series, which includes background formatting information. Read-only. @@ -27016,23 +27024,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartSeriesFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartSeriesFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartSeriesFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartSeriesFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartSeriesFormatLoadOptions): Excel.ChartSeriesFormat; - load(option?: string | string[]): Excel.ChartSeriesFormat; - load(option?: { + load(options?: Excel.Interfaces.ChartSeriesFormatLoadOptions): Excel.ChartSeriesFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartSeriesFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartSeriesFormat; @@ -27050,7 +27058,7 @@ declare namespace Excel { */ class ChartPointsCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.ChartPoint[]; /** @@ -27077,23 +27085,23 @@ declare namespace Excel { */ getItemAt(index: number): Excel.ChartPoint; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartPointsCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartPointsCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartPointsCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartPointsCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartPointsCollection; - load(option?: string | string[]): Excel.ChartPointsCollection; - load(option?: OfficeExtension.LoadOption): Excel.ChartPointsCollection; + load(options?: Excel.Interfaces.ChartPointsCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartPointsCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartPointsCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ChartPointsCollection; /** * 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.ChartPointsCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartPointsCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -27108,7 +27116,7 @@ declare namespace Excel { */ class ChartPoint extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns the data label of a chart point. Read-only. @@ -27180,23 +27188,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartPoint): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartPoint` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartPoint` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartPoint` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartPointLoadOptions): Excel.ChartPoint; - load(option?: string | string[]): Excel.ChartPoint; - load(option?: { + load(options?: Excel.Interfaces.ChartPointLoadOptions): Excel.ChartPoint; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartPoint; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartPoint; @@ -27214,7 +27222,7 @@ declare namespace Excel { */ class ChartPointFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the border format of a chart data point, which includes color, style, and weight information. Read-only. @@ -27244,23 +27252,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartPointFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartPointFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartPointFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartPointFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartPointFormatLoadOptions): Excel.ChartPointFormat; - load(option?: string | string[]): Excel.ChartPointFormat; - load(option?: { + load(options?: Excel.Interfaces.ChartPointFormatLoadOptions): Excel.ChartPointFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartPointFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartPointFormat; @@ -27278,7 +27286,7 @@ declare namespace Excel { */ class ChartAxes extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the category axis in a chart. Read-only. @@ -27335,23 +27343,23 @@ declare namespace Excel { */ getItem(type: "Invalid" | "Category" | "Value" | "Series", group?: "Primary" | "Secondary"): Excel.ChartAxis; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartAxes` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartAxes` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartAxes` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartAxesLoadOptions): Excel.ChartAxes; - load(option?: string | string[]): Excel.ChartAxes; - load(option?: { + load(options?: Excel.Interfaces.ChartAxesLoadOptions): Excel.ChartAxes; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartAxes; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartAxes; @@ -27369,7 +27377,7 @@ declare namespace Excel { */ class ChartAxis extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the formatting of a chart object, which includes line and font formatting. Read-only. @@ -27685,23 +27693,23 @@ declare namespace Excel { */ setPositionAt(value: number): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartAxis` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartAxis` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartAxis` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartAxisLoadOptions): Excel.ChartAxis; - load(option?: string | string[]): Excel.ChartAxis; - load(option?: { + load(options?: Excel.Interfaces.ChartAxisLoadOptions): Excel.ChartAxis; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartAxis; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartAxis; @@ -27719,7 +27727,7 @@ declare namespace Excel { */ class ChartAxisFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents chart fill formatting. Read-only. @@ -27756,23 +27764,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartAxisFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartAxisFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartAxisFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartAxisFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartAxisFormatLoadOptions): Excel.ChartAxisFormat; - load(option?: string | string[]): Excel.ChartAxisFormat; - load(option?: { + load(options?: Excel.Interfaces.ChartAxisFormatLoadOptions): Excel.ChartAxisFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartAxisFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartAxisFormat; @@ -27790,7 +27798,7 @@ declare namespace Excel { */ class ChartAxisTitle extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the formatting of chart axis title. Read-only. @@ -27836,23 +27844,23 @@ declare namespace Excel { */ setFormula(formula: string): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartAxisTitle` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartAxisTitle` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartAxisTitle` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartAxisTitleLoadOptions): Excel.ChartAxisTitle; - load(option?: string | string[]): Excel.ChartAxisTitle; - load(option?: { + load(options?: Excel.Interfaces.ChartAxisTitleLoadOptions): Excel.ChartAxisTitle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartAxisTitle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartAxisTitle; @@ -27870,7 +27878,7 @@ declare namespace Excel { */ class ChartAxisTitleFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the border format, which includes color, linestyle, and weight. @@ -27907,23 +27915,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartAxisTitleFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartAxisTitleFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartAxisTitleFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartAxisTitleFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartAxisTitleFormatLoadOptions): Excel.ChartAxisTitleFormat; - load(option?: string | string[]): Excel.ChartAxisTitleFormat; - load(option?: { + load(options?: Excel.Interfaces.ChartAxisTitleFormatLoadOptions): Excel.ChartAxisTitleFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartAxisTitleFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartAxisTitleFormat; @@ -27941,7 +27949,7 @@ declare namespace Excel { */ class ChartDataLabels extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the format of chart data labels, which includes fill and font formatting. Read-only. @@ -28044,7 +28052,7 @@ declare namespace Excel { /** * * Represents the vertical alignment of chart data label. See Excel.ChartTextVerticalAlignment for details. - This property is valid only when TextOrientation of data label is 90, -90 or 180. + This property is valid only when TextOrientation of data label is -90, 90, or 180. * * [Api set: ExcelApi 1.8] */ @@ -28064,23 +28072,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartDataLabels): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartDataLabels` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartDataLabels` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartDataLabels` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartDataLabelsLoadOptions): Excel.ChartDataLabels; - load(option?: string | string[]): Excel.ChartDataLabels; - load(option?: { + load(options?: Excel.Interfaces.ChartDataLabelsLoadOptions): Excel.ChartDataLabels; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartDataLabels; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartDataLabels; @@ -28098,7 +28106,7 @@ declare namespace Excel { */ class ChartDataLabel extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the format of chart data label. @@ -28130,7 +28138,7 @@ declare namespace Excel { /** * * Represents the horizontal alignment for chart data label. See Excel.ChartTextHorizontalAlignment for details. - This property is valid only when TextOrientation of data label is 90, -90 or 180. + This property is valid only when TextOrientation of data label is -90, 90, or 180. * * [Api set: ExcelApi 1.8] */ @@ -28263,23 +28271,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartDataLabel): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartDataLabel` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartDataLabel` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartDataLabel` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartDataLabelLoadOptions): Excel.ChartDataLabel; - load(option?: string | string[]): Excel.ChartDataLabel; - load(option?: { + load(options?: Excel.Interfaces.ChartDataLabelLoadOptions): Excel.ChartDataLabel; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartDataLabel; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartDataLabel; @@ -28297,7 +28305,7 @@ declare namespace Excel { */ class ChartDataLabelFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the border format, which includes color, linestyle, and weight. Read-only. @@ -28334,23 +28342,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartDataLabelFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartDataLabelFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartDataLabelFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartDataLabelFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartDataLabelFormatLoadOptions): Excel.ChartDataLabelFormat; - load(option?: string | string[]): Excel.ChartDataLabelFormat; - load(option?: { + load(options?: Excel.Interfaces.ChartDataLabelFormatLoadOptions): Excel.ChartDataLabelFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartDataLabelFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartDataLabelFormat; @@ -28368,7 +28376,7 @@ declare namespace Excel { */ class ChartErrorBars extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Specifies the formatting type of the error bars. @@ -28419,23 +28427,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartErrorBars): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartErrorBars` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartErrorBars` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartErrorBars` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartErrorBarsLoadOptions): Excel.ChartErrorBars; - load(option?: string | string[]): Excel.ChartErrorBars; - load(option?: { + load(options?: Excel.Interfaces.ChartErrorBarsLoadOptions): Excel.ChartErrorBars; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartErrorBars; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartErrorBars; @@ -28453,7 +28461,7 @@ declare namespace Excel { */ class ChartErrorBarsFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the chart line formatting. @@ -28476,23 +28484,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartErrorBarsFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartErrorBarsFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartErrorBarsFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartErrorBarsFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartErrorBarsFormatLoadOptions): Excel.ChartErrorBarsFormat; - load(option?: string | string[]): Excel.ChartErrorBarsFormat; - load(option?: { + load(options?: Excel.Interfaces.ChartErrorBarsFormatLoadOptions): Excel.ChartErrorBarsFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartErrorBarsFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartErrorBarsFormat; @@ -28510,7 +28518,7 @@ declare namespace Excel { */ class ChartGridlines extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the formatting of chart gridlines. Read-only. @@ -28540,23 +28548,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartGridlines): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartGridlines` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartGridlines` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartGridlines` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartGridlinesLoadOptions): Excel.ChartGridlines; - load(option?: string | string[]): Excel.ChartGridlines; - load(option?: { + load(options?: Excel.Interfaces.ChartGridlinesLoadOptions): Excel.ChartGridlines; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartGridlines; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartGridlines; @@ -28574,7 +28582,7 @@ declare namespace Excel { */ class ChartGridlinesFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents chart line formatting. Read-only. @@ -28597,23 +28605,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartGridlinesFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartGridlinesFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartGridlinesFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartGridlinesFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartGridlinesFormatLoadOptions): Excel.ChartGridlinesFormat; - load(option?: string | string[]): Excel.ChartGridlinesFormat; - load(option?: { + load(options?: Excel.Interfaces.ChartGridlinesFormatLoadOptions): Excel.ChartGridlinesFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartGridlinesFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartGridlinesFormat; @@ -28631,7 +28639,7 @@ declare namespace Excel { */ class ChartLegend extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the formatting of a chart legend, which includes fill and font formatting. Read-only. @@ -28717,23 +28725,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartLegend): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartLegend` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartLegend` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartLegend` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartLegendLoadOptions): Excel.ChartLegend; - load(option?: string | string[]): Excel.ChartLegend; - load(option?: { + load(options?: Excel.Interfaces.ChartLegendLoadOptions): Excel.ChartLegend; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartLegend; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartLegend; @@ -28751,7 +28759,7 @@ declare namespace Excel { */ class ChartLegendEntry extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the height of the legendEntry on the chart legend. @@ -28809,23 +28817,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartLegendEntry): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartLegendEntry` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartLegendEntry` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartLegendEntry` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartLegendEntryLoadOptions): Excel.ChartLegendEntry; - load(option?: string | string[]): Excel.ChartLegendEntry; - load(option?: { + load(options?: Excel.Interfaces.ChartLegendEntryLoadOptions): Excel.ChartLegendEntry; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartLegendEntry; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartLegendEntry; @@ -28843,7 +28851,7 @@ declare namespace Excel { */ class ChartLegendEntryCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.ChartLegendEntry[]; /** @@ -28863,23 +28871,23 @@ declare namespace Excel { */ getItemAt(index: number): Excel.ChartLegendEntry; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartLegendEntryCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartLegendEntryCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartLegendEntryCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartLegendEntryCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartLegendEntryCollection; - load(option?: string | string[]): Excel.ChartLegendEntryCollection; - load(option?: OfficeExtension.LoadOption): Excel.ChartLegendEntryCollection; + load(options?: Excel.Interfaces.ChartLegendEntryCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartLegendEntryCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartLegendEntryCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ChartLegendEntryCollection; /** * 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.ChartLegendEntryCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartLegendEntryCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -28894,7 +28902,7 @@ declare namespace Excel { */ class ChartLegendFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the border format, which includes color, linestyle, and weight. Read-only. @@ -28931,23 +28939,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartLegendFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartLegendFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartLegendFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartLegendFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartLegendFormatLoadOptions): Excel.ChartLegendFormat; - load(option?: string | string[]): Excel.ChartLegendFormat; - load(option?: { + load(options?: Excel.Interfaces.ChartLegendFormatLoadOptions): Excel.ChartLegendFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartLegendFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartLegendFormat; @@ -28965,7 +28973,7 @@ declare namespace Excel { */ class ChartMapOptions extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns or sets the series map labels strategy of a region map chart. Read/Write. @@ -29002,23 +29010,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartMapOptions): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartMapOptions` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartMapOptions` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartMapOptions` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartMapOptionsLoadOptions): Excel.ChartMapOptions; - load(option?: string | string[]): Excel.ChartMapOptions; - load(option?: { + load(options?: Excel.Interfaces.ChartMapOptionsLoadOptions): Excel.ChartMapOptions; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartMapOptions; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartMapOptions; @@ -29036,7 +29044,7 @@ declare namespace Excel { */ class ChartTitle extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the formatting of a chart title, which includes fill and font formatting. Read-only. @@ -29162,23 +29170,23 @@ declare namespace Excel { */ setFormula(formula: string): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartTitle` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartTitle` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartTitle` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartTitleLoadOptions): Excel.ChartTitle; - load(option?: string | string[]): Excel.ChartTitle; - load(option?: { + load(options?: Excel.Interfaces.ChartTitleLoadOptions): Excel.ChartTitle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartTitle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartTitle; @@ -29196,7 +29204,7 @@ declare namespace Excel { */ class ChartFormatString extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the font attributes, such as font name, font size, color, etc. of chart characters object. @@ -29219,23 +29227,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartFormatString): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartFormatString` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartFormatString` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartFormatString` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartFormatStringLoadOptions): Excel.ChartFormatString; - load(option?: string | string[]): Excel.ChartFormatString; - load(option?: { + load(options?: Excel.Interfaces.ChartFormatStringLoadOptions): Excel.ChartFormatString; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartFormatString; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartFormatString; @@ -29253,7 +29261,7 @@ declare namespace Excel { */ class ChartTitleFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the border format of chart title, which includes color, linestyle, and weight. Read-only. @@ -29290,23 +29298,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartTitleFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartTitleFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartTitleFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartTitleFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartTitleFormatLoadOptions): Excel.ChartTitleFormat; - load(option?: string | string[]): Excel.ChartTitleFormat; - load(option?: { + load(options?: Excel.Interfaces.ChartTitleFormatLoadOptions): Excel.ChartTitleFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartTitleFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartTitleFormat; @@ -29324,7 +29332,7 @@ declare namespace Excel { */ class ChartFill extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. */ @@ -29342,7 +29350,7 @@ declare namespace Excel { * * [Api set: ExcelApi 1.1] * - * @param color HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange"). + * @param color HTML color code representing the color of the background, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange"). */ setSolidColor(color: string): void; /** @@ -29361,7 +29369,7 @@ declare namespace Excel { */ class ChartBorder extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * HTML color code representing the color of borders in the chart. @@ -29405,23 +29413,23 @@ declare namespace Excel { */ clear(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartBorder` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartBorder` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartBorder` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartBorderLoadOptions): Excel.ChartBorder; - load(option?: string | string[]): Excel.ChartBorder; - load(option?: { + load(options?: Excel.Interfaces.ChartBorderLoadOptions): Excel.ChartBorder; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartBorder; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartBorder; @@ -29439,7 +29447,7 @@ declare namespace Excel { */ class ChartBinOptions extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Specifies whether or not the bin overflow is enabled in a histogram chart or pareto chart. Read/Write. @@ -29504,23 +29512,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartBinOptions): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartBinOptions` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartBinOptions` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartBinOptions` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartBinOptionsLoadOptions): Excel.ChartBinOptions; - load(option?: string | string[]): Excel.ChartBinOptions; - load(option?: { + load(options?: Excel.Interfaces.ChartBinOptionsLoadOptions): Excel.ChartBinOptions; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartBinOptions; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartBinOptions; @@ -29538,7 +29546,7 @@ declare namespace Excel { */ class ChartBoxwhiskerOptions extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns or sets the quartile calculation type of a box and whisker chart. Read/Write. @@ -29589,23 +29597,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartBoxwhiskerOptions): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartBoxwhiskerOptions` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartBoxwhiskerOptions` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartBoxwhiskerOptions` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartBoxwhiskerOptionsLoadOptions): Excel.ChartBoxwhiskerOptions; - load(option?: string | string[]): Excel.ChartBoxwhiskerOptions; - load(option?: { + load(options?: Excel.Interfaces.ChartBoxwhiskerOptionsLoadOptions): Excel.ChartBoxwhiskerOptions; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartBoxwhiskerOptions; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartBoxwhiskerOptions; @@ -29623,7 +29631,7 @@ declare namespace Excel { */ class ChartLineFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * HTML color code representing the color of lines in the chart. @@ -29667,23 +29675,23 @@ declare namespace Excel { */ clear(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartLineFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartLineFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartLineFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartLineFormatLoadOptions): Excel.ChartLineFormat; - load(option?: string | string[]): Excel.ChartLineFormat; - load(option?: { + load(options?: Excel.Interfaces.ChartLineFormatLoadOptions): Excel.ChartLineFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartLineFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartLineFormat; @@ -29701,7 +29709,7 @@ declare namespace Excel { */ class ChartFont extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the bold status of font. @@ -29759,23 +29767,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartFont): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartFont` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartFont` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartFont` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartFontLoadOptions): Excel.ChartFont; - load(option?: string | string[]): Excel.ChartFont; - load(option?: { + load(options?: Excel.Interfaces.ChartFontLoadOptions): Excel.ChartFont; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartFont; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartFont; @@ -29793,7 +29801,7 @@ declare namespace Excel { */ class ChartTrendline extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the formatting of a chart trendline. @@ -29893,23 +29901,23 @@ declare namespace Excel { */ delete(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartTrendline` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartTrendline` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartTrendline` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartTrendlineLoadOptions): Excel.ChartTrendline; - load(option?: string | string[]): Excel.ChartTrendline; - load(option?: { + load(options?: Excel.Interfaces.ChartTrendlineLoadOptions): Excel.ChartTrendline; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartTrendline; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartTrendline; @@ -29927,7 +29935,7 @@ declare namespace Excel { */ class ChartTrendlineCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.ChartTrendline[]; /** @@ -29965,23 +29973,23 @@ declare namespace Excel { */ getItem(index: number): Excel.ChartTrendline; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartTrendlineCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartTrendlineCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartTrendlineCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartTrendlineCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartTrendlineCollection; - load(option?: string | string[]): Excel.ChartTrendlineCollection; - load(option?: OfficeExtension.LoadOption): Excel.ChartTrendlineCollection; + load(options?: Excel.Interfaces.ChartTrendlineCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartTrendlineCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartTrendlineCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ChartTrendlineCollection; /** * 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.ChartTrendlineCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartTrendlineCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -29996,7 +30004,7 @@ declare namespace Excel { */ class ChartTrendlineFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents chart line formatting. Read-only. @@ -30019,23 +30027,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartTrendlineFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartTrendlineFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartTrendlineFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartTrendlineFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartTrendlineFormatLoadOptions): Excel.ChartTrendlineFormat; - load(option?: string | string[]): Excel.ChartTrendlineFormat; - load(option?: { + load(options?: Excel.Interfaces.ChartTrendlineFormatLoadOptions): Excel.ChartTrendlineFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartTrendlineFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartTrendlineFormat; @@ -30053,7 +30061,7 @@ declare namespace Excel { */ class ChartTrendlineLabel extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the format of chart trendline label. @@ -30085,7 +30093,7 @@ declare namespace Excel { /** * * Represents the horizontal alignment for chart trendline label. See Excel.ChartTextHorizontalAlignment for details. - This property is valid only when TextOrientation of trendline label is 90, -90 or 180. + This property is valid only when TextOrientation of trendline label is -90, 90, or 180. * * [Api set: ExcelApi 1.8] */ @@ -30162,23 +30170,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartTrendlineLabel): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartTrendlineLabel` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartTrendlineLabel` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartTrendlineLabel` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartTrendlineLabelLoadOptions): Excel.ChartTrendlineLabel; - load(option?: string | string[]): Excel.ChartTrendlineLabel; - load(option?: { + load(options?: Excel.Interfaces.ChartTrendlineLabelLoadOptions): Excel.ChartTrendlineLabel; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartTrendlineLabel; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartTrendlineLabel; @@ -30196,7 +30204,7 @@ declare namespace Excel { */ class ChartTrendlineLabelFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the border format, which includes color, linestyle, and weight. @@ -30233,23 +30241,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartTrendlineLabelFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartTrendlineLabelFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartTrendlineLabelFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartTrendlineLabelFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartTrendlineLabelFormatLoadOptions): Excel.ChartTrendlineLabelFormat; - load(option?: string | string[]): Excel.ChartTrendlineLabelFormat; - load(option?: { + load(options?: Excel.Interfaces.ChartTrendlineLabelFormatLoadOptions): Excel.ChartTrendlineLabelFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartTrendlineLabelFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartTrendlineLabelFormat; @@ -30267,7 +30275,7 @@ declare namespace Excel { */ class ChartPlotArea extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the formatting of a chart plotArea. @@ -30353,23 +30361,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartPlotArea): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartPlotArea` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartPlotArea` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartPlotArea` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartPlotAreaLoadOptions): Excel.ChartPlotArea; - load(option?: string | string[]): Excel.ChartPlotArea; - load(option?: { + load(options?: Excel.Interfaces.ChartPlotAreaLoadOptions): Excel.ChartPlotArea; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartPlotArea; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartPlotArea; @@ -30387,7 +30395,7 @@ declare namespace Excel { */ class ChartPlotAreaFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the border attributes of a chart plotArea. @@ -30417,23 +30425,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartPlotAreaFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartPlotAreaFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartPlotAreaFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartPlotAreaFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartPlotAreaFormatLoadOptions): Excel.ChartPlotAreaFormat; - load(option?: string | string[]): Excel.ChartPlotAreaFormat; - load(option?: { + load(options?: Excel.Interfaces.ChartPlotAreaFormatLoadOptions): Excel.ChartPlotAreaFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartPlotAreaFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartPlotAreaFormat; @@ -30451,7 +30459,7 @@ declare namespace Excel { */ class RangeSort extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Perform a sort operation. @@ -30494,7 +30502,7 @@ declare namespace Excel { */ class TableSort extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the current conditions used to last sort the table. Read-only. @@ -30553,23 +30561,23 @@ declare namespace Excel { */ reapply(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.TableSort` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.TableSort` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.TableSort` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.TableSortLoadOptions): Excel.TableSort; - load(option?: string | string[]): Excel.TableSort; - load(option?: { + load(options?: Excel.Interfaces.TableSortLoadOptions): Excel.TableSort; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TableSort; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.TableSort; @@ -30644,7 +30652,7 @@ declare namespace Excel { */ class Filter extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * The currently applied filter on the given column. Read-only. @@ -30781,23 +30789,23 @@ declare namespace Excel { */ clear(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.Filter` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.Filter` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Filter` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.FilterLoadOptions): Excel.Filter; - load(option?: string | string[]): Excel.Filter; - load(option?: { + load(options?: Excel.Interfaces.FilterLoadOptions): Excel.Filter; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Filter; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.Filter; @@ -30912,7 +30920,7 @@ declare namespace Excel { */ class AutoFilter extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * An array that holds all the filter criteria in the autofiltered range. Read-Only. @@ -30982,23 +30990,23 @@ declare namespace Excel { */ remove(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.AutoFilter` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.AutoFilter` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.AutoFilter` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.AutoFilterLoadOptions): Excel.AutoFilter; - load(option?: string | string[]): Excel.AutoFilter; - load(option?: { + load(options?: Excel.Interfaces.AutoFilterLoadOptions): Excel.AutoFilter; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.AutoFilter; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.AutoFilter; @@ -31040,7 +31048,7 @@ declare namespace Excel { */ class CustomXmlPartScopedCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.CustomXmlPart[]; /** @@ -31086,23 +31094,23 @@ declare namespace Excel { */ getOnlyItemOrNullObject(): Excel.CustomXmlPart; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.CustomXmlPartScopedCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.CustomXmlPartScopedCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.CustomXmlPartScopedCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.CustomXmlPartScopedCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CustomXmlPartScopedCollection; - load(option?: string | string[]): Excel.CustomXmlPartScopedCollection; - load(option?: OfficeExtension.LoadOption): Excel.CustomXmlPartScopedCollection; + load(options?: Excel.Interfaces.CustomXmlPartScopedCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CustomXmlPartScopedCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.CustomXmlPartScopedCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.CustomXmlPartScopedCollection; /** * 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.CustomXmlPartScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.CustomXmlPartScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -31117,7 +31125,7 @@ declare namespace Excel { */ class CustomXmlPartCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.CustomXmlPart[]; /** @@ -31165,23 +31173,23 @@ declare namespace Excel { */ getItemOrNullObject(id: string): Excel.CustomXmlPart; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.CustomXmlPartCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.CustomXmlPartCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.CustomXmlPartCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.CustomXmlPartCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CustomXmlPartCollection; - load(option?: string | string[]): Excel.CustomXmlPartCollection; - load(option?: OfficeExtension.LoadOption): Excel.CustomXmlPartCollection; + load(options?: Excel.Interfaces.CustomXmlPartCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CustomXmlPartCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.CustomXmlPartCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.CustomXmlPartCollection; /** * 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.CustomXmlPartCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.CustomXmlPartCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -31196,7 +31204,7 @@ declare namespace Excel { */ class CustomXmlPart extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * The custom XML part's ID. Read-only. @@ -31235,23 +31243,23 @@ declare namespace Excel { */ setXml(xml: string): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.CustomXmlPart` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.CustomXmlPart` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.CustomXmlPart` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.CustomXmlPartLoadOptions): Excel.CustomXmlPart; - load(option?: string | string[]): Excel.CustomXmlPart; - load(option?: { + load(options?: Excel.Interfaces.CustomXmlPartLoadOptions): Excel.CustomXmlPart; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.CustomXmlPart; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.CustomXmlPart; @@ -31269,7 +31277,7 @@ declare namespace Excel { */ class PivotTableCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.PivotTable[]; /** @@ -31317,23 +31325,23 @@ declare namespace Excel { */ refreshAll(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.PivotTableCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.PivotTableCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PivotTableCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.PivotTableCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotTableCollection; - load(option?: string | string[]): Excel.PivotTableCollection; - load(option?: OfficeExtension.LoadOption): Excel.PivotTableCollection; + load(options?: Excel.Interfaces.PivotTableCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotTableCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PivotTableCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.PivotTableCollection; /** * 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.PivotTableCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.PivotTableCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -31343,13 +31351,13 @@ declare namespace Excel { /** * * Represents an Excel PivotTable. - * To learn more about the PivotTable object model, read {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-pivottables | Work with PivotTables using the Excel JavaScript API}. + To learn more about the PivotTable object model, read {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-pivottables | Work with PivotTables using the Excel JavaScript API}. * * [Api set: ExcelApi 1.3] */ class PivotTable extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * The Column Pivot Hierarchies of the PivotTable. @@ -31456,23 +31464,23 @@ declare namespace Excel { */ refresh(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.PivotTable` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.PivotTable` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PivotTable` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.PivotTableLoadOptions): Excel.PivotTable; - load(option?: string | string[]): Excel.PivotTable; - load(option?: { + load(options?: Excel.Interfaces.PivotTableLoadOptions): Excel.PivotTable; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PivotTable; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.PivotTable; @@ -31490,7 +31498,7 @@ declare namespace Excel { */ class PivotLayout extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Specifies whether formatting will be automatically formatted when it’s refreshed or when fields are moved @@ -31656,23 +31664,23 @@ declare namespace Excel { */ setAutoSortOnCell(cell: Range | string, sortBy: "Ascending" | "Descending"): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.PivotLayout` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.PivotLayout` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PivotLayout` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.PivotLayoutLoadOptions): Excel.PivotLayout; - load(option?: string | string[]): Excel.PivotLayout; - load(option?: { + load(options?: Excel.Interfaces.PivotLayoutLoadOptions): Excel.PivotLayout; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PivotLayout; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.PivotLayout; @@ -31690,7 +31698,7 @@ declare namespace Excel { */ class PivotHierarchyCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.PivotHierarchy[]; /** @@ -31719,23 +31727,23 @@ declare namespace Excel { */ getItemOrNullObject(name: string): Excel.PivotHierarchy; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.PivotHierarchyCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.PivotHierarchyCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PivotHierarchyCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.PivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotHierarchyCollection; - load(option?: string | string[]): Excel.PivotHierarchyCollection; - load(option?: OfficeExtension.LoadOption): Excel.PivotHierarchyCollection; + load(options?: Excel.Interfaces.PivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotHierarchyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PivotHierarchyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.PivotHierarchyCollection; /** * 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.PivotHierarchyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.PivotHierarchyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -31750,7 +31758,7 @@ declare namespace Excel { */ class PivotHierarchy extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns the PivotFields associated with the PivotHierarchy. @@ -31787,23 +31795,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.PivotHierarchy): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.PivotHierarchy` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.PivotHierarchy` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PivotHierarchy` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.PivotHierarchyLoadOptions): Excel.PivotHierarchy; - load(option?: string | string[]): Excel.PivotHierarchy; - load(option?: { + load(options?: Excel.Interfaces.PivotHierarchyLoadOptions): Excel.PivotHierarchy; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PivotHierarchy; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.PivotHierarchy; @@ -31821,7 +31829,7 @@ declare namespace Excel { */ class RowColumnPivotHierarchyCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.RowColumnPivotHierarchy[]; /** @@ -31865,23 +31873,23 @@ declare namespace Excel { */ remove(rowColumnPivotHierarchy: Excel.RowColumnPivotHierarchy): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.RowColumnPivotHierarchyCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.RowColumnPivotHierarchyCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.RowColumnPivotHierarchyCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.RowColumnPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.RowColumnPivotHierarchyCollection; - load(option?: string | string[]): Excel.RowColumnPivotHierarchyCollection; - load(option?: OfficeExtension.LoadOption): Excel.RowColumnPivotHierarchyCollection; + load(options?: Excel.Interfaces.RowColumnPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.RowColumnPivotHierarchyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.RowColumnPivotHierarchyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.RowColumnPivotHierarchyCollection; /** * 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.RowColumnPivotHierarchyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.RowColumnPivotHierarchyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -31896,7 +31904,7 @@ declare namespace Excel { */ class RowColumnPivotHierarchy extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns the PivotFields associated with the RowColumnPivotHierarchy. @@ -31947,23 +31955,23 @@ declare namespace Excel { */ setToDefault(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.RowColumnPivotHierarchy` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.RowColumnPivotHierarchy` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.RowColumnPivotHierarchy` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.RowColumnPivotHierarchyLoadOptions): Excel.RowColumnPivotHierarchy; - load(option?: string | string[]): Excel.RowColumnPivotHierarchy; - load(option?: { + load(options?: Excel.Interfaces.RowColumnPivotHierarchyLoadOptions): Excel.RowColumnPivotHierarchy; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.RowColumnPivotHierarchy; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.RowColumnPivotHierarchy; @@ -31981,7 +31989,7 @@ declare namespace Excel { */ class FilterPivotHierarchyCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.FilterPivotHierarchy[]; /** @@ -32025,23 +32033,23 @@ declare namespace Excel { */ remove(filterPivotHierarchy: Excel.FilterPivotHierarchy): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.FilterPivotHierarchyCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.FilterPivotHierarchyCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.FilterPivotHierarchyCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.FilterPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.FilterPivotHierarchyCollection; - load(option?: string | string[]): Excel.FilterPivotHierarchyCollection; - load(option?: OfficeExtension.LoadOption): Excel.FilterPivotHierarchyCollection; + load(options?: Excel.Interfaces.FilterPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.FilterPivotHierarchyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.FilterPivotHierarchyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.FilterPivotHierarchyCollection; /** * 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.FilterPivotHierarchyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.FilterPivotHierarchyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -32056,7 +32064,7 @@ declare namespace Excel { */ class FilterPivotHierarchy extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns the PivotFields associated with the FilterPivotHierarchy. @@ -32114,23 +32122,23 @@ declare namespace Excel { */ setToDefault(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.FilterPivotHierarchy` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.FilterPivotHierarchy` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.FilterPivotHierarchy` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.FilterPivotHierarchyLoadOptions): Excel.FilterPivotHierarchy; - load(option?: string | string[]): Excel.FilterPivotHierarchy; - load(option?: { + load(options?: Excel.Interfaces.FilterPivotHierarchyLoadOptions): Excel.FilterPivotHierarchy; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.FilterPivotHierarchy; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.FilterPivotHierarchy; @@ -32148,7 +32156,7 @@ declare namespace Excel { */ class DataPivotHierarchyCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.DataPivotHierarchy[]; /** @@ -32191,23 +32199,23 @@ declare namespace Excel { */ remove(DataPivotHierarchy: Excel.DataPivotHierarchy): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.DataPivotHierarchyCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.DataPivotHierarchyCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.DataPivotHierarchyCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.DataPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.DataPivotHierarchyCollection; - load(option?: string | string[]): Excel.DataPivotHierarchyCollection; - load(option?: OfficeExtension.LoadOption): Excel.DataPivotHierarchyCollection; + load(options?: Excel.Interfaces.DataPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.DataPivotHierarchyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.DataPivotHierarchyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.DataPivotHierarchyCollection; /** * 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.DataPivotHierarchyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.DataPivotHierarchyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -32222,7 +32230,7 @@ declare namespace Excel { */ class DataPivotHierarchy extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns the PivotFields associated with the DataPivotHierarchy. @@ -32294,23 +32302,23 @@ declare namespace Excel { */ setToDefault(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.DataPivotHierarchy` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.DataPivotHierarchy` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.DataPivotHierarchy` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.DataPivotHierarchyLoadOptions): Excel.DataPivotHierarchy; - load(option?: string | string[]): Excel.DataPivotHierarchy; - load(option?: { + load(options?: Excel.Interfaces.DataPivotHierarchyLoadOptions): Excel.DataPivotHierarchy; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.DataPivotHierarchy; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.DataPivotHierarchy; @@ -32354,7 +32362,7 @@ declare namespace Excel { */ class PivotFieldCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.PivotField[]; /** @@ -32383,23 +32391,23 @@ declare namespace Excel { */ getItemOrNullObject(name: string): Excel.PivotField; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.PivotFieldCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.PivotFieldCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PivotFieldCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.PivotFieldCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotFieldCollection; - load(option?: string | string[]): Excel.PivotFieldCollection; - load(option?: OfficeExtension.LoadOption): Excel.PivotFieldCollection; + load(options?: Excel.Interfaces.PivotFieldCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotFieldCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PivotFieldCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.PivotFieldCollection; /** * 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.PivotFieldCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.PivotFieldCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -32414,7 +32422,7 @@ declare namespace Excel { */ class PivotField extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns the PivotFields associated with the PivotField. @@ -32504,23 +32512,23 @@ declare namespace Excel { */ sortByValues(sortBy: "Ascending" | "Descending", valuesHierarchy: Excel.DataPivotHierarchy, pivotItemScope?: Array): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.PivotField` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.PivotField` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PivotField` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.PivotFieldLoadOptions): Excel.PivotField; - load(option?: string | string[]): Excel.PivotField; - load(option?: { + load(options?: Excel.Interfaces.PivotFieldLoadOptions): Excel.PivotField; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PivotField; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.PivotField; @@ -32538,7 +32546,7 @@ declare namespace Excel { */ class PivotItemCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.PivotItem[]; /** @@ -32567,23 +32575,23 @@ declare namespace Excel { */ getItemOrNullObject(name: string): Excel.PivotItem; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.PivotItemCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.PivotItemCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PivotItemCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.PivotItemCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotItemCollection; - load(option?: string | string[]): Excel.PivotItemCollection; - load(option?: OfficeExtension.LoadOption): Excel.PivotItemCollection; + load(options?: Excel.Interfaces.PivotItemCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotItemCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PivotItemCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.PivotItemCollection; /** * 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.PivotItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.PivotItemCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -32598,7 +32606,7 @@ declare namespace Excel { */ class PivotItem extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Id of the PivotItem. @@ -32642,23 +32650,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.PivotItem): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.PivotItem` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.PivotItem` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PivotItem` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.PivotItemLoadOptions): Excel.PivotItem; - load(option?: string | string[]): Excel.PivotItem; - load(option?: { + load(options?: Excel.Interfaces.PivotItemLoadOptions): Excel.PivotItem; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PivotItem; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.PivotItem; @@ -32966,7 +32974,7 @@ declare namespace Excel { */ class DocumentProperties extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Gets the collection of custom properties of the workbook. Read only. @@ -33066,23 +33074,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.DocumentProperties): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.DocumentProperties` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.DocumentProperties` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.DocumentProperties` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.DocumentPropertiesLoadOptions): Excel.DocumentProperties; - load(option?: string | string[]): Excel.DocumentProperties; - load(option?: { + load(options?: Excel.Interfaces.DocumentPropertiesLoadOptions): Excel.DocumentProperties; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.DocumentProperties; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.DocumentProperties; @@ -33100,7 +33108,7 @@ declare namespace Excel { */ class CustomProperty extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Gets the key of the custom property. Read only. @@ -33144,23 +33152,23 @@ declare namespace Excel { */ delete(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.CustomProperty` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.CustomProperty` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.CustomProperty` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.CustomPropertyLoadOptions): Excel.CustomProperty; - load(option?: string | string[]): Excel.CustomProperty; - load(option?: { + load(options?: Excel.Interfaces.CustomPropertyLoadOptions): Excel.CustomProperty; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.CustomProperty; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.CustomProperty; @@ -33178,7 +33186,7 @@ declare namespace Excel { */ class CustomPropertyCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.CustomProperty[]; /** @@ -33224,23 +33232,23 @@ declare namespace Excel { */ getItemOrNullObject(key: string): Excel.CustomProperty; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.CustomPropertyCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.CustomPropertyCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.CustomPropertyCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.CustomPropertyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CustomPropertyCollection; - load(option?: string | string[]): Excel.CustomPropertyCollection; - load(option?: OfficeExtension.LoadOption): Excel.CustomPropertyCollection; + load(options?: Excel.Interfaces.CustomPropertyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CustomPropertyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.CustomPropertyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.CustomPropertyCollection; /** * 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.CustomPropertyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.CustomPropertyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -33255,7 +33263,7 @@ declare namespace Excel { */ class ConditionalFormatCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.ConditionalFormat[]; /** @@ -33310,23 +33318,23 @@ declare namespace Excel { */ getItemAt(index: number): Excel.ConditionalFormat; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ConditionalFormatCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ConditionalFormatCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ConditionalFormatCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ConditionalFormatCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ConditionalFormatCollection; - load(option?: string | string[]): Excel.ConditionalFormatCollection; - load(option?: OfficeExtension.LoadOption): Excel.ConditionalFormatCollection; + load(options?: Excel.Interfaces.ConditionalFormatCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ConditionalFormatCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ConditionalFormatCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ConditionalFormatCollection; /** * 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.ConditionalFormatCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ConditionalFormatCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -33336,13 +33344,13 @@ declare namespace Excel { /** * * An object encapsulating a conditional format's range, format, rule, and other properties. - * To learn more about the conditional formatting object model, read {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-conditional-formatting | Apply conditional formatting to Excel ranges}. + To learn more about the conditional formatting object model, read {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-conditional-formatting | Apply conditional formatting to Excel ranges}. * * [Api set: ExcelApi 1.6] */ class ConditionalFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns the cell value conditional format properties if the current conditional format is a CellValue type. @@ -33537,23 +33545,23 @@ declare namespace Excel { */ getRanges(): Excel.RangeAreas; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ConditionalFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ConditionalFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ConditionalFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ConditionalFormatLoadOptions): Excel.ConditionalFormat; - load(option?: string | string[]): Excel.ConditionalFormat; - load(option?: { + load(options?: Excel.Interfaces.ConditionalFormatLoadOptions): Excel.ConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ConditionalFormat; @@ -33571,7 +33579,7 @@ declare namespace Excel { */ class DataBarConditionalFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Representation of all values to the left of the axis in an Excel data bar. Read-only. @@ -33611,7 +33619,7 @@ declare namespace Excel { /** * * The rule for what consistutes the lower bound (and how to calculate it, if applicable) for a data bar. - * The `ConditionalDataBarRule` object must be set as a JSON object (use `x.lowerBoundRule = {...}` instead of `x.lowerBoundRule.formula = ...`). + The `ConditionalDataBarRule` object must be set as a JSON object (use `x.lowerBoundRule = {...}` instead of `x.lowerBoundRule.formula = ...`). * * [Api set: ExcelApi 1.6] */ @@ -33626,7 +33634,7 @@ declare namespace Excel { /** * * The rule for what constitutes the upper bound (and how to calculate it, if applicable) for a data bar. - * The `ConditionalDataBarRule` object must be set as a JSON object (use `x.upperBoundRule = {...}` instead of `x.upperBoundRule.formula = ...`). + The `ConditionalDataBarRule` object must be set as a JSON object (use `x.upperBoundRule = {...}` instead of `x.upperBoundRule.formula = ...`). * * [Api set: ExcelApi 1.6] */ @@ -33646,23 +33654,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.DataBarConditionalFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.DataBarConditionalFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.DataBarConditionalFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.DataBarConditionalFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.DataBarConditionalFormatLoadOptions): Excel.DataBarConditionalFormat; - load(option?: string | string[]): Excel.DataBarConditionalFormat; - load(option?: { + load(options?: Excel.Interfaces.DataBarConditionalFormatLoadOptions): Excel.DataBarConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.DataBarConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.DataBarConditionalFormat; @@ -33680,7 +33688,7 @@ declare namespace Excel { */ class ConditionalDataBarPositiveFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange"). @@ -33718,23 +33726,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ConditionalDataBarPositiveFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ConditionalDataBarPositiveFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ConditionalDataBarPositiveFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ConditionalDataBarPositiveFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ConditionalDataBarPositiveFormatLoadOptions): Excel.ConditionalDataBarPositiveFormat; - load(option?: string | string[]): Excel.ConditionalDataBarPositiveFormat; - load(option?: { + load(options?: Excel.Interfaces.ConditionalDataBarPositiveFormatLoadOptions): Excel.ConditionalDataBarPositiveFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ConditionalDataBarPositiveFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ConditionalDataBarPositiveFormat; @@ -33752,7 +33760,7 @@ declare namespace Excel { */ class ConditionalDataBarNegativeFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange"). @@ -33797,23 +33805,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ConditionalDataBarNegativeFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ConditionalDataBarNegativeFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ConditionalDataBarNegativeFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ConditionalDataBarNegativeFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ConditionalDataBarNegativeFormatLoadOptions): Excel.ConditionalDataBarNegativeFormat; - load(option?: string | string[]): Excel.ConditionalDataBarNegativeFormat; - load(option?: { + load(options?: Excel.Interfaces.ConditionalDataBarNegativeFormatLoadOptions): Excel.ConditionalDataBarNegativeFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ConditionalDataBarNegativeFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ConditionalDataBarNegativeFormat; @@ -33853,7 +33861,7 @@ declare namespace Excel { */ class CustomConditionalFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. Read-only. @@ -33883,23 +33891,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.CustomConditionalFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.CustomConditionalFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.CustomConditionalFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.CustomConditionalFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.CustomConditionalFormatLoadOptions): Excel.CustomConditionalFormat; - load(option?: string | string[]): Excel.CustomConditionalFormat; - load(option?: { + load(options?: Excel.Interfaces.CustomConditionalFormatLoadOptions): Excel.CustomConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.CustomConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.CustomConditionalFormat; @@ -33917,7 +33925,7 @@ declare namespace Excel { */ class ConditionalFormatRule extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * The formula, if required, to evaluate the conditional format rule on. @@ -33954,23 +33962,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ConditionalFormatRule): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ConditionalFormatRule` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ConditionalFormatRule` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ConditionalFormatRule` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ConditionalFormatRuleLoadOptions): Excel.ConditionalFormatRule; - load(option?: string | string[]): Excel.ConditionalFormatRule; - load(option?: { + load(options?: Excel.Interfaces.ConditionalFormatRuleLoadOptions): Excel.ConditionalFormatRule; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ConditionalFormatRule; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ConditionalFormatRule; @@ -33988,7 +33996,7 @@ declare namespace Excel { */ class IconSetConditionalFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * An array of Criteria and IconSets for the rules and potential custom icons for conditional icons. Note that for the first criterion only the custom icon can be modified, while type, formula, and operator will be ignored when set. @@ -34032,23 +34040,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.IconSetConditionalFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.IconSetConditionalFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.IconSetConditionalFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.IconSetConditionalFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.IconSetConditionalFormatLoadOptions): Excel.IconSetConditionalFormat; - load(option?: string | string[]): Excel.IconSetConditionalFormat; - load(option?: { + load(options?: Excel.Interfaces.IconSetConditionalFormatLoadOptions): Excel.IconSetConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.IconSetConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.IconSetConditionalFormat; @@ -34102,7 +34110,7 @@ declare namespace Excel { */ class ColorScaleConditionalFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * The criteria of the color scale. Midpoint is optional when using a two point color scale. @@ -34132,23 +34140,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ColorScaleConditionalFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ColorScaleConditionalFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ColorScaleConditionalFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ColorScaleConditionalFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ColorScaleConditionalFormatLoadOptions): Excel.ColorScaleConditionalFormat; - load(option?: string | string[]): Excel.ColorScaleConditionalFormat; - load(option?: { + load(options?: Excel.Interfaces.ColorScaleConditionalFormatLoadOptions): Excel.ColorScaleConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ColorScaleConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ColorScaleConditionalFormat; @@ -34224,7 +34232,7 @@ declare namespace Excel { */ class TopBottomConditionalFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. Read-only. @@ -34254,23 +34262,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.TopBottomConditionalFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.TopBottomConditionalFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.TopBottomConditionalFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.TopBottomConditionalFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.TopBottomConditionalFormatLoadOptions): Excel.TopBottomConditionalFormat; - load(option?: string | string[]): Excel.TopBottomConditionalFormat; - load(option?: { + load(options?: Excel.Interfaces.TopBottomConditionalFormatLoadOptions): Excel.TopBottomConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TopBottomConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.TopBottomConditionalFormat; @@ -34310,7 +34318,7 @@ declare namespace Excel { */ class PresetCriteriaConditionalFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. @@ -34340,23 +34348,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.PresetCriteriaConditionalFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.PresetCriteriaConditionalFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.PresetCriteriaConditionalFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PresetCriteriaConditionalFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.PresetCriteriaConditionalFormatLoadOptions): Excel.PresetCriteriaConditionalFormat; - load(option?: string | string[]): Excel.PresetCriteriaConditionalFormat; - load(option?: { + load(options?: Excel.Interfaces.PresetCriteriaConditionalFormatLoadOptions): Excel.PresetCriteriaConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PresetCriteriaConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.PresetCriteriaConditionalFormat; @@ -34389,7 +34397,7 @@ declare namespace Excel { */ class TextConditionalFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. Read-only. @@ -34419,23 +34427,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.TextConditionalFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.TextConditionalFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.TextConditionalFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.TextConditionalFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.TextConditionalFormatLoadOptions): Excel.TextConditionalFormat; - load(option?: string | string[]): Excel.TextConditionalFormat; - load(option?: { + load(options?: Excel.Interfaces.TextConditionalFormatLoadOptions): Excel.TextConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TextConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.TextConditionalFormat; @@ -34475,7 +34483,7 @@ declare namespace Excel { */ class CellValueConditionalFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. @@ -34505,23 +34513,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.CellValueConditionalFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.CellValueConditionalFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.CellValueConditionalFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.CellValueConditionalFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.CellValueConditionalFormatLoadOptions): Excel.CellValueConditionalFormat; - load(option?: string | string[]): Excel.CellValueConditionalFormat; - load(option?: { + load(options?: Excel.Interfaces.CellValueConditionalFormatLoadOptions): Excel.CellValueConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.CellValueConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.CellValueConditionalFormat; @@ -34568,7 +34576,7 @@ declare namespace Excel { */ class ConditionalRangeFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Collection of border objects that apply to the overall conditional format range. Read-only. @@ -34612,23 +34620,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ConditionalRangeFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ConditionalRangeFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ConditionalRangeFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ConditionalRangeFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ConditionalRangeFormatLoadOptions): Excel.ConditionalRangeFormat; - load(option?: string | string[]): Excel.ConditionalRangeFormat; - load(option?: { + load(options?: Excel.Interfaces.ConditionalRangeFormatLoadOptions): Excel.ConditionalRangeFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ConditionalRangeFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ConditionalRangeFormat; @@ -34646,7 +34654,7 @@ declare namespace Excel { */ class ConditionalRangeFont extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the bold status of font. @@ -34704,23 +34712,23 @@ declare namespace Excel { */ clear(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ConditionalRangeFont` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ConditionalRangeFont` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ConditionalRangeFont` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ConditionalRangeFontLoadOptions): Excel.ConditionalRangeFont; - load(option?: string | string[]): Excel.ConditionalRangeFont; - load(option?: { + load(options?: Excel.Interfaces.ConditionalRangeFontLoadOptions): Excel.ConditionalRangeFont; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ConditionalRangeFont; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ConditionalRangeFont; @@ -34738,7 +34746,7 @@ declare namespace Excel { */ class ConditionalRangeFill extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * HTML color code representing the color of the fill, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange"). @@ -34768,23 +34776,23 @@ declare namespace Excel { */ clear(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ConditionalRangeFill` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ConditionalRangeFill` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ConditionalRangeFill` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ConditionalRangeFillLoadOptions): Excel.ConditionalRangeFill; - load(option?: string | string[]): Excel.ConditionalRangeFill; - load(option?: { + load(options?: Excel.Interfaces.ConditionalRangeFillLoadOptions): Excel.ConditionalRangeFill; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ConditionalRangeFill; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ConditionalRangeFill; @@ -34802,7 +34810,7 @@ declare namespace Excel { */ class ConditionalRangeBorder extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange"). @@ -34839,23 +34847,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ConditionalRangeBorder): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ConditionalRangeBorder` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ConditionalRangeBorder` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ConditionalRangeBorder` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ConditionalRangeBorderLoadOptions): Excel.ConditionalRangeBorder; - load(option?: string | string[]): Excel.ConditionalRangeBorder; - load(option?: { + load(options?: Excel.Interfaces.ConditionalRangeBorderLoadOptions): Excel.ConditionalRangeBorder; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ConditionalRangeBorder; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ConditionalRangeBorder; @@ -34873,7 +34881,7 @@ declare namespace Excel { */ class ConditionalRangeBorderCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Gets the bottom border. Read-only. @@ -34939,23 +34947,23 @@ declare namespace Excel { */ getItemAt(index: number): Excel.ConditionalRangeBorder; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ConditionalRangeBorderCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ConditionalRangeBorderCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ConditionalRangeBorderCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ConditionalRangeBorderCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ConditionalRangeBorderCollection; - load(option?: string | string[]): Excel.ConditionalRangeBorderCollection; - load(option?: OfficeExtension.LoadOption): Excel.ConditionalRangeBorderCollection; + load(options?: Excel.Interfaces.ConditionalRangeBorderCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ConditionalRangeBorderCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ConditionalRangeBorderCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ConditionalRangeBorderCollection; /** * 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.ConditionalRangeBorderCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ConditionalRangeBorderCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -34970,7 +34978,7 @@ declare namespace Excel { */ class Style extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * A Border collection of four Border objects that represent the style of the four borders. @@ -35154,23 +35162,23 @@ declare namespace Excel { */ delete(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.Style` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.Style` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Style` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.StyleLoadOptions): Excel.Style; - load(option?: string | string[]): Excel.Style; - load(option?: { + load(options?: Excel.Interfaces.StyleLoadOptions): Excel.Style; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Style; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.Style; @@ -35188,7 +35196,7 @@ declare namespace Excel { */ class StyleCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.Style[]; /** @@ -35226,23 +35234,23 @@ declare namespace Excel { */ getItemAt(index: number): Excel.Style; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.StyleCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.StyleCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.StyleCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.StyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.StyleCollection; - load(option?: string | string[]): Excel.StyleCollection; - load(option?: OfficeExtension.LoadOption): Excel.StyleCollection; + load(options?: Excel.Interfaces.StyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.StyleCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.StyleCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.StyleCollection; /** * 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.StyleCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.StyleCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -35258,7 +35266,7 @@ declare namespace Excel { */ class TableStyleCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.TableStyle[]; /** @@ -35323,23 +35331,23 @@ declare namespace Excel { */ setDefault(newDefaultStyle: TableStyle | string): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.TableStyleCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.TableStyleCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.TableStyleCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.TableStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableStyleCollection; - load(option?: string | string[]): Excel.TableStyleCollection; - load(option?: OfficeExtension.LoadOption): Excel.TableStyleCollection; + load(options?: Excel.Interfaces.TableStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableStyleCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TableStyleCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.TableStyleCollection; /** * 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.TableStyleCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.TableStyleCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -35355,7 +35363,7 @@ declare namespace Excel { */ class TableStyle extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Gets the name of the TableStyle. @@ -35404,23 +35412,23 @@ declare namespace Excel { */ duplicate(): Excel.TableStyle; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.TableStyle` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.TableStyle` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.TableStyle` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.TableStyleLoadOptions): Excel.TableStyle; - load(option?: string | string[]): Excel.TableStyle; - load(option?: { + load(options?: Excel.Interfaces.TableStyleLoadOptions): Excel.TableStyle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TableStyle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.TableStyle; @@ -35439,7 +35447,7 @@ declare namespace Excel { */ class PivotTableStyleCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.PivotTableStyle[]; /** @@ -35504,23 +35512,23 @@ declare namespace Excel { */ setDefault(newDefaultStyle: PivotTableStyle | string): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.PivotTableStyleCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.PivotTableStyleCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PivotTableStyleCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.PivotTableStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotTableStyleCollection; - load(option?: string | string[]): Excel.PivotTableStyleCollection; - load(option?: OfficeExtension.LoadOption): Excel.PivotTableStyleCollection; + load(options?: Excel.Interfaces.PivotTableStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotTableStyleCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PivotTableStyleCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.PivotTableStyleCollection; /** * 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.PivotTableStyleCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.PivotTableStyleCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -35536,7 +35544,7 @@ declare namespace Excel { */ class PivotTableStyle extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Gets the name of the PivotTableStyle. @@ -35585,23 +35593,23 @@ declare namespace Excel { */ duplicate(): Excel.PivotTableStyle; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.PivotTableStyle` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.PivotTableStyle` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PivotTableStyle` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.PivotTableStyleLoadOptions): Excel.PivotTableStyle; - load(option?: string | string[]): Excel.PivotTableStyle; - load(option?: { + load(options?: Excel.Interfaces.PivotTableStyleLoadOptions): Excel.PivotTableStyle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PivotTableStyle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.PivotTableStyle; @@ -35620,7 +35628,7 @@ declare namespace Excel { */ class SlicerStyleCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.SlicerStyle[]; /** @@ -35685,23 +35693,23 @@ declare namespace Excel { */ setDefault(newDefaultStyle: SlicerStyle | string): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.SlicerStyleCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.SlicerStyleCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.SlicerStyleCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.SlicerStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SlicerStyleCollection; - load(option?: string | string[]): Excel.SlicerStyleCollection; - load(option?: OfficeExtension.LoadOption): Excel.SlicerStyleCollection; + load(options?: Excel.Interfaces.SlicerStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SlicerStyleCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.SlicerStyleCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.SlicerStyleCollection; /** * 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.SlicerStyleCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.SlicerStyleCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -35717,7 +35725,7 @@ declare namespace Excel { */ class SlicerStyle extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Gets the name of the SlicerStyle. @@ -35766,23 +35774,23 @@ declare namespace Excel { */ duplicate(): Excel.SlicerStyle; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.SlicerStyle` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.SlicerStyle` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.SlicerStyle` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.SlicerStyleLoadOptions): Excel.SlicerStyle; - load(option?: string | string[]): Excel.SlicerStyle; - load(option?: { + load(options?: Excel.Interfaces.SlicerStyleLoadOptions): Excel.SlicerStyle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.SlicerStyle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.SlicerStyle; @@ -35801,7 +35809,7 @@ declare namespace Excel { */ class TimelineStyleCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.TimelineStyle[]; /** @@ -35866,23 +35874,23 @@ declare namespace Excel { */ setDefault(newDefaultStyle: TimelineStyle | string): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.TimelineStyleCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.TimelineStyleCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.TimelineStyleCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.TimelineStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TimelineStyleCollection; - load(option?: string | string[]): Excel.TimelineStyleCollection; - load(option?: OfficeExtension.LoadOption): Excel.TimelineStyleCollection; + load(options?: Excel.Interfaces.TimelineStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TimelineStyleCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TimelineStyleCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.TimelineStyleCollection; /** * 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.TimelineStyleCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.TimelineStyleCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -35898,7 +35906,7 @@ declare namespace Excel { */ class TimelineStyle extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Gets the name of the TimelineStyle. @@ -35947,23 +35955,23 @@ declare namespace Excel { */ duplicate(): Excel.TimelineStyle; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.TimelineStyle` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.TimelineStyle` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.TimelineStyle` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.TimelineStyleLoadOptions): Excel.TimelineStyle; - load(option?: string | string[]): Excel.TimelineStyle; - load(option?: { + load(options?: Excel.Interfaces.TimelineStyleLoadOptions): Excel.TimelineStyle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TimelineStyle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.TimelineStyle; @@ -35974,11 +35982,14 @@ declare namespace Excel { toJSON(): Excel.Interfaces.TimelineStyleData; } /** + * + * Represents layout and print settings that are not dependent any printer-specific implementation. These settings include margins, orientation, page numbering, title rows, and print area. + * * [Api set: ExcelApi 1.9] */ class PageLayout extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Header and footer configuration for the worksheet. @@ -36115,7 +36126,7 @@ declare namespace Excel { /** * * Gets or sets the worksheet's print zoom options. - * The `PageLayoutZoomOptions` object must be set as a JSON object (use `x.zoom = {...}` instead of `x.zoom.scale = ...`). + The `PageLayoutZoomOptions` object must be set as a JSON object (use `x.zoom = {...}` instead of `x.zoom.scale = ...`). * * [Api set: ExcelApi 1.9] */ @@ -36224,23 +36235,23 @@ declare namespace Excel { */ setPrintTitleRows(printTitleRows: Range | string): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.PageLayout` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.PageLayout` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PageLayout` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.PageLayoutLoadOptions): Excel.PageLayout; - load(option?: string | string[]): Excel.PageLayout; - load(option?: { + load(options?: Excel.Interfaces.PageLayoutLoadOptions): Excel.PageLayout; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PageLayout; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.PageLayout; @@ -36334,7 +36345,7 @@ declare namespace Excel { */ class HeaderFooter extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Gets or sets the center footer of the worksheet. @@ -36398,23 +36409,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.HeaderFooter): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.HeaderFooter` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.HeaderFooter` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.HeaderFooter` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.HeaderFooterLoadOptions): Excel.HeaderFooter; - load(option?: string | string[]): Excel.HeaderFooter; - load(option?: { + load(options?: Excel.Interfaces.HeaderFooterLoadOptions): Excel.HeaderFooter; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.HeaderFooter; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.HeaderFooter; @@ -36429,7 +36440,7 @@ declare namespace Excel { */ class HeaderFooterGroup extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * The general header/footer, used for all pages unless even/odd or first page is specified. @@ -36494,23 +36505,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.HeaderFooterGroup): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.HeaderFooterGroup` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.HeaderFooterGroup` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.HeaderFooterGroup` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.HeaderFooterGroupLoadOptions): Excel.HeaderFooterGroup; - load(option?: string | string[]): Excel.HeaderFooterGroup; - load(option?: { + load(options?: Excel.Interfaces.HeaderFooterGroupLoadOptions): Excel.HeaderFooterGroup; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.HeaderFooterGroup; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.HeaderFooterGroup; @@ -36525,7 +36536,7 @@ declare namespace Excel { */ class PageBreak extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the column index for the page break @@ -36555,23 +36566,23 @@ declare namespace Excel { */ getCellAfterBreak(): Excel.Range; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.PageBreak` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.PageBreak` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PageBreak` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.PageBreakLoadOptions): Excel.PageBreak; - load(option?: string | string[]): Excel.PageBreak; - load(option?: { + load(options?: Excel.Interfaces.PageBreakLoadOptions): Excel.PageBreak; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PageBreak; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.PageBreak; @@ -36586,7 +36597,7 @@ declare namespace Excel { */ class PageBreakCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.PageBreak[]; /** @@ -36622,23 +36633,23 @@ declare namespace Excel { */ removePageBreaks(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.PageBreakCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.PageBreakCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PageBreakCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.PageBreakCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PageBreakCollection; - load(option?: string | string[]): Excel.PageBreakCollection; - load(option?: OfficeExtension.LoadOption): Excel.PageBreakCollection; + load(options?: Excel.Interfaces.PageBreakCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PageBreakCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PageBreakCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.PageBreakCollection; /** * 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.PageBreakCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.PageBreakCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -36653,7 +36664,7 @@ declare namespace Excel { */ class DataConnectionCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Refreshes all the Data Connections in the collection. @@ -36674,7 +36685,7 @@ declare namespace Excel { */ class RangeCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.Range[]; /** @@ -36694,29 +36705,80 @@ declare namespace Excel { */ getItemAt(index: number): Excel.Range; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.RangeCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.RangeCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.RangeCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.RangeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.RangeCollection; - load(option?: string | string[]): Excel.RangeCollection; - load(option?: OfficeExtension.LoadOption): Excel.RangeCollection; + load(options?: Excel.Interfaces.RangeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.RangeCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.RangeCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.RangeCollection; /** * 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.RangeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.RangeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ toJSON(): Excel.Interfaces.RangeCollectionData; } + /** + * + * Represents the entity that is mentioned in comments. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + interface CommentMention { + /** + * + * Gets or sets the email address of the entity that is mentioned in comment. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + email: string; + /** + * + * Gets or sets the id of the entity. This is aligned with the id information in `CommentRichContent.richContent`. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + id: number; + /** + * + * Gets or sets the name of the entity that is mentioned in comment. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + name: string; + } + /** + * + * Represents the content contained within a comment or comment reply. Rich content incudes the text string and any other objects contained within the comment body, such as mentions. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + interface CommentRichContent { + /** + * + * An array containing all the entities (e.g. people) mentioned within the comment. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + mentions?: Excel.CommentMention[]; + richContent: string; + } /** * * Represents a collection of comment objects that are part of the workbook. @@ -36726,33 +36788,33 @@ declare namespace Excel { */ class CommentCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.Comment[]; /** * - * Creates a new comment (comment thread) with the given content on the given cell. An `InvalidArgument` error is thrown if the provided range is larger than one cell. + * Creates a new comment with the given content on the given cell. An `InvalidArgument` error is thrown if the provided range is larger than one cell. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta * - * @param content The comment content. * @param cellAddress The cell to which the comment is added. This can be a Range object or a string. If it's a string, it must contain the full address, including the sheet name. An `InvalidArgument` error is thrown if the provided range is larger than one cell. - * @param contentType Optional. The type of the comment content + * @param content The comment's content. This can be either a string or CommentRichContent object. Strings are used for plain text. CommentRichContent objects allow for other comment features, such as mentions. [Api set: ExcelApi BETA (PREVIEW ONLY) for string, ExcelApi Preview for CommentRichContent object] + * @param contentType Optional. The type of content contained within the comment. The default value is enum `ContentType.plain`. */ - add(content: string, cellAddress: Range | string, contentType?: Excel.ContentType): Excel.Comment; + add(cellAddress: Range | string, content: CommentRichContent | string, contentType?: Excel.ContentType): Excel.Comment; /** * - * Creates a new comment (comment thread) with the given content on the given cell. An `InvalidArgument` error is thrown if the provided range is larger than one cell. + * Creates a new comment with the given content on the given cell. An `InvalidArgument` error is thrown if the provided range is larger than one cell. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta * - * @param content The comment content. * @param cellAddress The cell to which the comment is added. This can be a Range object or a string. If it's a string, it must contain the full address, including the sheet name. An `InvalidArgument` error is thrown if the provided range is larger than one cell. - * @param contentType Optional. The type of the comment content + * @param content The comment's content. This can be either a string or CommentRichContent object. Strings are used for plain text. CommentRichContent objects allow for other comment features, such as mentions. [Api set: ExcelApi BETA (PREVIEW ONLY) for string, ExcelApi Preview for CommentRichContent object] + * @param contentType Optional. The type of content contained within the comment. The default value is enum `ContentType.plain`. */ - add(content: string, cellAddress: Range | string, contentType?: "Plain"): Excel.Comment; + add(cellAddress: Range | string, content: CommentRichContent | string, contentType?: "Plain" | "Mention"): Excel.Comment; /** * * Gets the number of comments in the collection. @@ -36783,7 +36845,7 @@ declare namespace Excel { getItemAt(index: number): Excel.Comment; /** * - * Gets the comment from the specifed cell. + * Gets the comment from the specified cell. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -36793,7 +36855,7 @@ declare namespace Excel { getItemByCell(cellAddress: Range | string): Excel.Comment; /** * - * Gets a comment related to its reply ID in the collection. + * Gets the comment to which the given reply is connected. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -36802,23 +36864,23 @@ declare namespace Excel { */ getItemByReplyId(replyId: string): Excel.Comment; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.CommentCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.CommentCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.CommentCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.CommentCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CommentCollection; - load(option?: string | string[]): Excel.CommentCollection; - load(option?: OfficeExtension.LoadOption): Excel.CommentCollection; + load(options?: Excel.Interfaces.CommentCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CommentCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.CommentCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.CommentCollection; /** * 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.CommentCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.CommentCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -36827,14 +36889,14 @@ declare namespace Excel { } /** * - * Represents a cell comment object in the workbook. + * Represents a comment in the workbook. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta */ class Comment extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents a collection of reply objects associated with the comment. Read-only. @@ -36883,6 +36945,14 @@ declare namespace Excel { * @beta */ readonly id: string; + /** + * + * Gets the entities (e.g. people) that are mentioned in comments. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly mentions: Excel.CommentMention[]; /** * * Gets or sets the comment thread status. A value of "true" means the comment thread is in the resolved state. @@ -36891,6 +36961,14 @@ declare namespace Excel { * @beta */ resolved: boolean; + /** + * + * Gets the rich comment content (e.g. mentions in comments). This string is not meant to be displayed to end-users. Your add-in should only use this to parse rich comment content. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly richContent: string; /** Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. * * @remarks @@ -36907,7 +36985,7 @@ declare namespace Excel { set(properties: Excel.Comment): void; /** * - * Deletes the comment thread. + * Deletes the comment and all the connected replies. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -36922,23 +37000,33 @@ declare namespace Excel { */ getLocation(): Excel.Range; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. * - * @remarks + * Updates the comment content with a specially formatted string and a list of mentions. * - * In addition to this signature, this method has the following signatures: + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta * - * `load(option?: string | string[]): Excel.Comment` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.Comment` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Comment` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * @param contentWithMentions The content for the comment. This contains a specially formatted string and a list of mentions that will be parsed into the string when displayed by Excel. + */ + updateMentions(contentWithMentions: Excel.CommentRichContent): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.CommentLoadOptions): Excel.Comment; - load(option?: string | string[]): Excel.Comment; - load(option?: { + load(options?: Excel.Interfaces.CommentLoadOptions): Excel.Comment; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Comment; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.Comment; @@ -36957,7 +37045,7 @@ declare namespace Excel { */ class CommentReplyCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.CommentReply[]; /** @@ -36967,10 +37055,10 @@ declare namespace Excel { * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta * - * @param content The comment content. - * @param contentType Optional. Type of the comment content + * @param content The comment's content. This can be either a string or Interface CommentRichContent (e.g. for comments with mentions). [Api set: ExcelApi BETA (PREVIEW ONLY) for string, ExcelApi Preview for CommentRichContent object] + * @param contentType Optional. The type of content contained within the comment. The default value is enum `ContentType.plain`. */ - add(content: string, contentType?: Excel.ContentType): Excel.CommentReply; + add(content: CommentRichContent | string, contentType?: Excel.ContentType): Excel.CommentReply; /** * * Creates a comment reply for comment. @@ -36978,10 +37066,10 @@ declare namespace Excel { * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta * - * @param content The comment content. - * @param contentType Optional. Type of the comment content + * @param content The comment's content. This can be either a string or Interface CommentRichContent (e.g. for comments with mentions). [Api set: ExcelApi BETA (PREVIEW ONLY) for string, ExcelApi Preview for CommentRichContent object] + * @param contentType Optional. The type of content contained within the comment. The default value is enum `ContentType.plain`. */ - add(content: string, contentType?: "Plain"): Excel.CommentReply; + add(content: CommentRichContent | string, contentType?: "Plain" | "Mention"): Excel.CommentReply; /** * * Gets the number of comment replies in the collection. @@ -37007,27 +37095,27 @@ declare namespace Excel { * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta * - * @param index Index value of the object to be retrieved. Zero-indexed. + * @param index The index value of the comment reply to be retrieved. The collection uses zero-based indexing. */ getItemAt(index: number): Excel.CommentReply; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.CommentReplyCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.CommentReplyCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.CommentReplyCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.CommentReplyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CommentReplyCollection; - load(option?: string | string[]): Excel.CommentReplyCollection; - load(option?: OfficeExtension.LoadOption): Excel.CommentReplyCollection; + load(options?: Excel.Interfaces.CommentReplyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CommentReplyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.CommentReplyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.CommentReplyCollection; /** * 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.CommentReplyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.CommentReplyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -37036,14 +37124,14 @@ declare namespace Excel { } /** * - * Represents a cell comment reply object in the workbook. + * Represents a comment reply in the workbook. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta */ class CommentReply extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Gets the email of the comment reply's author. @@ -37084,6 +37172,14 @@ declare namespace Excel { * @beta */ readonly id: string; + /** + * + * Gets the entities (e.g. people) that are mentioned in comments. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly mentions: Excel.CommentMention[]; /** * * Gets or sets the comment reply status. A value of "true" means the comment reply is in the resolved state. @@ -37092,6 +37188,14 @@ declare namespace Excel { * @beta */ readonly resolved: boolean; + /** + * + * Gets the rich comment content (e.g. mentions in comments). This string is not meant to be displayed to end-users. Your add-in should only use this to parse rich comment content. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly richContent: string; /** Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. * * @remarks @@ -37131,23 +37235,33 @@ declare namespace Excel { */ getParentComment(): Excel.Comment; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. * - * @remarks + * Updates the comment content with a specially formatted string and a list of mentions. * - * In addition to this signature, this method has the following signatures: + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta * - * `load(option?: string | string[]): Excel.CommentReply` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.CommentReply` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.CommentReply` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * @param contentWithMentions The content for the comment. This contains a specially formatted string and a list of mentions that will be parsed into the string when displayed by Excel. + */ + updateMentions(contentWithMentions: Excel.CommentRichContent): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.CommentReplyLoadOptions): Excel.CommentReply; - load(option?: string | string[]): Excel.CommentReply; - load(option?: { + load(options?: Excel.Interfaces.CommentReplyLoadOptions): Excel.CommentReply; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.CommentReply; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.CommentReply; @@ -37165,7 +37279,7 @@ declare namespace Excel { */ class ShapeCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.Shape[]; /** @@ -37275,23 +37389,23 @@ declare namespace Excel { */ getItemAt(index: number): Excel.Shape; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ShapeCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ShapeCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ShapeCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ShapeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ShapeCollection; - load(option?: string | string[]): Excel.ShapeCollection; - load(option?: OfficeExtension.LoadOption): Excel.ShapeCollection; + load(options?: Excel.Interfaces.ShapeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ShapeCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ShapeCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ShapeCollection; /** * 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.ShapeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ShapeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -37301,13 +37415,13 @@ declare namespace Excel { /** * * Represents a generic shape object in the worksheet. A shape could be a geometric shape, a line, a group of shapes, etc. - * To learn more about the shape object model, read {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-shapes | Work with shapes using the Excel JavaScript API}. + To learn more about the shape object model, read {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-shapes | Work with shapes using the Excel JavaScript API}. * * [Api set: ExcelApi 1.9] */ class Shape extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns the fill formatting of this shape. Read-only. @@ -37629,23 +37743,23 @@ declare namespace Excel { */ setZOrder(position: "BringToFront" | "BringForward" | "SendToBack" | "SendBackward"): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.Shape` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.Shape` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Shape` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ShapeLoadOptions): Excel.Shape; - load(option?: string | string[]): Excel.Shape; - load(option?: { + load(options?: Excel.Interfaces.ShapeLoadOptions): Excel.Shape; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Shape; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.Shape; @@ -37681,7 +37795,7 @@ declare namespace Excel { */ class GeometricShape extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns the Shape object for the geometric shape. Read-only. @@ -37697,23 +37811,23 @@ declare namespace Excel { */ readonly id: string; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.GeometricShape` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.GeometricShape` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.GeometricShape` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.GeometricShapeLoadOptions): Excel.GeometricShape; - load(option?: string | string[]): Excel.GeometricShape; - load(option?: { + load(options?: Excel.Interfaces.GeometricShapeLoadOptions): Excel.GeometricShape; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.GeometricShape; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.GeometricShape; @@ -37731,7 +37845,7 @@ declare namespace Excel { */ class Image extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns the Shape object associated with the image. Read-only. @@ -37754,23 +37868,23 @@ declare namespace Excel { */ readonly format: Excel.PictureFormat | "UNKNOWN" | "BMP" | "JPEG" | "GIF" | "PNG" | "SVG"; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.Image` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.Image` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Image` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ImageLoadOptions): Excel.Image; - load(option?: string | string[]): Excel.Image; - load(option?: { + load(options?: Excel.Interfaces.ImageLoadOptions): Excel.Image; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Image; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.Image; @@ -37788,7 +37902,7 @@ declare namespace Excel { */ class ShapeGroup extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns the Shape object associated with the group. Read-only. @@ -37818,23 +37932,23 @@ declare namespace Excel { */ ungroup(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ShapeGroup` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ShapeGroup` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ShapeGroup` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ShapeGroupLoadOptions): Excel.ShapeGroup; - load(option?: string | string[]): Excel.ShapeGroup; - load(option?: { + load(options?: Excel.Interfaces.ShapeGroupLoadOptions): Excel.ShapeGroup; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ShapeGroup; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ShapeGroup; @@ -37852,7 +37966,7 @@ declare namespace Excel { */ class GroupShapeCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.Shape[]; /** @@ -37881,23 +37995,23 @@ declare namespace Excel { */ getItemAt(index: number): Excel.Shape; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.GroupShapeCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.GroupShapeCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.GroupShapeCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.GroupShapeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.GroupShapeCollection; - load(option?: string | string[]): Excel.GroupShapeCollection; - load(option?: OfficeExtension.LoadOption): Excel.GroupShapeCollection; + load(options?: Excel.Interfaces.GroupShapeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.GroupShapeCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.GroupShapeCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.GroupShapeCollection; /** * 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.GroupShapeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.GroupShapeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -37912,7 +38026,7 @@ declare namespace Excel { */ class Line extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the shape to which the beginning of the specified line is attached. Read-only. @@ -38067,23 +38181,23 @@ declare namespace Excel { */ disconnectEndShape(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.Line` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.Line` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Line` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.LineLoadOptions): Excel.Line; - load(option?: string | string[]): Excel.Line; - load(option?: { + load(options?: Excel.Interfaces.LineLoadOptions): Excel.Line; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Line; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.Line; @@ -38101,7 +38215,7 @@ declare namespace Excel { */ class ShapeFill extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the shape fill foreground color in HTML color format, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange") @@ -38154,23 +38268,23 @@ declare namespace Excel { */ setSolidColor(color: string): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ShapeFill` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ShapeFill` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ShapeFill` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ShapeFillLoadOptions): Excel.ShapeFill; - load(option?: string | string[]): Excel.ShapeFill; - load(option?: { + load(options?: Excel.Interfaces.ShapeFillLoadOptions): Excel.ShapeFill; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ShapeFill; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ShapeFill; @@ -38188,7 +38302,7 @@ declare namespace Excel { */ class ShapeLineFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the line color in HTML color format, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange"). @@ -38246,23 +38360,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ShapeLineFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ShapeLineFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ShapeLineFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ShapeLineFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ShapeLineFormatLoadOptions): Excel.ShapeLineFormat; - load(option?: string | string[]): Excel.ShapeLineFormat; - load(option?: { + load(options?: Excel.Interfaces.ShapeLineFormatLoadOptions): Excel.ShapeLineFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ShapeLineFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ShapeLineFormat; @@ -38280,7 +38394,7 @@ declare namespace Excel { */ class TextFrame extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the text that is attached to a shape in the text frame, and properties and methods for manipulating the text. See Excel.TextRange for details. @@ -38394,23 +38508,23 @@ declare namespace Excel { */ deleteText(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.TextFrame` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.TextFrame` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.TextFrame` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.TextFrameLoadOptions): Excel.TextFrame; - load(option?: string | string[]): Excel.TextFrame; - load(option?: { + load(options?: Excel.Interfaces.TextFrameLoadOptions): Excel.TextFrame; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TextFrame; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.TextFrame; @@ -38428,7 +38542,7 @@ declare namespace Excel { */ class TextRange extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns a ShapeFont object that represents the font attributes for the text range. Read-only. @@ -38468,23 +38582,23 @@ declare namespace Excel { */ getSubstring(start: number, length?: number): Excel.TextRange; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.TextRange` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.TextRange` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.TextRange` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.TextRangeLoadOptions): Excel.TextRange; - load(option?: string | string[]): Excel.TextRange; - load(option?: { + load(options?: Excel.Interfaces.TextRangeLoadOptions): Excel.TextRange; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TextRange; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.TextRange; @@ -38502,7 +38616,7 @@ declare namespace Excel { */ class ShapeFont extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the bold status of font. Returns null the TextRange includes both bold and non-bold text fragments. @@ -38560,23 +38674,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ShapeFont): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ShapeFont` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ShapeFont` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ShapeFont` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ShapeFontLoadOptions): Excel.ShapeFont; - load(option?: string | string[]): Excel.ShapeFont; - load(option?: { + load(options?: Excel.Interfaces.ShapeFontLoadOptions): Excel.ShapeFont; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ShapeFont; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ShapeFont; @@ -38595,7 +38709,7 @@ declare namespace Excel { */ class Slicer extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the collection of SlicerItems that are part of the slicer. Read-only. @@ -38623,7 +38737,7 @@ declare namespace Excel { /** * * Represents the height, in points, of the slicer. - Throws an invalid argument exception when set with negative value or zero as input. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value or zero as input. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -38648,7 +38762,7 @@ declare namespace Excel { /** * * Represents the distance, in points, from the left side of the slicer to the left of the worksheet. - Throws an invalid argument exception when set with negative value as input. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value as input. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -38672,7 +38786,7 @@ declare namespace Excel { nameInFormula: string; /** * - * Represents the sort order of the items in the slicer. Possible values are: DataSourceOrder, Ascending, Descending. + * Represents the sort order of the items in the slicer. Possible values are: "DataSourceOrder", "Ascending", "Descending". * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -38689,7 +38803,7 @@ declare namespace Excel { /** * * Represents the distance, in points, from the top edge of the slicer to the top of the worksheet. - Throws an invalid argument exception when set with negative value as input. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value as input. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -38698,7 +38812,7 @@ declare namespace Excel { /** * * Represents the width, in points, of the slicer. - Throws an invalid argument exception when set with negative value or zero as input. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value or zero as input. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -38744,7 +38858,7 @@ declare namespace Excel { getSelectedItems(): OfficeExtension.ClientResult; /** * - * Select slicer items based on their keys. Previous selection will be cleared. + * Selects slicer items based on their keys. The previous selections are cleared. All items will be selected by default if the array is empty. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] @@ -38754,23 +38868,23 @@ declare namespace Excel { */ selectItems(items?: string[]): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.Slicer` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.Slicer` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Slicer` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.SlicerLoadOptions): Excel.Slicer; - load(option?: string | string[]): Excel.Slicer; - load(option?: { + load(options?: Excel.Interfaces.SlicerLoadOptions): Excel.Slicer; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Slicer; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.Slicer; @@ -38789,7 +38903,7 @@ declare namespace Excel { */ class SlicerCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.Slicer[]; /** @@ -38844,23 +38958,23 @@ declare namespace Excel { */ getItemOrNullObject(key: string): Excel.Slicer; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.SlicerCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.SlicerCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.SlicerCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.SlicerCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SlicerCollection; - load(option?: string | string[]): Excel.SlicerCollection; - load(option?: OfficeExtension.LoadOption): Excel.SlicerCollection; + load(options?: Excel.Interfaces.SlicerCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SlicerCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.SlicerCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.SlicerCollection; /** * 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.SlicerCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.SlicerCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -38876,7 +38990,7 @@ declare namespace Excel { */ class SlicerItem extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * True if the slicer item has data. @@ -38926,23 +39040,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.SlicerItem): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.SlicerItem` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.SlicerItem` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.SlicerItem` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.SlicerItemLoadOptions): Excel.SlicerItem; - load(option?: string | string[]): Excel.SlicerItem; - load(option?: { + load(options?: Excel.Interfaces.SlicerItemLoadOptions): Excel.SlicerItem; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.SlicerItem; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.SlicerItem; @@ -38961,7 +39075,7 @@ declare namespace Excel { */ class SlicerItemCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.SlicerItem[]; /** @@ -39003,23 +39117,23 @@ declare namespace Excel { */ getItemOrNullObject(key: string): Excel.SlicerItem; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.SlicerItemCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.SlicerItemCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.SlicerItemCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.SlicerItemCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SlicerItemCollection; - load(option?: string | string[]): Excel.SlicerItemCollection; - load(option?: OfficeExtension.LoadOption): Excel.SlicerItemCollection; + load(options?: Excel.Interfaces.SlicerItemCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SlicerItemCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.SlicerItemCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.SlicerItemCollection; /** * 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.SlicerItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.SlicerItemCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -41420,7 +41534,13 @@ declare namespace Excel { * Indicates plain format type of the comment content. * */ - plain = "Plain" + plain = "Plain", + /** + * + * Comment content containing mentions. + * + */ + mention = "Mention" } /** * [Api set: ExcelApi 1.9] @@ -41786,12 +41906,30 @@ declare namespace Excel { prompt = "Prompt" } /** + * + * Specifies the slicer sort behavior for Slicer.sortBy API. + * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta */ enum SlicerSortType { + /** + * + * Sort slicer items in the order provided by the data source. + * + */ dataSourceOrder = "DataSourceOrder", + /** + * + * Sort slicer items in ascending order by item captions. + * + */ ascending = "Ascending", + /** + * + * Sort slicer items in descending order by item captions. + * + */ descending = "Descending" } /** @@ -41819,7 +41957,7 @@ declare namespace Excel { */ class FunctionResult extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Error value (such as "#DIV/0") representing the error. If the error string is not set, then the function succeeded, and its result is written to the Value field. The error is always in the English locale. @@ -41835,23 +41973,23 @@ declare namespace Excel { */ readonly value: T; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): FunctionResult` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): FunctionResult` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): FunctionResult` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.FunctionResultLoadOptions): FunctionResult; - load(option?: string | string[]): FunctionResult; - load(option?: { + load(options?: Excel.Interfaces.FunctionResultLoadOptions): FunctionResult; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): FunctionResult; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): FunctionResult; @@ -41869,7 +42007,7 @@ declare namespace Excel { */ class Functions extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns the absolute value of a number, a number without its sign. @@ -45629,6 +45767,7 @@ declare namespace Excel { itemNotFound = "ItemNotFound", nonBlankCellOffSheet = "NonBlankCellOffSheet", notImplemented = "NotImplemented", + rangeExceedsLimit = "RangeExceedsLimit", unsupportedOperation = "UnsupportedOperation", invalidOperationInCellEditMode = "InvalidOperationInCellEditMode" } @@ -45646,7 +45785,7 @@ declare namespace Excel { */ $skip?: number; } - /** An interface for updating data on the Runtime object, for use in "runtime.set({ ... })". */ + /** An interface for updating data on the Runtime object, for use in `runtime.set({ ... })`. */ interface RuntimeUpdateData { /** * @@ -45656,7 +45795,7 @@ declare namespace Excel { */ enableEvents?: boolean; } - /** An interface for updating data on the Application object, for use in "application.set({ ... })". */ + /** An interface for updating data on the Application object, for use in `application.set({ ... })`. */ interface ApplicationUpdateData { /** * @@ -45675,7 +45814,7 @@ declare namespace Excel { */ calculationMode?: Excel.CalculationMode | "Automatic" | "AutomaticExceptTables" | "Manual"; } - /** An interface for updating data on the IterativeCalculation object, for use in "iterativeCalculation.set({ ... })". */ + /** An interface for updating data on the IterativeCalculation object, for use in `iterativeCalculation.set({ ... })`. */ interface IterativeCalculationUpdateData { /** * @@ -45699,7 +45838,7 @@ declare namespace Excel { */ maxIteration?: number; } - /** An interface for updating data on the Workbook object, for use in "workbook.set({ ... })". */ + /** An interface for updating data on the Workbook object, for use in `workbook.set({ ... })`. */ interface WorkbookUpdateData { /** * @@ -45741,7 +45880,7 @@ declare namespace Excel { */ usePrecisionAsDisplayed?: boolean; } - /** An interface for updating data on the Worksheet object, for use in "worksheet.set({ ... })". */ + /** An interface for updating data on the Worksheet object, for use in `worksheet.set({ ... })`. */ interface WorksheetUpdateData { /** * @@ -45813,11 +45952,11 @@ declare namespace Excel { */ visibility?: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden"; } - /** An interface for updating data on the WorksheetCollection object, for use in "worksheetCollection.set({ ... })". */ + /** An interface for updating data on the WorksheetCollection object, for use in `worksheetCollection.set({ ... })`. */ interface WorksheetCollectionUpdateData { items?: Excel.Interfaces.WorksheetData[]; } - /** An interface for updating data on the Range object, for use in "range.set({ ... })". */ + /** An interface for updating data on the Range object, for use in `range.set({ ... })`. */ interface RangeUpdateData { /** * @@ -45881,9 +46020,11 @@ declare namespace Excel { numberFormat?: any[][]; /** * - * Represents Excel's number format code for the given range, based on the language settings of the user. - When setting number format local to a range, the value argument can be either a single value (string) or a two-dimensional array. If the argument is a single value, it will be applied to all cells in the range. - Excel does not perform any language or format coercion when getting or setting the `numberFormatLocal` property. Any returned text uses the locally-formatted strings based on the language specified in the system settings. + * Represents Excel's number format code for the given range, based on the language settings of the user.​ + When setting number format local to a range, the value argument can be either a single value (string) or a two-dimensional array. + If the argument is a single value, it will be applied to all cells in the range.​ + Excel does not perform any language or format coercion when getting or setting the `numberFormatLocal` property. + Any returned text uses the locally-formatted strings based on the language specified in the system settings. * * [Api set: ExcelApi 1.7] */ @@ -45913,7 +46054,7 @@ declare namespace Excel { */ values?: any[][]; } - /** An interface for updating data on the RangeAreas object, for use in "rangeAreas.set({ ... })". */ + /** An interface for updating data on the RangeAreas object, for use in `rangeAreas.set({ ... })`. */ interface RangeAreasUpdateData { /** * @@ -45939,7 +46080,7 @@ declare namespace Excel { */ style?: string; } - /** An interface for updating data on the RangeView object, for use in "rangeView.set({ ... })". */ + /** An interface for updating data on the RangeView object, for use in `rangeView.set({ ... })`. */ interface RangeViewUpdateData { /** * @@ -45977,15 +46118,15 @@ declare namespace Excel { */ values?: any[][]; } - /** An interface for updating data on the RangeViewCollection object, for use in "rangeViewCollection.set({ ... })". */ + /** An interface for updating data on the RangeViewCollection object, for use in `rangeViewCollection.set({ ... })`. */ interface RangeViewCollectionUpdateData { items?: Excel.Interfaces.RangeViewData[]; } - /** An interface for updating data on the SettingCollection object, for use in "settingCollection.set({ ... })". */ + /** An interface for updating data on the SettingCollection object, for use in `settingCollection.set({ ... })`. */ interface SettingCollectionUpdateData { items?: Excel.Interfaces.SettingData[]; } - /** An interface for updating data on the Setting object, for use in "setting.set({ ... })". */ + /** An interface for updating data on the Setting object, for use in `setting.set({ ... })`. */ interface SettingUpdateData { /** * @@ -45995,11 +46136,11 @@ declare namespace Excel { */ value?: any; } - /** An interface for updating data on the NamedItemCollection object, for use in "namedItemCollection.set({ ... })". */ + /** An interface for updating data on the NamedItemCollection object, for use in `namedItemCollection.set({ ... })`. */ interface NamedItemCollectionUpdateData { items?: Excel.Interfaces.NamedItemData[]; } - /** An interface for updating data on the NamedItem object, for use in "namedItem.set({ ... })". */ + /** An interface for updating data on the NamedItem object, for use in `namedItem.set({ ... })`. */ interface NamedItemUpdateData { /** * @@ -46023,19 +46164,19 @@ declare namespace Excel { */ visible?: boolean; } - /** An interface for updating data on the BindingCollection object, for use in "bindingCollection.set({ ... })". */ + /** An interface for updating data on the BindingCollection object, for use in `bindingCollection.set({ ... })`. */ interface BindingCollectionUpdateData { items?: Excel.Interfaces.BindingData[]; } - /** An interface for updating data on the TableCollection object, for use in "tableCollection.set({ ... })". */ + /** An interface for updating data on the TableCollection object, for use in `tableCollection.set({ ... })`. */ interface TableCollectionUpdateData { items?: Excel.Interfaces.TableData[]; } - /** An interface for updating data on the TableScopedCollection object, for use in "tableScopedCollection.set({ ... })". */ + /** An interface for updating data on the TableScopedCollection object, for use in `tableScopedCollection.set({ ... })`. */ interface TableScopedCollectionUpdateData { items?: Excel.Interfaces.TableData[]; } - /** An interface for updating data on the Table object, for use in "table.set({ ... })". */ + /** An interface for updating data on the Table object, for use in `table.set({ ... })`. */ interface TableUpdateData { /** * @@ -46101,11 +46242,11 @@ declare namespace Excel { */ style?: string; } - /** An interface for updating data on the TableColumnCollection object, for use in "tableColumnCollection.set({ ... })". */ + /** An interface for updating data on the TableColumnCollection object, for use in `tableColumnCollection.set({ ... })`. */ interface TableColumnCollectionUpdateData { items?: Excel.Interfaces.TableColumnData[]; } - /** An interface for updating data on the TableColumn object, for use in "tableColumn.set({ ... })". */ + /** An interface for updating data on the TableColumn object, for use in `tableColumn.set({ ... })`. */ interface TableColumnUpdateData { /** * @@ -46122,11 +46263,11 @@ declare namespace Excel { */ values?: any[][]; } - /** An interface for updating data on the TableRowCollection object, for use in "tableRowCollection.set({ ... })". */ + /** An interface for updating data on the TableRowCollection object, for use in `tableRowCollection.set({ ... })`. */ interface TableRowCollectionUpdateData { items?: Excel.Interfaces.TableRowData[]; } - /** An interface for updating data on the TableRow object, for use in "tableRow.set({ ... })". */ + /** An interface for updating data on the TableRow object, for use in `tableRow.set({ ... })`. */ interface TableRowUpdateData { /** * @@ -46136,7 +46277,7 @@ declare namespace Excel { */ values?: any[][]; } - /** An interface for updating data on the DataValidation object, for use in "dataValidation.set({ ... })". */ + /** An interface for updating data on the DataValidation object, for use in `dataValidation.set({ ... })`. */ interface DataValidationUpdateData { /** * @@ -46167,7 +46308,7 @@ declare namespace Excel { */ rule?: Excel.DataValidationRule; } - /** An interface for updating data on the RangeFormat object, for use in "rangeFormat.set({ ... })". */ + /** An interface for updating data on the RangeFormat object, for use in `rangeFormat.set({ ... })`. */ interface RangeFormatUpdateData { /** * @@ -46290,7 +46431,7 @@ declare namespace Excel { */ wrapText?: boolean; } - /** An interface for updating data on the FormatProtection object, for use in "formatProtection.set({ ... })". */ + /** An interface for updating data on the FormatProtection object, for use in `formatProtection.set({ ... })`. */ interface FormatProtectionUpdateData { /** * @@ -46307,11 +46448,11 @@ declare namespace Excel { */ locked?: boolean; } - /** An interface for updating data on the RangeFill object, for use in "rangeFill.set({ ... })". */ + /** An interface for updating data on the RangeFill object, for use in `rangeFill.set({ ... })`. */ interface RangeFillUpdateData { /** * - * HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange") + * HTML color code representing the color of the background, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange") * * [Api set: ExcelApi 1.1] */ @@ -46349,7 +46490,7 @@ declare namespace Excel { */ tintAndShade?: number; } - /** An interface for updating data on the RangeBorder object, for use in "rangeBorder.set({ ... })". */ + /** An interface for updating data on the RangeBorder object, for use in `rangeBorder.set({ ... })`. */ interface RangeBorderUpdateData { /** * @@ -46381,7 +46522,7 @@ declare namespace Excel { */ weight?: Excel.BorderWeight | "Hairline" | "Thin" | "Medium" | "Thick"; } - /** An interface for updating data on the RangeBorderCollection object, for use in "rangeBorderCollection.set({ ... })". */ + /** An interface for updating data on the RangeBorderCollection object, for use in `rangeBorderCollection.set({ ... })`. */ interface RangeBorderCollectionUpdateData { /** * @@ -46393,7 +46534,7 @@ declare namespace Excel { tintAndShade?: number; items?: Excel.Interfaces.RangeBorderData[]; } - /** An interface for updating data on the RangeFont object, for use in "rangeFont.set({ ... })". */ + /** An interface for updating data on the RangeFont object, for use in `rangeFont.set({ ... })`. */ interface RangeFontUpdateData { /** * @@ -46473,11 +46614,11 @@ declare namespace Excel { */ underline?: Excel.RangeUnderlineStyle | "None" | "Single" | "Double" | "SingleAccountant" | "DoubleAccountant"; } - /** An interface for updating data on the ChartCollection object, for use in "chartCollection.set({ ... })". */ + /** An interface for updating data on the ChartCollection object, for use in `chartCollection.set({ ... })`. */ interface ChartCollectionUpdateData { items?: Excel.Interfaces.ChartData[]; } - /** An interface for updating data on the Chart object, for use in "chart.set({ ... })". */ + /** An interface for updating data on the Chart object, for use in `chart.set({ ... })`. */ interface ChartUpdateData { /** * @@ -46631,7 +46772,7 @@ declare namespace Excel { */ width?: number; } - /** An interface for updating data on the ChartPivotOptions object, for use in "chartPivotOptions.set({ ... })". */ + /** An interface for updating data on the ChartPivotOptions object, for use in `chartPivotOptions.set({ ... })`. */ interface ChartPivotOptionsUpdateData { /** * @@ -46662,7 +46803,7 @@ declare namespace Excel { */ showValueFieldButtons?: boolean; } - /** An interface for updating data on the ChartAreaFormat object, for use in "chartAreaFormat.set({ ... })". */ + /** An interface for updating data on the ChartAreaFormat object, for use in `chartAreaFormat.set({ ... })`. */ interface ChartAreaFormatUpdateData { /** * @@ -46693,11 +46834,11 @@ declare namespace Excel { */ roundedCorners?: boolean; } - /** An interface for updating data on the ChartSeriesCollection object, for use in "chartSeriesCollection.set({ ... })". */ + /** An interface for updating data on the ChartSeriesCollection object, for use in `chartSeriesCollection.set({ ... })`. */ interface ChartSeriesCollectionUpdateData { items?: Excel.Interfaces.ChartSeriesData[]; } - /** An interface for updating data on the ChartSeries object, for use in "chartSeries.set({ ... })". */ + /** An interface for updating data on the ChartSeries object, for use in `chartSeries.set({ ... })`. */ interface ChartSeriesUpdateData { /** * @@ -47010,7 +47151,7 @@ declare namespace Excel { */ varyByCategories?: boolean; } - /** An interface for updating data on the ChartSeriesFormat object, for use in "chartSeriesFormat.set({ ... })". */ + /** An interface for updating data on the ChartSeriesFormat object, for use in `chartSeriesFormat.set({ ... })`. */ interface ChartSeriesFormatUpdateData { /** * @@ -47020,11 +47161,11 @@ declare namespace Excel { */ line?: Excel.Interfaces.ChartLineFormatUpdateData; } - /** An interface for updating data on the ChartPointsCollection object, for use in "chartPointsCollection.set({ ... })". */ + /** An interface for updating data on the ChartPointsCollection object, for use in `chartPointsCollection.set({ ... })`. */ interface ChartPointsCollectionUpdateData { items?: Excel.Interfaces.ChartPointData[]; } - /** An interface for updating data on the ChartPoint object, for use in "chartPoint.set({ ... })". */ + /** An interface for updating data on the ChartPoint object, for use in `chartPoint.set({ ... })`. */ interface ChartPointUpdateData { /** * @@ -47076,7 +47217,7 @@ declare namespace Excel { */ markerStyle?: Excel.ChartMarkerStyle | "Invalid" | "Automatic" | "None" | "Square" | "Diamond" | "Triangle" | "X" | "Star" | "Dot" | "Dash" | "Circle" | "Plus" | "Picture"; } - /** An interface for updating data on the ChartPointFormat object, for use in "chartPointFormat.set({ ... })". */ + /** An interface for updating data on the ChartPointFormat object, for use in `chartPointFormat.set({ ... })`. */ interface ChartPointFormatUpdateData { /** * @@ -47086,7 +47227,7 @@ declare namespace Excel { */ border?: Excel.Interfaces.ChartBorderUpdateData; } - /** An interface for updating data on the ChartAxes object, for use in "chartAxes.set({ ... })". */ + /** An interface for updating data on the ChartAxes object, for use in `chartAxes.set({ ... })`. */ interface ChartAxesUpdateData { /** * @@ -47110,7 +47251,7 @@ declare namespace Excel { */ valueAxis?: Excel.Interfaces.ChartAxisUpdateData; } - /** An interface for updating data on the ChartAxis object, for use in "chartAxis.set({ ... })". */ + /** An interface for updating data on the ChartAxis object, for use in `chartAxis.set({ ... })`. */ interface ChartAxisUpdateData { /** * @@ -47330,7 +47471,7 @@ declare namespace Excel { */ visible?: boolean; } - /** An interface for updating data on the ChartAxisFormat object, for use in "chartAxisFormat.set({ ... })". */ + /** An interface for updating data on the ChartAxisFormat object, for use in `chartAxisFormat.set({ ... })`. */ interface ChartAxisFormatUpdateData { /** * @@ -47347,7 +47488,7 @@ declare namespace Excel { */ line?: Excel.Interfaces.ChartLineFormatUpdateData; } - /** An interface for updating data on the ChartAxisTitle object, for use in "chartAxisTitle.set({ ... })". */ + /** An interface for updating data on the ChartAxisTitle object, for use in `chartAxisTitle.set({ ... })`. */ interface ChartAxisTitleUpdateData { /** * @@ -47371,7 +47512,7 @@ declare namespace Excel { */ visible?: boolean; } - /** An interface for updating data on the ChartAxisTitleFormat object, for use in "chartAxisTitleFormat.set({ ... })". */ + /** An interface for updating data on the ChartAxisTitleFormat object, for use in `chartAxisTitleFormat.set({ ... })`. */ interface ChartAxisTitleFormatUpdateData { /** * @@ -47388,7 +47529,7 @@ declare namespace Excel { */ font?: Excel.Interfaces.ChartFontUpdateData; } - /** An interface for updating data on the ChartDataLabels object, for use in "chartDataLabels.set({ ... })". */ + /** An interface for updating data on the ChartDataLabels object, for use in `chartDataLabels.set({ ... })`. */ interface ChartDataLabelsUpdateData { /** * @@ -47492,13 +47633,13 @@ declare namespace Excel { /** * * Represents the vertical alignment of chart data label. See Excel.ChartTextVerticalAlignment for details. - This property is valid only when TextOrientation of data label is 90, -90 or 180. + This property is valid only when TextOrientation of data label is -90, 90, or 180. * * [Api set: ExcelApi 1.8] */ verticalAlignment?: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"; } - /** An interface for updating data on the ChartDataLabel object, for use in "chartDataLabel.set({ ... })". */ + /** An interface for updating data on the ChartDataLabel object, for use in `chartDataLabel.set({ ... })`. */ interface ChartDataLabelUpdateData { /** * @@ -47524,7 +47665,7 @@ declare namespace Excel { /** * * Represents the horizontal alignment for chart data label. See Excel.ChartTextHorizontalAlignment for details. - This property is valid only when TextOrientation of data label is 90, -90 or 180. + This property is valid only when TextOrientation of data label is -90, 90, or 180. * * [Api set: ExcelApi 1.8] */ @@ -47636,7 +47777,7 @@ declare namespace Excel { */ verticalAlignment?: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"; } - /** An interface for updating data on the ChartDataLabelFormat object, for use in "chartDataLabelFormat.set({ ... })". */ + /** An interface for updating data on the ChartDataLabelFormat object, for use in `chartDataLabelFormat.set({ ... })`. */ interface ChartDataLabelFormatUpdateData { /** * @@ -47653,7 +47794,7 @@ declare namespace Excel { */ font?: Excel.Interfaces.ChartFontUpdateData; } - /** An interface for updating data on the ChartErrorBars object, for use in "chartErrorBars.set({ ... })". */ + /** An interface for updating data on the ChartErrorBars object, for use in `chartErrorBars.set({ ... })`. */ interface ChartErrorBarsUpdateData { /** * @@ -47691,7 +47832,7 @@ declare namespace Excel { */ visible?: boolean; } - /** An interface for updating data on the ChartErrorBarsFormat object, for use in "chartErrorBarsFormat.set({ ... })". */ + /** An interface for updating data on the ChartErrorBarsFormat object, for use in `chartErrorBarsFormat.set({ ... })`. */ interface ChartErrorBarsFormatUpdateData { /** * @@ -47701,7 +47842,7 @@ declare namespace Excel { */ line?: Excel.Interfaces.ChartLineFormatUpdateData; } - /** An interface for updating data on the ChartGridlines object, for use in "chartGridlines.set({ ... })". */ + /** An interface for updating data on the ChartGridlines object, for use in `chartGridlines.set({ ... })`. */ interface ChartGridlinesUpdateData { /** * @@ -47718,7 +47859,7 @@ declare namespace Excel { */ visible?: boolean; } - /** An interface for updating data on the ChartGridlinesFormat object, for use in "chartGridlinesFormat.set({ ... })". */ + /** An interface for updating data on the ChartGridlinesFormat object, for use in `chartGridlinesFormat.set({ ... })`. */ interface ChartGridlinesFormatUpdateData { /** * @@ -47728,7 +47869,7 @@ declare namespace Excel { */ line?: Excel.Interfaces.ChartLineFormatUpdateData; } - /** An interface for updating data on the ChartLegend object, for use in "chartLegend.set({ ... })". */ + /** An interface for updating data on the ChartLegend object, for use in `chartLegend.set({ ... })`. */ interface ChartLegendUpdateData { /** * @@ -47794,7 +47935,7 @@ declare namespace Excel { */ width?: number; } - /** An interface for updating data on the ChartLegendEntry object, for use in "chartLegendEntry.set({ ... })". */ + /** An interface for updating data on the ChartLegendEntry object, for use in `chartLegendEntry.set({ ... })`. */ interface ChartLegendEntryUpdateData { /** * @@ -47804,11 +47945,11 @@ declare namespace Excel { */ visible?: boolean; } - /** An interface for updating data on the ChartLegendEntryCollection object, for use in "chartLegendEntryCollection.set({ ... })". */ + /** An interface for updating data on the ChartLegendEntryCollection object, for use in `chartLegendEntryCollection.set({ ... })`. */ interface ChartLegendEntryCollectionUpdateData { items?: Excel.Interfaces.ChartLegendEntryData[]; } - /** An interface for updating data on the ChartLegendFormat object, for use in "chartLegendFormat.set({ ... })". */ + /** An interface for updating data on the ChartLegendFormat object, for use in `chartLegendFormat.set({ ... })`. */ interface ChartLegendFormatUpdateData { /** * @@ -47825,7 +47966,7 @@ declare namespace Excel { */ font?: Excel.Interfaces.ChartFontUpdateData; } - /** An interface for updating data on the ChartMapOptions object, for use in "chartMapOptions.set({ ... })". */ + /** An interface for updating data on the ChartMapOptions object, for use in `chartMapOptions.set({ ... })`. */ interface ChartMapOptionsUpdateData { /** * @@ -47849,7 +47990,7 @@ declare namespace Excel { */ projectionType?: Excel.ChartMapProjectionType | "Automatic" | "Mercator" | "Miller" | "Robinson" | "Albers"; } - /** An interface for updating data on the ChartTitle object, for use in "chartTitle.set({ ... })". */ + /** An interface for updating data on the ChartTitle object, for use in `chartTitle.set({ ... })`. */ interface ChartTitleUpdateData { /** * @@ -47929,7 +48070,7 @@ declare namespace Excel { */ visible?: boolean; } - /** An interface for updating data on the ChartFormatString object, for use in "chartFormatString.set({ ... })". */ + /** An interface for updating data on the ChartFormatString object, for use in `chartFormatString.set({ ... })`. */ interface ChartFormatStringUpdateData { /** * @@ -47939,7 +48080,7 @@ declare namespace Excel { */ font?: Excel.Interfaces.ChartFontUpdateData; } - /** An interface for updating data on the ChartTitleFormat object, for use in "chartTitleFormat.set({ ... })". */ + /** An interface for updating data on the ChartTitleFormat object, for use in `chartTitleFormat.set({ ... })`. */ interface ChartTitleFormatUpdateData { /** * @@ -47956,7 +48097,7 @@ declare namespace Excel { */ font?: Excel.Interfaces.ChartFontUpdateData; } - /** An interface for updating data on the ChartBorder object, for use in "chartBorder.set({ ... })". */ + /** An interface for updating data on the ChartBorder object, for use in `chartBorder.set({ ... })`. */ interface ChartBorderUpdateData { /** * @@ -47980,7 +48121,7 @@ declare namespace Excel { */ weight?: number; } - /** An interface for updating data on the ChartBinOptions object, for use in "chartBinOptions.set({ ... })". */ + /** An interface for updating data on the ChartBinOptions object, for use in `chartBinOptions.set({ ... })`. */ interface ChartBinOptionsUpdateData { /** * @@ -48032,7 +48173,7 @@ declare namespace Excel { */ width?: number; } - /** An interface for updating data on the ChartBoxwhiskerOptions object, for use in "chartBoxwhiskerOptions.set({ ... })". */ + /** An interface for updating data on the ChartBoxwhiskerOptions object, for use in `chartBoxwhiskerOptions.set({ ... })`. */ interface ChartBoxwhiskerOptionsUpdateData { /** * @@ -48070,7 +48211,7 @@ declare namespace Excel { */ showOutlierPoints?: boolean; } - /** An interface for updating data on the ChartLineFormat object, for use in "chartLineFormat.set({ ... })". */ + /** An interface for updating data on the ChartLineFormat object, for use in `chartLineFormat.set({ ... })`. */ interface ChartLineFormatUpdateData { /** * @@ -48094,7 +48235,7 @@ declare namespace Excel { */ weight?: number; } - /** An interface for updating data on the ChartFont object, for use in "chartFont.set({ ... })". */ + /** An interface for updating data on the ChartFont object, for use in `chartFont.set({ ... })`. */ interface ChartFontUpdateData { /** * @@ -48139,7 +48280,7 @@ declare namespace Excel { */ underline?: Excel.ChartUnderlineStyle | "None" | "Single"; } - /** An interface for updating data on the ChartTrendline object, for use in "chartTrendline.set({ ... })". */ + /** An interface for updating data on the ChartTrendline object, for use in `chartTrendline.set({ ... })`. */ interface ChartTrendlineUpdateData { /** * @@ -48219,11 +48360,11 @@ declare namespace Excel { */ type?: Excel.ChartTrendlineType | "Linear" | "Exponential" | "Logarithmic" | "MovingAverage" | "Polynomial" | "Power"; } - /** An interface for updating data on the ChartTrendlineCollection object, for use in "chartTrendlineCollection.set({ ... })". */ + /** An interface for updating data on the ChartTrendlineCollection object, for use in `chartTrendlineCollection.set({ ... })`. */ interface ChartTrendlineCollectionUpdateData { items?: Excel.Interfaces.ChartTrendlineData[]; } - /** An interface for updating data on the ChartTrendlineFormat object, for use in "chartTrendlineFormat.set({ ... })". */ + /** An interface for updating data on the ChartTrendlineFormat object, for use in `chartTrendlineFormat.set({ ... })`. */ interface ChartTrendlineFormatUpdateData { /** * @@ -48233,7 +48374,7 @@ declare namespace Excel { */ line?: Excel.Interfaces.ChartLineFormatUpdateData; } - /** An interface for updating data on the ChartTrendlineLabel object, for use in "chartTrendlineLabel.set({ ... })". */ + /** An interface for updating data on the ChartTrendlineLabel object, for use in `chartTrendlineLabel.set({ ... })`. */ interface ChartTrendlineLabelUpdateData { /** * @@ -48259,7 +48400,7 @@ declare namespace Excel { /** * * Represents the horizontal alignment for chart trendline label. See Excel.ChartTextHorizontalAlignment for details. - This property is valid only when TextOrientation of trendline label is 90, -90 or 180. + This property is valid only when TextOrientation of trendline label is -90, 90, or 180. * * [Api set: ExcelApi 1.8] */ @@ -48315,7 +48456,7 @@ declare namespace Excel { */ verticalAlignment?: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"; } - /** An interface for updating data on the ChartTrendlineLabelFormat object, for use in "chartTrendlineLabelFormat.set({ ... })". */ + /** An interface for updating data on the ChartTrendlineLabelFormat object, for use in `chartTrendlineLabelFormat.set({ ... })`. */ interface ChartTrendlineLabelFormatUpdateData { /** * @@ -48332,7 +48473,7 @@ declare namespace Excel { */ font?: Excel.Interfaces.ChartFontUpdateData; } - /** An interface for updating data on the ChartPlotArea object, for use in "chartPlotArea.set({ ... })". */ + /** An interface for updating data on the ChartPlotArea object, for use in `chartPlotArea.set({ ... })`. */ interface ChartPlotAreaUpdateData { /** * @@ -48405,7 +48546,7 @@ declare namespace Excel { */ width?: number; } - /** An interface for updating data on the ChartPlotAreaFormat object, for use in "chartPlotAreaFormat.set({ ... })". */ + /** An interface for updating data on the ChartPlotAreaFormat object, for use in `chartPlotAreaFormat.set({ ... })`. */ interface ChartPlotAreaFormatUpdateData { /** * @@ -48415,19 +48556,19 @@ declare namespace Excel { */ border?: Excel.Interfaces.ChartBorderUpdateData; } - /** An interface for updating data on the CustomXmlPartScopedCollection object, for use in "customXmlPartScopedCollection.set({ ... })". */ + /** An interface for updating data on the CustomXmlPartScopedCollection object, for use in `customXmlPartScopedCollection.set({ ... })`. */ interface CustomXmlPartScopedCollectionUpdateData { items?: Excel.Interfaces.CustomXmlPartData[]; } - /** An interface for updating data on the CustomXmlPartCollection object, for use in "customXmlPartCollection.set({ ... })". */ + /** An interface for updating data on the CustomXmlPartCollection object, for use in `customXmlPartCollection.set({ ... })`. */ interface CustomXmlPartCollectionUpdateData { items?: Excel.Interfaces.CustomXmlPartData[]; } - /** An interface for updating data on the PivotTableCollection object, for use in "pivotTableCollection.set({ ... })". */ + /** An interface for updating data on the PivotTableCollection object, for use in `pivotTableCollection.set({ ... })`. */ interface PivotTableCollectionUpdateData { items?: Excel.Interfaces.PivotTableData[]; } - /** An interface for updating data on the PivotTable object, for use in "pivotTable.set({ ... })". */ + /** An interface for updating data on the PivotTable object, for use in `pivotTable.set({ ... })`. */ interface PivotTableUpdateData { /** * @@ -48451,7 +48592,7 @@ declare namespace Excel { */ useCustomSortLists?: boolean; } - /** An interface for updating data on the PivotLayout object, for use in "pivotLayout.set({ ... })". */ + /** An interface for updating data on the PivotLayout object, for use in `pivotLayout.set({ ... })`. */ interface PivotLayoutUpdateData { /** * @@ -48504,11 +48645,11 @@ declare namespace Excel { */ subtotalLocation?: Excel.SubtotalLocationType | "AtTop" | "AtBottom" | "Off"; } - /** An interface for updating data on the PivotHierarchyCollection object, for use in "pivotHierarchyCollection.set({ ... })". */ + /** An interface for updating data on the PivotHierarchyCollection object, for use in `pivotHierarchyCollection.set({ ... })`. */ interface PivotHierarchyCollectionUpdateData { items?: Excel.Interfaces.PivotHierarchyData[]; } - /** An interface for updating data on the PivotHierarchy object, for use in "pivotHierarchy.set({ ... })". */ + /** An interface for updating data on the PivotHierarchy object, for use in `pivotHierarchy.set({ ... })`. */ interface PivotHierarchyUpdateData { /** * @@ -48518,11 +48659,11 @@ declare namespace Excel { */ name?: string; } - /** An interface for updating data on the RowColumnPivotHierarchyCollection object, for use in "rowColumnPivotHierarchyCollection.set({ ... })". */ + /** An interface for updating data on the RowColumnPivotHierarchyCollection object, for use in `rowColumnPivotHierarchyCollection.set({ ... })`. */ interface RowColumnPivotHierarchyCollectionUpdateData { items?: Excel.Interfaces.RowColumnPivotHierarchyData[]; } - /** An interface for updating data on the RowColumnPivotHierarchy object, for use in "rowColumnPivotHierarchy.set({ ... })". */ + /** An interface for updating data on the RowColumnPivotHierarchy object, for use in `rowColumnPivotHierarchy.set({ ... })`. */ interface RowColumnPivotHierarchyUpdateData { /** * @@ -48539,11 +48680,11 @@ declare namespace Excel { */ position?: number; } - /** An interface for updating data on the FilterPivotHierarchyCollection object, for use in "filterPivotHierarchyCollection.set({ ... })". */ + /** An interface for updating data on the FilterPivotHierarchyCollection object, for use in `filterPivotHierarchyCollection.set({ ... })`. */ interface FilterPivotHierarchyCollectionUpdateData { items?: Excel.Interfaces.FilterPivotHierarchyData[]; } - /** An interface for updating data on the FilterPivotHierarchy object, for use in "filterPivotHierarchy.set({ ... })". */ + /** An interface for updating data on the FilterPivotHierarchy object, for use in `filterPivotHierarchy.set({ ... })`. */ interface FilterPivotHierarchyUpdateData { /** * @@ -48567,11 +48708,11 @@ declare namespace Excel { */ position?: number; } - /** An interface for updating data on the DataPivotHierarchyCollection object, for use in "dataPivotHierarchyCollection.set({ ... })". */ + /** An interface for updating data on the DataPivotHierarchyCollection object, for use in `dataPivotHierarchyCollection.set({ ... })`. */ interface DataPivotHierarchyCollectionUpdateData { items?: Excel.Interfaces.DataPivotHierarchyData[]; } - /** An interface for updating data on the DataPivotHierarchy object, for use in "dataPivotHierarchy.set({ ... })". */ + /** An interface for updating data on the DataPivotHierarchy object, for use in `dataPivotHierarchy.set({ ... })`. */ interface DataPivotHierarchyUpdateData { /** * @@ -48616,11 +48757,11 @@ declare namespace Excel { */ summarizeBy?: Excel.AggregationFunction | "Unknown" | "Automatic" | "Sum" | "Count" | "Average" | "Max" | "Min" | "Product" | "CountNumbers" | "StandardDeviation" | "StandardDeviationP" | "Variance" | "VarianceP"; } - /** An interface for updating data on the PivotFieldCollection object, for use in "pivotFieldCollection.set({ ... })". */ + /** An interface for updating data on the PivotFieldCollection object, for use in `pivotFieldCollection.set({ ... })`. */ interface PivotFieldCollectionUpdateData { items?: Excel.Interfaces.PivotFieldData[]; } - /** An interface for updating data on the PivotField object, for use in "pivotField.set({ ... })". */ + /** An interface for updating data on the PivotField object, for use in `pivotField.set({ ... })`. */ interface PivotFieldUpdateData { /** * @@ -48644,11 +48785,11 @@ declare namespace Excel { */ subtotals?: Excel.Subtotals; } - /** An interface for updating data on the PivotItemCollection object, for use in "pivotItemCollection.set({ ... })". */ + /** An interface for updating data on the PivotItemCollection object, for use in `pivotItemCollection.set({ ... })`. */ interface PivotItemCollectionUpdateData { items?: Excel.Interfaces.PivotItemData[]; } - /** An interface for updating data on the PivotItem object, for use in "pivotItem.set({ ... })". */ + /** An interface for updating data on the PivotItem object, for use in `pivotItem.set({ ... })`. */ interface PivotItemUpdateData { /** * @@ -48672,7 +48813,7 @@ declare namespace Excel { */ visible?: boolean; } - /** An interface for updating data on the DocumentProperties object, for use in "documentProperties.set({ ... })". */ + /** An interface for updating data on the DocumentProperties object, for use in `documentProperties.set({ ... })`. */ interface DocumentPropertiesUpdateData { /** * @@ -48738,7 +48879,7 @@ declare namespace Excel { */ title?: string; } - /** An interface for updating data on the CustomProperty object, for use in "customProperty.set({ ... })". */ + /** An interface for updating data on the CustomProperty object, for use in `customProperty.set({ ... })`. */ interface CustomPropertyUpdateData { /** * @@ -48748,15 +48889,15 @@ declare namespace Excel { */ value?: any; } - /** An interface for updating data on the CustomPropertyCollection object, for use in "customPropertyCollection.set({ ... })". */ + /** An interface for updating data on the CustomPropertyCollection object, for use in `customPropertyCollection.set({ ... })`. */ interface CustomPropertyCollectionUpdateData { items?: Excel.Interfaces.CustomPropertyData[]; } - /** An interface for updating data on the ConditionalFormatCollection object, for use in "conditionalFormatCollection.set({ ... })". */ + /** An interface for updating data on the ConditionalFormatCollection object, for use in `conditionalFormatCollection.set({ ... })`. */ interface ConditionalFormatCollectionUpdateData { items?: Excel.Interfaces.ConditionalFormatData[]; } - /** An interface for updating data on the ConditionalFormat object, for use in "conditionalFormat.set({ ... })". */ + /** An interface for updating data on the ConditionalFormat object, for use in `conditionalFormat.set({ ... })`. */ interface ConditionalFormatUpdateData { /** * @@ -48896,7 +49037,7 @@ declare namespace Excel { */ stopIfTrue?: boolean; } - /** An interface for updating data on the DataBarConditionalFormat object, for use in "dataBarConditionalFormat.set({ ... })". */ + /** An interface for updating data on the DataBarConditionalFormat object, for use in `dataBarConditionalFormat.set({ ... })`. */ interface DataBarConditionalFormatUpdateData { /** * @@ -48937,6 +49078,7 @@ declare namespace Excel { /** * * The rule for what consistutes the lower bound (and how to calculate it, if applicable) for a data bar. + The `ConditionalDataBarRule` object must be set as a JSON object (use `x.lowerBoundRule = {...}` instead of `x.lowerBoundRule.formula = ...`). * * [Api set: ExcelApi 1.6] */ @@ -48951,12 +49093,13 @@ declare namespace Excel { /** * * The rule for what constitutes the upper bound (and how to calculate it, if applicable) for a data bar. + The `ConditionalDataBarRule` object must be set as a JSON object (use `x.upperBoundRule = {...}` instead of `x.upperBoundRule.formula = ...`). * * [Api set: ExcelApi 1.6] */ upperBoundRule?: Excel.ConditionalDataBarRule; } - /** An interface for updating data on the ConditionalDataBarPositiveFormat object, for use in "conditionalDataBarPositiveFormat.set({ ... })". */ + /** An interface for updating data on the ConditionalDataBarPositiveFormat object, for use in `conditionalDataBarPositiveFormat.set({ ... })`. */ interface ConditionalDataBarPositiveFormatUpdateData { /** * @@ -48981,7 +49124,7 @@ declare namespace Excel { */ gradientFill?: boolean; } - /** An interface for updating data on the ConditionalDataBarNegativeFormat object, for use in "conditionalDataBarNegativeFormat.set({ ... })". */ + /** An interface for updating data on the ConditionalDataBarNegativeFormat object, for use in `conditionalDataBarNegativeFormat.set({ ... })`. */ interface ConditionalDataBarNegativeFormatUpdateData { /** * @@ -49013,7 +49156,7 @@ declare namespace Excel { */ matchPositiveFillColor?: boolean; } - /** An interface for updating data on the CustomConditionalFormat object, for use in "customConditionalFormat.set({ ... })". */ + /** An interface for updating data on the CustomConditionalFormat object, for use in `customConditionalFormat.set({ ... })`. */ interface CustomConditionalFormatUpdateData { /** * @@ -49030,7 +49173,7 @@ declare namespace Excel { */ rule?: Excel.Interfaces.ConditionalFormatRuleUpdateData; } - /** An interface for updating data on the ConditionalFormatRule object, for use in "conditionalFormatRule.set({ ... })". */ + /** An interface for updating data on the ConditionalFormatRule object, for use in `conditionalFormatRule.set({ ... })`. */ interface ConditionalFormatRuleUpdateData { /** * @@ -49054,7 +49197,7 @@ declare namespace Excel { */ formulaR1C1?: string; } - /** An interface for updating data on the IconSetConditionalFormat object, for use in "iconSetConditionalFormat.set({ ... })". */ + /** An interface for updating data on the IconSetConditionalFormat object, for use in `iconSetConditionalFormat.set({ ... })`. */ interface IconSetConditionalFormatUpdateData { /** * @@ -49085,7 +49228,7 @@ declare namespace Excel { */ style?: Excel.IconSet | "Invalid" | "ThreeArrows" | "ThreeArrowsGray" | "ThreeFlags" | "ThreeTrafficLights1" | "ThreeTrafficLights2" | "ThreeSigns" | "ThreeSymbols" | "ThreeSymbols2" | "FourArrows" | "FourArrowsGray" | "FourRedToBlack" | "FourRating" | "FourTrafficLights" | "FiveArrows" | "FiveArrowsGray" | "FiveRating" | "FiveQuarters" | "ThreeStars" | "ThreeTriangles" | "FiveBoxes" | "LinkedEntityFinanceIcon" | "LinkedEntityMapIcon"; } - /** An interface for updating data on the ColorScaleConditionalFormat object, for use in "colorScaleConditionalFormat.set({ ... })". */ + /** An interface for updating data on the ColorScaleConditionalFormat object, for use in `colorScaleConditionalFormat.set({ ... })`. */ interface ColorScaleConditionalFormatUpdateData { /** * @@ -49095,7 +49238,7 @@ declare namespace Excel { */ criteria?: Excel.ConditionalColorScaleCriteria; } - /** An interface for updating data on the TopBottomConditionalFormat object, for use in "topBottomConditionalFormat.set({ ... })". */ + /** An interface for updating data on the TopBottomConditionalFormat object, for use in `topBottomConditionalFormat.set({ ... })`. */ interface TopBottomConditionalFormatUpdateData { /** * @@ -49112,7 +49255,7 @@ declare namespace Excel { */ rule?: Excel.ConditionalTopBottomRule; } - /** An interface for updating data on the PresetCriteriaConditionalFormat object, for use in "presetCriteriaConditionalFormat.set({ ... })". */ + /** An interface for updating data on the PresetCriteriaConditionalFormat object, for use in `presetCriteriaConditionalFormat.set({ ... })`. */ interface PresetCriteriaConditionalFormatUpdateData { /** * @@ -49129,7 +49272,7 @@ declare namespace Excel { */ rule?: Excel.ConditionalPresetCriteriaRule; } - /** An interface for updating data on the TextConditionalFormat object, for use in "textConditionalFormat.set({ ... })". */ + /** An interface for updating data on the TextConditionalFormat object, for use in `textConditionalFormat.set({ ... })`. */ interface TextConditionalFormatUpdateData { /** * @@ -49146,7 +49289,7 @@ declare namespace Excel { */ rule?: Excel.ConditionalTextComparisonRule; } - /** An interface for updating data on the CellValueConditionalFormat object, for use in "cellValueConditionalFormat.set({ ... })". */ + /** An interface for updating data on the CellValueConditionalFormat object, for use in `cellValueConditionalFormat.set({ ... })`. */ interface CellValueConditionalFormatUpdateData { /** * @@ -49163,7 +49306,7 @@ declare namespace Excel { */ rule?: Excel.ConditionalCellValueRule; } - /** An interface for updating data on the ConditionalRangeFormat object, for use in "conditionalRangeFormat.set({ ... })". */ + /** An interface for updating data on the ConditionalRangeFormat object, for use in `conditionalRangeFormat.set({ ... })`. */ interface ConditionalRangeFormatUpdateData { /** * @@ -49194,7 +49337,7 @@ declare namespace Excel { */ numberFormat?: any; } - /** An interface for updating data on the ConditionalRangeFont object, for use in "conditionalRangeFont.set({ ... })". */ + /** An interface for updating data on the ConditionalRangeFont object, for use in `conditionalRangeFont.set({ ... })`. */ interface ConditionalRangeFontUpdateData { /** * @@ -49232,7 +49375,7 @@ declare namespace Excel { */ underline?: Excel.ConditionalRangeFontUnderlineStyle | "None" | "Single" | "Double"; } - /** An interface for updating data on the ConditionalRangeFill object, for use in "conditionalRangeFill.set({ ... })". */ + /** An interface for updating data on the ConditionalRangeFill object, for use in `conditionalRangeFill.set({ ... })`. */ interface ConditionalRangeFillUpdateData { /** * @@ -49242,7 +49385,7 @@ declare namespace Excel { */ color?: string; } - /** An interface for updating data on the ConditionalRangeBorder object, for use in "conditionalRangeBorder.set({ ... })". */ + /** An interface for updating data on the ConditionalRangeBorder object, for use in `conditionalRangeBorder.set({ ... })`. */ interface ConditionalRangeBorderUpdateData { /** * @@ -49259,7 +49402,7 @@ declare namespace Excel { */ style?: Excel.ConditionalRangeBorderLineStyle | "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot"; } - /** An interface for updating data on the ConditionalRangeBorderCollection object, for use in "conditionalRangeBorderCollection.set({ ... })". */ + /** An interface for updating data on the ConditionalRangeBorderCollection object, for use in `conditionalRangeBorderCollection.set({ ... })`. */ interface ConditionalRangeBorderCollectionUpdateData { /** * @@ -49291,7 +49434,7 @@ declare namespace Excel { top?: Excel.Interfaces.ConditionalRangeBorderUpdateData; items?: Excel.Interfaces.ConditionalRangeBorderData[]; } - /** An interface for updating data on the Style object, for use in "style.set({ ... })". */ + /** An interface for updating data on the Style object, for use in `style.set({ ... })`. */ interface StyleUpdateData { /** * @@ -49441,15 +49584,15 @@ declare namespace Excel { */ wrapText?: boolean; } - /** An interface for updating data on the StyleCollection object, for use in "styleCollection.set({ ... })". */ + /** An interface for updating data on the StyleCollection object, for use in `styleCollection.set({ ... })`. */ interface StyleCollectionUpdateData { items?: Excel.Interfaces.StyleData[]; } - /** An interface for updating data on the TableStyleCollection object, for use in "tableStyleCollection.set({ ... })". */ + /** An interface for updating data on the TableStyleCollection object, for use in `tableStyleCollection.set({ ... })`. */ interface TableStyleCollectionUpdateData { items?: Excel.Interfaces.TableStyleData[]; } - /** An interface for updating data on the TableStyle object, for use in "tableStyle.set({ ... })". */ + /** An interface for updating data on the TableStyle object, for use in `tableStyle.set({ ... })`. */ interface TableStyleUpdateData { /** * @@ -49460,11 +49603,11 @@ declare namespace Excel { */ name?: string; } - /** An interface for updating data on the PivotTableStyleCollection object, for use in "pivotTableStyleCollection.set({ ... })". */ + /** An interface for updating data on the PivotTableStyleCollection object, for use in `pivotTableStyleCollection.set({ ... })`. */ interface PivotTableStyleCollectionUpdateData { items?: Excel.Interfaces.PivotTableStyleData[]; } - /** An interface for updating data on the PivotTableStyle object, for use in "pivotTableStyle.set({ ... })". */ + /** An interface for updating data on the PivotTableStyle object, for use in `pivotTableStyle.set({ ... })`. */ interface PivotTableStyleUpdateData { /** * @@ -49475,11 +49618,11 @@ declare namespace Excel { */ name?: string; } - /** An interface for updating data on the SlicerStyleCollection object, for use in "slicerStyleCollection.set({ ... })". */ + /** An interface for updating data on the SlicerStyleCollection object, for use in `slicerStyleCollection.set({ ... })`. */ interface SlicerStyleCollectionUpdateData { items?: Excel.Interfaces.SlicerStyleData[]; } - /** An interface for updating data on the SlicerStyle object, for use in "slicerStyle.set({ ... })". */ + /** An interface for updating data on the SlicerStyle object, for use in `slicerStyle.set({ ... })`. */ interface SlicerStyleUpdateData { /** * @@ -49490,11 +49633,11 @@ declare namespace Excel { */ name?: string; } - /** An interface for updating data on the TimelineStyleCollection object, for use in "timelineStyleCollection.set({ ... })". */ + /** An interface for updating data on the TimelineStyleCollection object, for use in `timelineStyleCollection.set({ ... })`. */ interface TimelineStyleCollectionUpdateData { items?: Excel.Interfaces.TimelineStyleData[]; } - /** An interface for updating data on the TimelineStyle object, for use in "timelineStyle.set({ ... })". */ + /** An interface for updating data on the TimelineStyle object, for use in `timelineStyle.set({ ... })`. */ interface TimelineStyleUpdateData { /** * @@ -49505,7 +49648,7 @@ declare namespace Excel { */ name?: string; } - /** An interface for updating data on the PageLayout object, for use in "pageLayout.set({ ... })". */ + /** An interface for updating data on the PageLayout object, for use in `pageLayout.set({ ... })`. */ interface PageLayoutUpdateData { /** * @@ -49643,12 +49786,13 @@ declare namespace Excel { /** * * Gets or sets the worksheet's print zoom options. + The `PageLayoutZoomOptions` object must be set as a JSON object (use `x.zoom = {...}` instead of `x.zoom.scale = ...`). * * [Api set: ExcelApi 1.9] */ zoom?: Excel.PageLayoutZoomOptions; } - /** An interface for updating data on the HeaderFooter object, for use in "headerFooter.set({ ... })". */ + /** An interface for updating data on the HeaderFooter object, for use in `headerFooter.set({ ... })`. */ interface HeaderFooterUpdateData { /** * @@ -49699,7 +49843,7 @@ declare namespace Excel { */ rightHeader?: string; } - /** An interface for updating data on the HeaderFooterGroup object, for use in "headerFooterGroup.set({ ... })". */ + /** An interface for updating data on the HeaderFooterGroup object, for use in `headerFooterGroup.set({ ... })`. */ interface HeaderFooterGroupUpdateData { /** * @@ -49751,19 +49895,19 @@ declare namespace Excel { */ useSheetScale?: boolean; } - /** An interface for updating data on the PageBreakCollection object, for use in "pageBreakCollection.set({ ... })". */ + /** An interface for updating data on the PageBreakCollection object, for use in `pageBreakCollection.set({ ... })`. */ interface PageBreakCollectionUpdateData { items?: Excel.Interfaces.PageBreakData[]; } - /** An interface for updating data on the RangeCollection object, for use in "rangeCollection.set({ ... })". */ + /** An interface for updating data on the RangeCollection object, for use in `rangeCollection.set({ ... })`. */ interface RangeCollectionUpdateData { items?: Excel.Interfaces.RangeData[]; } - /** An interface for updating data on the CommentCollection object, for use in "commentCollection.set({ ... })". */ + /** An interface for updating data on the CommentCollection object, for use in `commentCollection.set({ ... })`. */ interface CommentCollectionUpdateData { items?: Excel.Interfaces.CommentData[]; } - /** An interface for updating data on the Comment object, for use in "comment.set({ ... })". */ + /** An interface for updating data on the Comment object, for use in `comment.set({ ... })`. */ interface CommentUpdateData { /** * @@ -49782,11 +49926,11 @@ declare namespace Excel { */ resolved?: boolean; } - /** An interface for updating data on the CommentReplyCollection object, for use in "commentReplyCollection.set({ ... })". */ + /** An interface for updating data on the CommentReplyCollection object, for use in `commentReplyCollection.set({ ... })`. */ interface CommentReplyCollectionUpdateData { items?: Excel.Interfaces.CommentReplyData[]; } - /** An interface for updating data on the CommentReply object, for use in "commentReply.set({ ... })". */ + /** An interface for updating data on the CommentReply object, for use in `commentReply.set({ ... })`. */ interface CommentReplyUpdateData { /** * @@ -49797,11 +49941,11 @@ declare namespace Excel { */ content?: string; } - /** An interface for updating data on the ShapeCollection object, for use in "shapeCollection.set({ ... })". */ + /** An interface for updating data on the ShapeCollection object, for use in `shapeCollection.set({ ... })`. */ interface ShapeCollectionUpdateData { items?: Excel.Interfaces.ShapeData[]; } - /** An interface for updating data on the Shape object, for use in "shape.set({ ... })". */ + /** An interface for updating data on the Shape object, for use in `shape.set({ ... })`. */ interface ShapeUpdateData { /** * @@ -49907,11 +50051,11 @@ declare namespace Excel { */ width?: number; } - /** An interface for updating data on the GroupShapeCollection object, for use in "groupShapeCollection.set({ ... })". */ + /** An interface for updating data on the GroupShapeCollection object, for use in `groupShapeCollection.set({ ... })`. */ interface GroupShapeCollectionUpdateData { items?: Excel.Interfaces.ShapeData[]; } - /** An interface for updating data on the Line object, for use in "line.set({ ... })". */ + /** An interface for updating data on the Line object, for use in `line.set({ ... })`. */ interface LineUpdateData { /** * @@ -49963,7 +50107,7 @@ declare namespace Excel { */ connectorType?: Excel.ConnectorType | "Straight" | "Elbow" | "Curve"; } - /** An interface for updating data on the ShapeFill object, for use in "shapeFill.set({ ... })". */ + /** An interface for updating data on the ShapeFill object, for use in `shapeFill.set({ ... })`. */ interface ShapeFillUpdateData { /** * @@ -49980,7 +50124,7 @@ declare namespace Excel { */ transparency?: number; } - /** An interface for updating data on the ShapeLineFormat object, for use in "shapeLineFormat.set({ ... })". */ + /** An interface for updating data on the ShapeLineFormat object, for use in `shapeLineFormat.set({ ... })`. */ interface ShapeLineFormatUpdateData { /** * @@ -50025,7 +50169,7 @@ declare namespace Excel { */ weight?: number; } - /** An interface for updating data on the TextFrame object, for use in "textFrame.set({ ... })". */ + /** An interface for updating data on the TextFrame object, for use in `textFrame.set({ ... })`. */ interface TextFrameUpdateData { /** * @@ -50105,7 +50249,7 @@ declare namespace Excel { */ verticalOverflow?: Excel.ShapeTextVerticalOverflow | "Overflow" | "Ellipsis" | "Clip"; } - /** An interface for updating data on the TextRange object, for use in "textRange.set({ ... })". */ + /** An interface for updating data on the TextRange object, for use in `textRange.set({ ... })`. */ interface TextRangeUpdateData { /** * @@ -50122,7 +50266,7 @@ declare namespace Excel { */ text?: string; } - /** An interface for updating data on the ShapeFont object, for use in "shapeFont.set({ ... })". */ + /** An interface for updating data on the ShapeFont object, for use in `shapeFont.set({ ... })`. */ interface ShapeFontUpdateData { /** * @@ -50167,7 +50311,7 @@ declare namespace Excel { */ underline?: Excel.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble"; } - /** An interface for updating data on the Slicer object, for use in "slicer.set({ ... })". */ + /** An interface for updating data on the Slicer object, for use in `slicer.set({ ... })`. */ interface SlicerUpdateData { /** * @@ -50188,7 +50332,7 @@ declare namespace Excel { /** * * Represents the height, in points, of the slicer. - Throws an invalid argument exception when set with negative value or zero as input. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value or zero as input. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -50197,7 +50341,7 @@ declare namespace Excel { /** * * Represents the distance, in points, from the left side of the slicer to the left of the worksheet. - Throws an invalid argument exception when set with negative value as input. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value as input. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -50221,7 +50365,7 @@ declare namespace Excel { nameInFormula?: string; /** * - * Represents the sort order of the items in the slicer. Possible values are: DataSourceOrder, Ascending, Descending. + * Represents the sort order of the items in the slicer. Possible values are: "DataSourceOrder", "Ascending", "Descending". * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -50238,7 +50382,7 @@ declare namespace Excel { /** * * Represents the distance, in points, from the top edge of the slicer to the top of the worksheet. - Throws an invalid argument exception when set with negative value as input. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value as input. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -50247,18 +50391,18 @@ declare namespace Excel { /** * * Represents the width, in points, of the slicer. - Throws an invalid argument exception when set with negative value or zero as input. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value or zero as input. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta */ width?: number; } - /** An interface for updating data on the SlicerCollection object, for use in "slicerCollection.set({ ... })". */ + /** An interface for updating data on the SlicerCollection object, for use in `slicerCollection.set({ ... })`. */ interface SlicerCollectionUpdateData { items?: Excel.Interfaces.SlicerData[]; } - /** An interface for updating data on the SlicerItem object, for use in "slicerItem.set({ ... })". */ + /** An interface for updating data on the SlicerItem object, for use in `slicerItem.set({ ... })`. */ interface SlicerItemUpdateData { /** * @@ -50271,11 +50415,11 @@ declare namespace Excel { */ isSelected?: boolean; } - /** An interface for updating data on the SlicerItemCollection object, for use in "slicerItemCollection.set({ ... })". */ + /** An interface for updating data on the SlicerItemCollection object, for use in `slicerItemCollection.set({ ... })`. */ interface SlicerItemCollectionUpdateData { items?: Excel.Interfaces.SlicerItemData[]; } - /** An interface describing the data returned by calling "runtime.toJSON()". */ + /** An interface describing the data returned by calling `runtime.toJSON()`. */ interface RuntimeData { /** * @@ -50285,7 +50429,7 @@ declare namespace Excel { */ enableEvents?: boolean; } - /** An interface describing the data returned by calling "application.toJSON()". */ + /** An interface describing the data returned by calling `application.toJSON()`. */ interface ApplicationData { /** * @@ -50318,7 +50462,7 @@ declare namespace Excel { */ calculationState?: Excel.CalculationState | "Done" | "Calculating" | "Pending"; } - /** An interface describing the data returned by calling "iterativeCalculation.toJSON()". */ + /** An interface describing the data returned by calling `iterativeCalculation.toJSON()`. */ interface IterativeCalculationData { /** * @@ -50342,7 +50486,7 @@ declare namespace Excel { */ maxIteration?: number; } - /** An interface describing the data returned by calling "workbook.toJSON()". */ + /** An interface describing the data returned by calling `workbook.toJSON()`. */ interface WorkbookData { /** * @@ -50530,7 +50674,7 @@ declare namespace Excel { */ usePrecisionAsDisplayed?: boolean; } - /** An interface describing the data returned by calling "workbookProtection.toJSON()". */ + /** An interface describing the data returned by calling `workbookProtection.toJSON()`. */ interface WorkbookProtectionData { /** * @@ -50540,10 +50684,10 @@ declare namespace Excel { */ protected?: boolean; } - /** An interface describing the data returned by calling "workbookCreated.toJSON()". */ + /** An interface describing the data returned by calling `workbookCreated.toJSON()`. */ interface WorkbookCreatedData { } - /** An interface describing the data returned by calling "worksheet.toJSON()". */ + /** An interface describing the data returned by calling `worksheet.toJSON()`. */ interface WorksheetData { /** * @@ -50708,11 +50852,11 @@ declare namespace Excel { */ visibility?: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden"; } - /** An interface describing the data returned by calling "worksheetCollection.toJSON()". */ + /** An interface describing the data returned by calling `worksheetCollection.toJSON()`. */ interface WorksheetCollectionData { items?: Excel.Interfaces.WorksheetData[]; } - /** An interface describing the data returned by calling "worksheetProtection.toJSON()". */ + /** An interface describing the data returned by calling `worksheetProtection.toJSON()`. */ interface WorksheetProtectionData { /** * @@ -50729,7 +50873,7 @@ declare namespace Excel { */ protected?: boolean; } - /** An interface describing the data returned by calling "range.toJSON()". */ + /** An interface describing the data returned by calling `range.toJSON()`. */ interface RangeData { /** * @@ -50889,9 +51033,11 @@ declare namespace Excel { numberFormat?: any[][]; /** * - * Represents Excel's number format code for the given range, based on the language settings of the user. - When setting number format local to a range, the value argument can be either a single value (string) or a two-dimensional array. If the argument is a single value, it will be applied to all cells in the range. - Excel does not perform any language or format coercion when getting or setting the `numberFormatLocal` property. Any returned text uses the locally-formatted strings based on the language specified in the system settings. + * Represents Excel's number format code for the given range, based on the language settings of the user.​ + When setting number format local to a range, the value argument can be either a single value (string) or a two-dimensional array. + If the argument is a single value, it will be applied to all cells in the range.​ + Excel does not perform any language or format coercion when getting or setting the `numberFormatLocal` property. + Any returned text uses the locally-formatted strings based on the language specified in the system settings. * * [Api set: ExcelApi 1.7] */ @@ -50920,8 +51066,8 @@ declare namespace Excel { /** * * Represents if ALL the cells would be saved as an array formula. - * Returns true if ALL cells would be saved as an array, or false if ALL cells would NOT be saved as an array formula. - * Returns null if there is a mixture of cells that would and would not be saved as an array formula. + Returns true if ALL cells would be saved as an array formula, or false if ALL cells would NOT be saved as an array formula. + Returns null if some cells would be saved as an array formula and some would not be. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -50975,7 +51121,7 @@ declare namespace Excel { */ width?: number; } - /** An interface describing the data returned by calling "rangeAreas.toJSON()". */ + /** An interface describing the data returned by calling `rangeAreas.toJSON()`. */ interface RangeAreasData { /** * @@ -51057,7 +51203,7 @@ declare namespace Excel { */ style?: string; } - /** An interface describing the data returned by calling "rangeView.toJSON()". */ + /** An interface describing the data returned by calling `rangeView.toJSON()`. */ interface RangeViewData { /** * @@ -51144,15 +51290,15 @@ declare namespace Excel { */ values?: any[][]; } - /** An interface describing the data returned by calling "rangeViewCollection.toJSON()". */ + /** An interface describing the data returned by calling `rangeViewCollection.toJSON()`. */ interface RangeViewCollectionData { items?: Excel.Interfaces.RangeViewData[]; } - /** An interface describing the data returned by calling "settingCollection.toJSON()". */ + /** An interface describing the data returned by calling `settingCollection.toJSON()`. */ interface SettingCollectionData { items?: Excel.Interfaces.SettingData[]; } - /** An interface describing the data returned by calling "setting.toJSON()". */ + /** An interface describing the data returned by calling `setting.toJSON()`. */ interface SettingData { /** * @@ -51169,11 +51315,11 @@ declare namespace Excel { */ value?: any; } - /** An interface describing the data returned by calling "namedItemCollection.toJSON()". */ + /** An interface describing the data returned by calling `namedItemCollection.toJSON()`. */ interface NamedItemCollectionData { items?: Excel.Interfaces.NamedItemData[]; } - /** An interface describing the data returned by calling "namedItem.toJSON()". */ + /** An interface describing the data returned by calling `namedItem.toJSON()`. */ interface NamedItemData { /** * @@ -51232,7 +51378,7 @@ declare namespace Excel { */ visible?: boolean; } - /** An interface describing the data returned by calling "namedItemArrayValues.toJSON()". */ + /** An interface describing the data returned by calling `namedItemArrayValues.toJSON()`. */ interface NamedItemArrayValuesData { /** * @@ -51249,7 +51395,7 @@ declare namespace Excel { */ values?: any[][]; } - /** An interface describing the data returned by calling "binding.toJSON()". */ + /** An interface describing the data returned by calling `binding.toJSON()`. */ interface BindingData { /** * @@ -51266,19 +51412,19 @@ declare namespace Excel { */ type?: Excel.BindingType | "Range" | "Table" | "Text"; } - /** An interface describing the data returned by calling "bindingCollection.toJSON()". */ + /** An interface describing the data returned by calling `bindingCollection.toJSON()`. */ interface BindingCollectionData { items?: Excel.Interfaces.BindingData[]; } - /** An interface describing the data returned by calling "tableCollection.toJSON()". */ + /** An interface describing the data returned by calling `tableCollection.toJSON()`. */ interface TableCollectionData { items?: Excel.Interfaces.TableData[]; } - /** An interface describing the data returned by calling "tableScopedCollection.toJSON()". */ + /** An interface describing the data returned by calling `tableScopedCollection.toJSON()`. */ interface TableScopedCollectionData { items?: Excel.Interfaces.TableData[]; } - /** An interface describing the data returned by calling "table.toJSON()". */ + /** An interface describing the data returned by calling `table.toJSON()`. */ interface TableData { /** * @@ -51386,11 +51532,11 @@ declare namespace Excel { */ style?: string; } - /** An interface describing the data returned by calling "tableColumnCollection.toJSON()". */ + /** An interface describing the data returned by calling `tableColumnCollection.toJSON()`. */ interface TableColumnCollectionData { items?: Excel.Interfaces.TableColumnData[]; } - /** An interface describing the data returned by calling "tableColumn.toJSON()". */ + /** An interface describing the data returned by calling `tableColumn.toJSON()`. */ interface TableColumnData { /** * @@ -51428,11 +51574,11 @@ declare namespace Excel { */ values?: any[][]; } - /** An interface describing the data returned by calling "tableRowCollection.toJSON()". */ + /** An interface describing the data returned by calling `tableRowCollection.toJSON()`. */ interface TableRowCollectionData { items?: Excel.Interfaces.TableRowData[]; } - /** An interface describing the data returned by calling "tableRow.toJSON()". */ + /** An interface describing the data returned by calling `tableRow.toJSON()`. */ interface TableRowData { /** * @@ -51449,7 +51595,7 @@ declare namespace Excel { */ values?: any[][]; } - /** An interface describing the data returned by calling "dataValidation.toJSON()". */ + /** An interface describing the data returned by calling `dataValidation.toJSON()`. */ interface DataValidationData { /** * @@ -51496,7 +51642,7 @@ declare namespace Excel { */ valid?: boolean; } - /** An interface describing the data returned by calling "removeDuplicatesResult.toJSON()". */ + /** An interface describing the data returned by calling `removeDuplicatesResult.toJSON()`. */ interface RemoveDuplicatesResultData { /** * @@ -51513,7 +51659,7 @@ declare namespace Excel { */ uniqueRemaining?: number; } - /** An interface describing the data returned by calling "rangeFormat.toJSON()". */ + /** An interface describing the data returned by calling `rangeFormat.toJSON()`. */ interface RangeFormatData { /** * @@ -51636,7 +51782,7 @@ declare namespace Excel { */ wrapText?: boolean; } - /** An interface describing the data returned by calling "formatProtection.toJSON()". */ + /** An interface describing the data returned by calling `formatProtection.toJSON()`. */ interface FormatProtectionData { /** * @@ -51653,11 +51799,11 @@ declare namespace Excel { */ locked?: boolean; } - /** An interface describing the data returned by calling "rangeFill.toJSON()". */ + /** An interface describing the data returned by calling `rangeFill.toJSON()`. */ interface RangeFillData { /** * - * HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange") + * HTML color code representing the color of the background, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange") * * [Api set: ExcelApi 1.1] */ @@ -51695,7 +51841,7 @@ declare namespace Excel { */ tintAndShade?: number; } - /** An interface describing the data returned by calling "rangeBorder.toJSON()". */ + /** An interface describing the data returned by calling `rangeBorder.toJSON()`. */ interface RangeBorderData { /** * @@ -51734,11 +51880,11 @@ declare namespace Excel { */ weight?: Excel.BorderWeight | "Hairline" | "Thin" | "Medium" | "Thick"; } - /** An interface describing the data returned by calling "rangeBorderCollection.toJSON()". */ + /** An interface describing the data returned by calling `rangeBorderCollection.toJSON()`. */ interface RangeBorderCollectionData { items?: Excel.Interfaces.RangeBorderData[]; } - /** An interface describing the data returned by calling "rangeFont.toJSON()". */ + /** An interface describing the data returned by calling `rangeFont.toJSON()`. */ interface RangeFontData { /** * @@ -51818,11 +51964,11 @@ declare namespace Excel { */ underline?: Excel.RangeUnderlineStyle | "None" | "Single" | "Double" | "SingleAccountant" | "DoubleAccountant"; } - /** An interface describing the data returned by calling "chartCollection.toJSON()". */ + /** An interface describing the data returned by calling `chartCollection.toJSON()`. */ interface ChartCollectionData { items?: Excel.Interfaces.ChartData[]; } - /** An interface describing the data returned by calling "chart.toJSON()". */ + /** An interface describing the data returned by calling `chart.toJSON()`. */ interface ChartData { /** * @@ -51990,7 +52136,7 @@ declare namespace Excel { */ width?: number; } - /** An interface describing the data returned by calling "chartPivotOptions.toJSON()". */ + /** An interface describing the data returned by calling `chartPivotOptions.toJSON()`. */ interface ChartPivotOptionsData { /** * @@ -52021,7 +52167,7 @@ declare namespace Excel { */ showValueFieldButtons?: boolean; } - /** An interface describing the data returned by calling "chartAreaFormat.toJSON()". */ + /** An interface describing the data returned by calling `chartAreaFormat.toJSON()`. */ interface ChartAreaFormatData { /** * @@ -52052,11 +52198,11 @@ declare namespace Excel { */ roundedCorners?: boolean; } - /** An interface describing the data returned by calling "chartSeriesCollection.toJSON()". */ + /** An interface describing the data returned by calling `chartSeriesCollection.toJSON()`. */ interface ChartSeriesCollectionData { items?: Excel.Interfaces.ChartSeriesData[]; } - /** An interface describing the data returned by calling "chartSeries.toJSON()". */ + /** An interface describing the data returned by calling `chartSeries.toJSON()`. */ interface ChartSeriesData { /** * @@ -52383,7 +52529,7 @@ declare namespace Excel { */ varyByCategories?: boolean; } - /** An interface describing the data returned by calling "chartSeriesFormat.toJSON()". */ + /** An interface describing the data returned by calling `chartSeriesFormat.toJSON()`. */ interface ChartSeriesFormatData { /** * @@ -52393,11 +52539,11 @@ declare namespace Excel { */ line?: Excel.Interfaces.ChartLineFormatData; } - /** An interface describing the data returned by calling "chartPointsCollection.toJSON()". */ + /** An interface describing the data returned by calling `chartPointsCollection.toJSON()`. */ interface ChartPointsCollectionData { items?: Excel.Interfaces.ChartPointData[]; } - /** An interface describing the data returned by calling "chartPoint.toJSON()". */ + /** An interface describing the data returned by calling `chartPoint.toJSON()`. */ interface ChartPointData { /** * @@ -52456,7 +52602,7 @@ declare namespace Excel { */ value?: any; } - /** An interface describing the data returned by calling "chartPointFormat.toJSON()". */ + /** An interface describing the data returned by calling `chartPointFormat.toJSON()`. */ interface ChartPointFormatData { /** * @@ -52466,7 +52612,7 @@ declare namespace Excel { */ border?: Excel.Interfaces.ChartBorderData; } - /** An interface describing the data returned by calling "chartAxes.toJSON()". */ + /** An interface describing the data returned by calling `chartAxes.toJSON()`. */ interface ChartAxesData { /** * @@ -52490,7 +52636,7 @@ declare namespace Excel { */ valueAxis?: Excel.Interfaces.ChartAxisData; } - /** An interface describing the data returned by calling "chartAxis.toJSON()". */ + /** An interface describing the data returned by calling `chartAxis.toJSON()`. */ interface ChartAxisData { /** * @@ -52766,7 +52912,7 @@ declare namespace Excel { */ width?: number; } - /** An interface describing the data returned by calling "chartAxisFormat.toJSON()". */ + /** An interface describing the data returned by calling `chartAxisFormat.toJSON()`. */ interface ChartAxisFormatData { /** * @@ -52783,7 +52929,7 @@ declare namespace Excel { */ line?: Excel.Interfaces.ChartLineFormatData; } - /** An interface describing the data returned by calling "chartAxisTitle.toJSON()". */ + /** An interface describing the data returned by calling `chartAxisTitle.toJSON()`. */ interface ChartAxisTitleData { /** * @@ -52807,7 +52953,7 @@ declare namespace Excel { */ visible?: boolean; } - /** An interface describing the data returned by calling "chartAxisTitleFormat.toJSON()". */ + /** An interface describing the data returned by calling `chartAxisTitleFormat.toJSON()`. */ interface ChartAxisTitleFormatData { /** * @@ -52824,7 +52970,7 @@ declare namespace Excel { */ font?: Excel.Interfaces.ChartFontData; } - /** An interface describing the data returned by calling "chartDataLabels.toJSON()". */ + /** An interface describing the data returned by calling `chartDataLabels.toJSON()`. */ interface ChartDataLabelsData { /** * @@ -52928,13 +53074,13 @@ declare namespace Excel { /** * * Represents the vertical alignment of chart data label. See Excel.ChartTextVerticalAlignment for details. - This property is valid only when TextOrientation of data label is 90, -90 or 180. + This property is valid only when TextOrientation of data label is -90, 90, or 180. * * [Api set: ExcelApi 1.8] */ verticalAlignment?: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"; } - /** An interface describing the data returned by calling "chartDataLabel.toJSON()". */ + /** An interface describing the data returned by calling `chartDataLabel.toJSON()`. */ interface ChartDataLabelData { /** * @@ -52967,7 +53113,7 @@ declare namespace Excel { /** * * Represents the horizontal alignment for chart data label. See Excel.ChartTextHorizontalAlignment for details. - This property is valid only when TextOrientation of data label is 90, -90 or 180. + This property is valid only when TextOrientation of data label is -90, 90, or 180. * * [Api set: ExcelApi 1.8] */ @@ -53086,7 +53232,7 @@ declare namespace Excel { */ width?: number; } - /** An interface describing the data returned by calling "chartDataLabelFormat.toJSON()". */ + /** An interface describing the data returned by calling `chartDataLabelFormat.toJSON()`. */ interface ChartDataLabelFormatData { /** * @@ -53103,7 +53249,7 @@ declare namespace Excel { */ font?: Excel.Interfaces.ChartFontData; } - /** An interface describing the data returned by calling "chartErrorBars.toJSON()". */ + /** An interface describing the data returned by calling `chartErrorBars.toJSON()`. */ interface ChartErrorBarsData { /** * @@ -53141,7 +53287,7 @@ declare namespace Excel { */ visible?: boolean; } - /** An interface describing the data returned by calling "chartErrorBarsFormat.toJSON()". */ + /** An interface describing the data returned by calling `chartErrorBarsFormat.toJSON()`. */ interface ChartErrorBarsFormatData { /** * @@ -53151,7 +53297,7 @@ declare namespace Excel { */ line?: Excel.Interfaces.ChartLineFormatData; } - /** An interface describing the data returned by calling "chartGridlines.toJSON()". */ + /** An interface describing the data returned by calling `chartGridlines.toJSON()`. */ interface ChartGridlinesData { /** * @@ -53168,7 +53314,7 @@ declare namespace Excel { */ visible?: boolean; } - /** An interface describing the data returned by calling "chartGridlinesFormat.toJSON()". */ + /** An interface describing the data returned by calling `chartGridlinesFormat.toJSON()`. */ interface ChartGridlinesFormatData { /** * @@ -53178,7 +53324,7 @@ declare namespace Excel { */ line?: Excel.Interfaces.ChartLineFormatData; } - /** An interface describing the data returned by calling "chartLegend.toJSON()". */ + /** An interface describing the data returned by calling `chartLegend.toJSON()`. */ interface ChartLegendData { /** * @@ -53251,7 +53397,7 @@ declare namespace Excel { */ width?: number; } - /** An interface describing the data returned by calling "chartLegendEntry.toJSON()". */ + /** An interface describing the data returned by calling `chartLegendEntry.toJSON()`. */ interface ChartLegendEntryData { /** * @@ -53296,11 +53442,11 @@ declare namespace Excel { */ width?: number; } - /** An interface describing the data returned by calling "chartLegendEntryCollection.toJSON()". */ + /** An interface describing the data returned by calling `chartLegendEntryCollection.toJSON()`. */ interface ChartLegendEntryCollectionData { items?: Excel.Interfaces.ChartLegendEntryData[]; } - /** An interface describing the data returned by calling "chartLegendFormat.toJSON()". */ + /** An interface describing the data returned by calling `chartLegendFormat.toJSON()`. */ interface ChartLegendFormatData { /** * @@ -53317,7 +53463,7 @@ declare namespace Excel { */ font?: Excel.Interfaces.ChartFontData; } - /** An interface describing the data returned by calling "chartMapOptions.toJSON()". */ + /** An interface describing the data returned by calling `chartMapOptions.toJSON()`. */ interface ChartMapOptionsData { /** * @@ -53341,7 +53487,7 @@ declare namespace Excel { */ projectionType?: Excel.ChartMapProjectionType | "Automatic" | "Mercator" | "Miller" | "Robinson" | "Albers"; } - /** An interface describing the data returned by calling "chartTitle.toJSON()". */ + /** An interface describing the data returned by calling `chartTitle.toJSON()`. */ interface ChartTitleData { /** * @@ -53435,7 +53581,7 @@ declare namespace Excel { */ width?: number; } - /** An interface describing the data returned by calling "chartFormatString.toJSON()". */ + /** An interface describing the data returned by calling `chartFormatString.toJSON()`. */ interface ChartFormatStringData { /** * @@ -53445,7 +53591,7 @@ declare namespace Excel { */ font?: Excel.Interfaces.ChartFontData; } - /** An interface describing the data returned by calling "chartTitleFormat.toJSON()". */ + /** An interface describing the data returned by calling `chartTitleFormat.toJSON()`. */ interface ChartTitleFormatData { /** * @@ -53462,7 +53608,7 @@ declare namespace Excel { */ font?: Excel.Interfaces.ChartFontData; } - /** An interface describing the data returned by calling "chartBorder.toJSON()". */ + /** An interface describing the data returned by calling `chartBorder.toJSON()`. */ interface ChartBorderData { /** * @@ -53486,7 +53632,7 @@ declare namespace Excel { */ weight?: number; } - /** An interface describing the data returned by calling "chartBinOptions.toJSON()". */ + /** An interface describing the data returned by calling `chartBinOptions.toJSON()`. */ interface ChartBinOptionsData { /** * @@ -53538,7 +53684,7 @@ declare namespace Excel { */ width?: number; } - /** An interface describing the data returned by calling "chartBoxwhiskerOptions.toJSON()". */ + /** An interface describing the data returned by calling `chartBoxwhiskerOptions.toJSON()`. */ interface ChartBoxwhiskerOptionsData { /** * @@ -53576,7 +53722,7 @@ declare namespace Excel { */ showOutlierPoints?: boolean; } - /** An interface describing the data returned by calling "chartLineFormat.toJSON()". */ + /** An interface describing the data returned by calling `chartLineFormat.toJSON()`. */ interface ChartLineFormatData { /** * @@ -53600,7 +53746,7 @@ declare namespace Excel { */ weight?: number; } - /** An interface describing the data returned by calling "chartFont.toJSON()". */ + /** An interface describing the data returned by calling `chartFont.toJSON()`. */ interface ChartFontData { /** * @@ -53645,7 +53791,7 @@ declare namespace Excel { */ underline?: Excel.ChartUnderlineStyle | "None" | "Single"; } - /** An interface describing the data returned by calling "chartTrendline.toJSON()". */ + /** An interface describing the data returned by calling `chartTrendline.toJSON()`. */ interface ChartTrendlineData { /** * @@ -53725,11 +53871,11 @@ declare namespace Excel { */ type?: Excel.ChartTrendlineType | "Linear" | "Exponential" | "Logarithmic" | "MovingAverage" | "Polynomial" | "Power"; } - /** An interface describing the data returned by calling "chartTrendlineCollection.toJSON()". */ + /** An interface describing the data returned by calling `chartTrendlineCollection.toJSON()`. */ interface ChartTrendlineCollectionData { items?: Excel.Interfaces.ChartTrendlineData[]; } - /** An interface describing the data returned by calling "chartTrendlineFormat.toJSON()". */ + /** An interface describing the data returned by calling `chartTrendlineFormat.toJSON()`. */ interface ChartTrendlineFormatData { /** * @@ -53739,7 +53885,7 @@ declare namespace Excel { */ line?: Excel.Interfaces.ChartLineFormatData; } - /** An interface describing the data returned by calling "chartTrendlineLabel.toJSON()". */ + /** An interface describing the data returned by calling `chartTrendlineLabel.toJSON()`. */ interface ChartTrendlineLabelData { /** * @@ -53772,7 +53918,7 @@ declare namespace Excel { /** * * Represents the horizontal alignment for chart trendline label. See Excel.ChartTextHorizontalAlignment for details. - This property is valid only when TextOrientation of trendline label is 90, -90 or 180. + This property is valid only when TextOrientation of trendline label is -90, 90, or 180. * * [Api set: ExcelApi 1.8] */ @@ -53835,7 +53981,7 @@ declare namespace Excel { */ width?: number; } - /** An interface describing the data returned by calling "chartTrendlineLabelFormat.toJSON()". */ + /** An interface describing the data returned by calling `chartTrendlineLabelFormat.toJSON()`. */ interface ChartTrendlineLabelFormatData { /** * @@ -53852,7 +53998,7 @@ declare namespace Excel { */ font?: Excel.Interfaces.ChartFontData; } - /** An interface describing the data returned by calling "chartPlotArea.toJSON()". */ + /** An interface describing the data returned by calling `chartPlotArea.toJSON()`. */ interface ChartPlotAreaData { /** * @@ -53925,7 +54071,7 @@ declare namespace Excel { */ width?: number; } - /** An interface describing the data returned by calling "chartPlotAreaFormat.toJSON()". */ + /** An interface describing the data returned by calling `chartPlotAreaFormat.toJSON()`. */ interface ChartPlotAreaFormatData { /** * @@ -53935,7 +54081,7 @@ declare namespace Excel { */ border?: Excel.Interfaces.ChartBorderData; } - /** An interface describing the data returned by calling "tableSort.toJSON()". */ + /** An interface describing the data returned by calling `tableSort.toJSON()`. */ interface TableSortData { /** * @@ -53959,7 +54105,7 @@ declare namespace Excel { */ method?: Excel.SortMethod | "PinYin" | "StrokeCount"; } - /** An interface describing the data returned by calling "filter.toJSON()". */ + /** An interface describing the data returned by calling `filter.toJSON()`. */ interface FilterData { /** * @@ -53969,7 +54115,7 @@ declare namespace Excel { */ criteria?: Excel.FilterCriteria; } - /** An interface describing the data returned by calling "autoFilter.toJSON()". */ + /** An interface describing the data returned by calling `autoFilter.toJSON()`. */ interface AutoFilterData { /** * @@ -53993,15 +54139,15 @@ declare namespace Excel { */ isDataFiltered?: boolean; } - /** An interface describing the data returned by calling "customXmlPartScopedCollection.toJSON()". */ + /** An interface describing the data returned by calling `customXmlPartScopedCollection.toJSON()`. */ interface CustomXmlPartScopedCollectionData { items?: Excel.Interfaces.CustomXmlPartData[]; } - /** An interface describing the data returned by calling "customXmlPartCollection.toJSON()". */ + /** An interface describing the data returned by calling `customXmlPartCollection.toJSON()`. */ interface CustomXmlPartCollectionData { items?: Excel.Interfaces.CustomXmlPartData[]; } - /** An interface describing the data returned by calling "customXmlPart.toJSON()". */ + /** An interface describing the data returned by calling `customXmlPart.toJSON()`. */ interface CustomXmlPartData { /** * @@ -54018,11 +54164,11 @@ declare namespace Excel { */ namespaceUri?: string; } - /** An interface describing the data returned by calling "pivotTableCollection.toJSON()". */ + /** An interface describing the data returned by calling `pivotTableCollection.toJSON()`. */ interface PivotTableCollectionData { items?: Excel.Interfaces.PivotTableData[]; } - /** An interface describing the data returned by calling "pivotTable.toJSON()". */ + /** An interface describing the data returned by calling `pivotTable.toJSON()`. */ interface PivotTableData { /** * @@ -54088,7 +54234,7 @@ declare namespace Excel { */ useCustomSortLists?: boolean; } - /** An interface describing the data returned by calling "pivotLayout.toJSON()". */ + /** An interface describing the data returned by calling `pivotLayout.toJSON()`. */ interface PivotLayoutData { /** * @@ -54141,11 +54287,11 @@ declare namespace Excel { */ subtotalLocation?: Excel.SubtotalLocationType | "AtTop" | "AtBottom" | "Off"; } - /** An interface describing the data returned by calling "pivotHierarchyCollection.toJSON()". */ + /** An interface describing the data returned by calling `pivotHierarchyCollection.toJSON()`. */ interface PivotHierarchyCollectionData { items?: Excel.Interfaces.PivotHierarchyData[]; } - /** An interface describing the data returned by calling "pivotHierarchy.toJSON()". */ + /** An interface describing the data returned by calling `pivotHierarchy.toJSON()`. */ interface PivotHierarchyData { /** * @@ -54169,11 +54315,11 @@ declare namespace Excel { */ name?: string; } - /** An interface describing the data returned by calling "rowColumnPivotHierarchyCollection.toJSON()". */ + /** An interface describing the data returned by calling `rowColumnPivotHierarchyCollection.toJSON()`. */ interface RowColumnPivotHierarchyCollectionData { items?: Excel.Interfaces.RowColumnPivotHierarchyData[]; } - /** An interface describing the data returned by calling "rowColumnPivotHierarchy.toJSON()". */ + /** An interface describing the data returned by calling `rowColumnPivotHierarchy.toJSON()`. */ interface RowColumnPivotHierarchyData { /** * @@ -54204,11 +54350,11 @@ declare namespace Excel { */ position?: number; } - /** An interface describing the data returned by calling "filterPivotHierarchyCollection.toJSON()". */ + /** An interface describing the data returned by calling `filterPivotHierarchyCollection.toJSON()`. */ interface FilterPivotHierarchyCollectionData { items?: Excel.Interfaces.FilterPivotHierarchyData[]; } - /** An interface describing the data returned by calling "filterPivotHierarchy.toJSON()". */ + /** An interface describing the data returned by calling `filterPivotHierarchy.toJSON()`. */ interface FilterPivotHierarchyData { /** * @@ -54246,11 +54392,11 @@ declare namespace Excel { */ position?: number; } - /** An interface describing the data returned by calling "dataPivotHierarchyCollection.toJSON()". */ + /** An interface describing the data returned by calling `dataPivotHierarchyCollection.toJSON()`. */ interface DataPivotHierarchyCollectionData { items?: Excel.Interfaces.DataPivotHierarchyData[]; } - /** An interface describing the data returned by calling "dataPivotHierarchy.toJSON()". */ + /** An interface describing the data returned by calling `dataPivotHierarchy.toJSON()`. */ interface DataPivotHierarchyData { /** * @@ -54302,11 +54448,11 @@ declare namespace Excel { */ summarizeBy?: Excel.AggregationFunction | "Unknown" | "Automatic" | "Sum" | "Count" | "Average" | "Max" | "Min" | "Product" | "CountNumbers" | "StandardDeviation" | "StandardDeviationP" | "Variance" | "VarianceP"; } - /** An interface describing the data returned by calling "pivotFieldCollection.toJSON()". */ + /** An interface describing the data returned by calling `pivotFieldCollection.toJSON()`. */ interface PivotFieldCollectionData { items?: Excel.Interfaces.PivotFieldData[]; } - /** An interface describing the data returned by calling "pivotField.toJSON()". */ + /** An interface describing the data returned by calling `pivotField.toJSON()`. */ interface PivotFieldData { /** * @@ -54344,11 +54490,11 @@ declare namespace Excel { */ subtotals?: Excel.Subtotals; } - /** An interface describing the data returned by calling "pivotItemCollection.toJSON()". */ + /** An interface describing the data returned by calling `pivotItemCollection.toJSON()`. */ interface PivotItemCollectionData { items?: Excel.Interfaces.PivotItemData[]; } - /** An interface describing the data returned by calling "pivotItem.toJSON()". */ + /** An interface describing the data returned by calling `pivotItem.toJSON()`. */ interface PivotItemData { /** * @@ -54379,7 +54525,7 @@ declare namespace Excel { */ visible?: boolean; } - /** An interface describing the data returned by calling "documentProperties.toJSON()". */ + /** An interface describing the data returned by calling `documentProperties.toJSON()`. */ interface DocumentPropertiesData { /** * @@ -54466,7 +54612,7 @@ declare namespace Excel { */ title?: string; } - /** An interface describing the data returned by calling "customProperty.toJSON()". */ + /** An interface describing the data returned by calling `customProperty.toJSON()`. */ interface CustomPropertyData { /** * @@ -54490,15 +54636,15 @@ declare namespace Excel { */ value?: any; } - /** An interface describing the data returned by calling "customPropertyCollection.toJSON()". */ + /** An interface describing the data returned by calling `customPropertyCollection.toJSON()`. */ interface CustomPropertyCollectionData { items?: Excel.Interfaces.CustomPropertyData[]; } - /** An interface describing the data returned by calling "conditionalFormatCollection.toJSON()". */ + /** An interface describing the data returned by calling `conditionalFormatCollection.toJSON()`. */ interface ConditionalFormatCollectionData { items?: Excel.Interfaces.ConditionalFormatData[]; } - /** An interface describing the data returned by calling "conditionalFormat.toJSON()". */ + /** An interface describing the data returned by calling `conditionalFormat.toJSON()`. */ interface ConditionalFormatData { /** * @@ -54652,7 +54798,7 @@ declare namespace Excel { */ type?: Excel.ConditionalFormatType | "Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" | "ContainsText" | "CellValue"; } - /** An interface describing the data returned by calling "dataBarConditionalFormat.toJSON()". */ + /** An interface describing the data returned by calling `dataBarConditionalFormat.toJSON()`. */ interface DataBarConditionalFormatData { /** * @@ -54693,6 +54839,7 @@ declare namespace Excel { /** * * The rule for what consistutes the lower bound (and how to calculate it, if applicable) for a data bar. + The `ConditionalDataBarRule` object must be set as a JSON object (use `x.lowerBoundRule = {...}` instead of `x.lowerBoundRule.formula = ...`). * * [Api set: ExcelApi 1.6] */ @@ -54707,12 +54854,13 @@ declare namespace Excel { /** * * The rule for what constitutes the upper bound (and how to calculate it, if applicable) for a data bar. + The `ConditionalDataBarRule` object must be set as a JSON object (use `x.upperBoundRule = {...}` instead of `x.upperBoundRule.formula = ...`). * * [Api set: ExcelApi 1.6] */ upperBoundRule?: Excel.ConditionalDataBarRule; } - /** An interface describing the data returned by calling "conditionalDataBarPositiveFormat.toJSON()". */ + /** An interface describing the data returned by calling `conditionalDataBarPositiveFormat.toJSON()`. */ interface ConditionalDataBarPositiveFormatData { /** * @@ -54737,7 +54885,7 @@ declare namespace Excel { */ gradientFill?: boolean; } - /** An interface describing the data returned by calling "conditionalDataBarNegativeFormat.toJSON()". */ + /** An interface describing the data returned by calling `conditionalDataBarNegativeFormat.toJSON()`. */ interface ConditionalDataBarNegativeFormatData { /** * @@ -54769,7 +54917,7 @@ declare namespace Excel { */ matchPositiveFillColor?: boolean; } - /** An interface describing the data returned by calling "customConditionalFormat.toJSON()". */ + /** An interface describing the data returned by calling `customConditionalFormat.toJSON()`. */ interface CustomConditionalFormatData { /** * @@ -54786,7 +54934,7 @@ declare namespace Excel { */ rule?: Excel.Interfaces.ConditionalFormatRuleData; } - /** An interface describing the data returned by calling "conditionalFormatRule.toJSON()". */ + /** An interface describing the data returned by calling `conditionalFormatRule.toJSON()`. */ interface ConditionalFormatRuleData { /** * @@ -54810,7 +54958,7 @@ declare namespace Excel { */ formulaR1C1?: string; } - /** An interface describing the data returned by calling "iconSetConditionalFormat.toJSON()". */ + /** An interface describing the data returned by calling `iconSetConditionalFormat.toJSON()`. */ interface IconSetConditionalFormatData { /** * @@ -54841,7 +54989,7 @@ declare namespace Excel { */ style?: Excel.IconSet | "Invalid" | "ThreeArrows" | "ThreeArrowsGray" | "ThreeFlags" | "ThreeTrafficLights1" | "ThreeTrafficLights2" | "ThreeSigns" | "ThreeSymbols" | "ThreeSymbols2" | "FourArrows" | "FourArrowsGray" | "FourRedToBlack" | "FourRating" | "FourTrafficLights" | "FiveArrows" | "FiveArrowsGray" | "FiveRating" | "FiveQuarters" | "ThreeStars" | "ThreeTriangles" | "FiveBoxes" | "LinkedEntityFinanceIcon" | "LinkedEntityMapIcon"; } - /** An interface describing the data returned by calling "colorScaleConditionalFormat.toJSON()". */ + /** An interface describing the data returned by calling `colorScaleConditionalFormat.toJSON()`. */ interface ColorScaleConditionalFormatData { /** * @@ -54858,7 +55006,7 @@ declare namespace Excel { */ threeColorScale?: boolean; } - /** An interface describing the data returned by calling "topBottomConditionalFormat.toJSON()". */ + /** An interface describing the data returned by calling `topBottomConditionalFormat.toJSON()`. */ interface TopBottomConditionalFormatData { /** * @@ -54875,7 +55023,7 @@ declare namespace Excel { */ rule?: Excel.ConditionalTopBottomRule; } - /** An interface describing the data returned by calling "presetCriteriaConditionalFormat.toJSON()". */ + /** An interface describing the data returned by calling `presetCriteriaConditionalFormat.toJSON()`. */ interface PresetCriteriaConditionalFormatData { /** * @@ -54892,7 +55040,7 @@ declare namespace Excel { */ rule?: Excel.ConditionalPresetCriteriaRule; } - /** An interface describing the data returned by calling "textConditionalFormat.toJSON()". */ + /** An interface describing the data returned by calling `textConditionalFormat.toJSON()`. */ interface TextConditionalFormatData { /** * @@ -54909,7 +55057,7 @@ declare namespace Excel { */ rule?: Excel.ConditionalTextComparisonRule; } - /** An interface describing the data returned by calling "cellValueConditionalFormat.toJSON()". */ + /** An interface describing the data returned by calling `cellValueConditionalFormat.toJSON()`. */ interface CellValueConditionalFormatData { /** * @@ -54926,7 +55074,7 @@ declare namespace Excel { */ rule?: Excel.ConditionalCellValueRule; } - /** An interface describing the data returned by calling "conditionalRangeFormat.toJSON()". */ + /** An interface describing the data returned by calling `conditionalRangeFormat.toJSON()`. */ interface ConditionalRangeFormatData { /** * @@ -54957,7 +55105,7 @@ declare namespace Excel { */ numberFormat?: any; } - /** An interface describing the data returned by calling "conditionalRangeFont.toJSON()". */ + /** An interface describing the data returned by calling `conditionalRangeFont.toJSON()`. */ interface ConditionalRangeFontData { /** * @@ -54995,7 +55143,7 @@ declare namespace Excel { */ underline?: Excel.ConditionalRangeFontUnderlineStyle | "None" | "Single" | "Double"; } - /** An interface describing the data returned by calling "conditionalRangeFill.toJSON()". */ + /** An interface describing the data returned by calling `conditionalRangeFill.toJSON()`. */ interface ConditionalRangeFillData { /** * @@ -55005,7 +55153,7 @@ declare namespace Excel { */ color?: string; } - /** An interface describing the data returned by calling "conditionalRangeBorder.toJSON()". */ + /** An interface describing the data returned by calling `conditionalRangeBorder.toJSON()`. */ interface ConditionalRangeBorderData { /** * @@ -55029,11 +55177,11 @@ declare namespace Excel { */ style?: Excel.ConditionalRangeBorderLineStyle | "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot"; } - /** An interface describing the data returned by calling "conditionalRangeBorderCollection.toJSON()". */ + /** An interface describing the data returned by calling `conditionalRangeBorderCollection.toJSON()`. */ interface ConditionalRangeBorderCollectionData { items?: Excel.Interfaces.ConditionalRangeBorderData[]; } - /** An interface describing the data returned by calling "style.toJSON()". */ + /** An interface describing the data returned by calling `style.toJSON()`. */ interface StyleData { /** * @@ -55197,15 +55345,15 @@ declare namespace Excel { */ wrapText?: boolean; } - /** An interface describing the data returned by calling "styleCollection.toJSON()". */ + /** An interface describing the data returned by calling `styleCollection.toJSON()`. */ interface StyleCollectionData { items?: Excel.Interfaces.StyleData[]; } - /** An interface describing the data returned by calling "tableStyleCollection.toJSON()". */ + /** An interface describing the data returned by calling `tableStyleCollection.toJSON()`. */ interface TableStyleCollectionData { items?: Excel.Interfaces.TableStyleData[]; } - /** An interface describing the data returned by calling "tableStyle.toJSON()". */ + /** An interface describing the data returned by calling `tableStyle.toJSON()`. */ interface TableStyleData { /** * @@ -55224,11 +55372,11 @@ declare namespace Excel { */ readOnly?: boolean; } - /** An interface describing the data returned by calling "pivotTableStyleCollection.toJSON()". */ + /** An interface describing the data returned by calling `pivotTableStyleCollection.toJSON()`. */ interface PivotTableStyleCollectionData { items?: Excel.Interfaces.PivotTableStyleData[]; } - /** An interface describing the data returned by calling "pivotTableStyle.toJSON()". */ + /** An interface describing the data returned by calling `pivotTableStyle.toJSON()`. */ interface PivotTableStyleData { /** * @@ -55247,11 +55395,11 @@ declare namespace Excel { */ readOnly?: boolean; } - /** An interface describing the data returned by calling "slicerStyleCollection.toJSON()". */ + /** An interface describing the data returned by calling `slicerStyleCollection.toJSON()`. */ interface SlicerStyleCollectionData { items?: Excel.Interfaces.SlicerStyleData[]; } - /** An interface describing the data returned by calling "slicerStyle.toJSON()". */ + /** An interface describing the data returned by calling `slicerStyle.toJSON()`. */ interface SlicerStyleData { /** * @@ -55270,11 +55418,11 @@ declare namespace Excel { */ readOnly?: boolean; } - /** An interface describing the data returned by calling "timelineStyleCollection.toJSON()". */ + /** An interface describing the data returned by calling `timelineStyleCollection.toJSON()`. */ interface TimelineStyleCollectionData { items?: Excel.Interfaces.TimelineStyleData[]; } - /** An interface describing the data returned by calling "timelineStyle.toJSON()". */ + /** An interface describing the data returned by calling `timelineStyle.toJSON()`. */ interface TimelineStyleData { /** * @@ -55293,7 +55441,7 @@ declare namespace Excel { */ readOnly?: boolean; } - /** An interface describing the data returned by calling "pageLayout.toJSON()". */ + /** An interface describing the data returned by calling `pageLayout.toJSON()`. */ interface PageLayoutData { /** * @@ -55431,12 +55579,13 @@ declare namespace Excel { /** * * Gets or sets the worksheet's print zoom options. + The `PageLayoutZoomOptions` object must be set as a JSON object (use `x.zoom = {...}` instead of `x.zoom.scale = ...`). * * [Api set: ExcelApi 1.9] */ zoom?: Excel.PageLayoutZoomOptions; } - /** An interface describing the data returned by calling "headerFooter.toJSON()". */ + /** An interface describing the data returned by calling `headerFooter.toJSON()`. */ interface HeaderFooterData { /** * @@ -55487,7 +55636,7 @@ declare namespace Excel { */ rightHeader?: string; } - /** An interface describing the data returned by calling "headerFooterGroup.toJSON()". */ + /** An interface describing the data returned by calling `headerFooterGroup.toJSON()`. */ interface HeaderFooterGroupData { /** * @@ -55539,7 +55688,7 @@ declare namespace Excel { */ useSheetScale?: boolean; } - /** An interface describing the data returned by calling "pageBreak.toJSON()". */ + /** An interface describing the data returned by calling `pageBreak.toJSON()`. */ interface PageBreakData { /** * @@ -55556,19 +55705,19 @@ declare namespace Excel { */ rowIndex?: number; } - /** An interface describing the data returned by calling "pageBreakCollection.toJSON()". */ + /** An interface describing the data returned by calling `pageBreakCollection.toJSON()`. */ interface PageBreakCollectionData { items?: Excel.Interfaces.PageBreakData[]; } - /** An interface describing the data returned by calling "rangeCollection.toJSON()". */ + /** An interface describing the data returned by calling `rangeCollection.toJSON()`. */ interface RangeCollectionData { items?: Excel.Interfaces.RangeData[]; } - /** An interface describing the data returned by calling "commentCollection.toJSON()". */ + /** An interface describing the data returned by calling `commentCollection.toJSON()`. */ interface CommentCollectionData { items?: Excel.Interfaces.CommentData[]; } - /** An interface describing the data returned by calling "comment.toJSON()". */ + /** An interface describing the data returned by calling `comment.toJSON()`. */ interface CommentData { /** * @@ -55618,6 +55767,14 @@ declare namespace Excel { * @beta */ id?: string; + /** + * + * Gets the entities (e.g. people) that are mentioned in comments. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + mentions?: Excel.CommentMention[]; /** * * Gets or sets the comment thread status. A value of "true" means the comment thread is in the resolved state. @@ -55626,12 +55783,20 @@ declare namespace Excel { * @beta */ resolved?: boolean; + /** + * + * Gets the rich comment content (e.g. mentions in comments). This string is not meant to be displayed to end-users. Your add-in should only use this to parse rich comment content. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + richContent?: string; } - /** An interface describing the data returned by calling "commentReplyCollection.toJSON()". */ + /** An interface describing the data returned by calling `commentReplyCollection.toJSON()`. */ interface CommentReplyCollectionData { items?: Excel.Interfaces.CommentReplyData[]; } - /** An interface describing the data returned by calling "commentReply.toJSON()". */ + /** An interface describing the data returned by calling `commentReply.toJSON()`. */ interface CommentReplyData { /** * @@ -55673,6 +55838,14 @@ declare namespace Excel { * @beta */ id?: string; + /** + * + * Gets the entities (e.g. people) that are mentioned in comments. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + mentions?: Excel.CommentMention[]; /** * * Gets or sets the comment reply status. A value of "true" means the comment reply is in the resolved state. @@ -55681,12 +55854,20 @@ declare namespace Excel { * @beta */ resolved?: boolean; + /** + * + * Gets the rich comment content (e.g. mentions in comments). This string is not meant to be displayed to end-users. Your add-in should only use this to parse rich comment content. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + richContent?: string; } - /** An interface describing the data returned by calling "shapeCollection.toJSON()". */ + /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */ interface ShapeCollectionData { items?: Excel.Interfaces.ShapeData[]; } - /** An interface describing the data returned by calling "shape.toJSON()". */ + /** An interface describing the data returned by calling `shape.toJSON()`. */ interface ShapeData { /** * @@ -55827,7 +56008,7 @@ declare namespace Excel { */ zOrderPosition?: number; } - /** An interface describing the data returned by calling "geometricShape.toJSON()". */ + /** An interface describing the data returned by calling `geometricShape.toJSON()`. */ interface GeometricShapeData { /** * @@ -55837,7 +56018,7 @@ declare namespace Excel { */ id?: string; } - /** An interface describing the data returned by calling "image.toJSON()". */ + /** An interface describing the data returned by calling `image.toJSON()`. */ interface ImageData { /** * @@ -55854,7 +56035,7 @@ declare namespace Excel { */ format?: Excel.PictureFormat | "UNKNOWN" | "BMP" | "JPEG" | "GIF" | "PNG" | "SVG"; } - /** An interface describing the data returned by calling "shapeGroup.toJSON()". */ + /** An interface describing the data returned by calling `shapeGroup.toJSON()`. */ interface ShapeGroupData { /** * @@ -55871,11 +56052,11 @@ declare namespace Excel { */ id?: string; } - /** An interface describing the data returned by calling "groupShapeCollection.toJSON()". */ + /** An interface describing the data returned by calling `groupShapeCollection.toJSON()`. */ interface GroupShapeCollectionData { items?: Excel.Interfaces.ShapeData[]; } - /** An interface describing the data returned by calling "line.toJSON()". */ + /** An interface describing the data returned by calling `line.toJSON()`. */ interface LineData { /** * @@ -55962,7 +56143,7 @@ declare namespace Excel { */ connectorType?: Excel.ConnectorType | "Straight" | "Elbow" | "Curve"; } - /** An interface describing the data returned by calling "shapeFill.toJSON()". */ + /** An interface describing the data returned by calling `shapeFill.toJSON()`. */ interface ShapeFillData { /** * @@ -55986,7 +56167,7 @@ declare namespace Excel { */ type?: Excel.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "Mixed"; } - /** An interface describing the data returned by calling "shapeLineFormat.toJSON()". */ + /** An interface describing the data returned by calling `shapeLineFormat.toJSON()`. */ interface ShapeLineFormatData { /** * @@ -56031,7 +56212,7 @@ declare namespace Excel { */ weight?: number; } - /** An interface describing the data returned by calling "textFrame.toJSON()". */ + /** An interface describing the data returned by calling `textFrame.toJSON()`. */ interface TextFrameData { /** * @@ -56118,7 +56299,7 @@ declare namespace Excel { */ verticalOverflow?: Excel.ShapeTextVerticalOverflow | "Overflow" | "Ellipsis" | "Clip"; } - /** An interface describing the data returned by calling "textRange.toJSON()". */ + /** An interface describing the data returned by calling `textRange.toJSON()`. */ interface TextRangeData { /** * @@ -56135,7 +56316,7 @@ declare namespace Excel { */ text?: string; } - /** An interface describing the data returned by calling "shapeFont.toJSON()". */ + /** An interface describing the data returned by calling `shapeFont.toJSON()`. */ interface ShapeFontData { /** * @@ -56180,7 +56361,7 @@ declare namespace Excel { */ underline?: Excel.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble"; } - /** An interface describing the data returned by calling "slicer.toJSON()". */ + /** An interface describing the data returned by calling `slicer.toJSON()`. */ interface SlicerData { /** * @@ -56209,7 +56390,7 @@ declare namespace Excel { /** * * Represents the height, in points, of the slicer. - Throws an invalid argument exception when set with negative value or zero as input. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value or zero as input. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -56234,7 +56415,7 @@ declare namespace Excel { /** * * Represents the distance, in points, from the left side of the slicer to the left of the worksheet. - Throws an invalid argument exception when set with negative value as input. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value as input. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -56258,7 +56439,7 @@ declare namespace Excel { nameInFormula?: string; /** * - * Represents the sort order of the items in the slicer. Possible values are: DataSourceOrder, Ascending, Descending. + * Represents the sort order of the items in the slicer. Possible values are: "DataSourceOrder", "Ascending", "Descending". * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -56275,7 +56456,7 @@ declare namespace Excel { /** * * Represents the distance, in points, from the top edge of the slicer to the top of the worksheet. - Throws an invalid argument exception when set with negative value as input. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value as input. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -56284,18 +56465,18 @@ declare namespace Excel { /** * * Represents the width, in points, of the slicer. - Throws an invalid argument exception when set with negative value or zero as input. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value or zero as input. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta */ width?: number; } - /** An interface describing the data returned by calling "slicerCollection.toJSON()". */ + /** An interface describing the data returned by calling `slicerCollection.toJSON()`. */ interface SlicerCollectionData { items?: Excel.Interfaces.SlicerData[]; } - /** An interface describing the data returned by calling "slicerItem.toJSON()". */ + /** An interface describing the data returned by calling `slicerItem.toJSON()`. */ interface SlicerItemData { /** * @@ -56332,11 +56513,11 @@ declare namespace Excel { */ name?: string; } - /** An interface describing the data returned by calling "slicerItemCollection.toJSON()". */ + /** An interface describing the data returned by calling `slicerItemCollection.toJSON()`. */ interface SlicerItemCollectionData { items?: Excel.Interfaces.SlicerItemData[]; } - /** An interface describing the data returned by calling "functionResult.toJSON()". */ + /** An interface describing the data returned by calling `functionResult.toJSON()`. */ interface FunctionResultData { /** * @@ -56360,6 +56541,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.5] */ interface RuntimeLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -56376,6 +56560,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ApplicationLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -56415,6 +56602,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface IterativeCalculationLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -56441,10 +56631,14 @@ declare namespace Excel { /** * * Workbook is the top level object which contains related workbook objects such as worksheets, tables, ranges, etc. + To learn more about the workbook object model, read {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-workbooks | Work with workbooks using the Excel JavaScript API}. * * [Api set: ExcelApi 1.1] */ interface WorkbookLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -56556,6 +56750,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.7] */ interface WorkbookProtectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -56568,10 +56765,14 @@ declare namespace Excel { /** * * An Excel worksheet is a grid of cells. It can contain data, tables, charts, etc. + To learn more about the worksheet object model, read {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-worksheets | Work with worksheets using the Excel JavaScript API}. * * [Api set: ExcelApi 1.1] */ interface WorksheetLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -56692,6 +56893,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface WorksheetCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -56812,6 +57016,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.2] */ interface WorksheetProtectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -56831,10 +57038,15 @@ declare namespace Excel { /** * * Range represents a set of one or more contiguous cells such as a cell, a row, a column, block of cells, etc. + To learn more about how ranges are used throughout the API, read {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-ranges | Work with ranges using the Excel JavaScript API} + and {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-ranges-advanced | Work with ranges using the Excel JavaScript API (advanced)}. * * [Api set: ExcelApi 1.1] */ interface RangeLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -56994,9 +57206,11 @@ declare namespace Excel { numberFormat?: boolean; /** * - * Represents Excel's number format code for the given range, based on the language settings of the user. - When setting number format local to a range, the value argument can be either a single value (string) or a two-dimensional array. If the argument is a single value, it will be applied to all cells in the range. - Excel does not perform any language or format coercion when getting or setting the `numberFormatLocal` property. Any returned text uses the locally-formatted strings based on the language specified in the system settings. + * Represents Excel's number format code for the given range, based on the language settings of the user.​ + When setting number format local to a range, the value argument can be either a single value (string) or a two-dimensional array. + If the argument is a single value, it will be applied to all cells in the range.​ + Excel does not perform any language or format coercion when getting or setting the `numberFormatLocal` property. + Any returned text uses the locally-formatted strings based on the language specified in the system settings. * * [Api set: ExcelApi 1.7] */ @@ -57025,8 +57239,8 @@ declare namespace Excel { /** * * Represents if ALL the cells would be saved as an array formula. - * Returns true if ALL cells would be saved as an array, or false if ALL cells would NOT be saved as an array formula. - * Returns null if there is a mixture of cells that would and would not be saved as an array formula. + Returns true if ALL cells would be saved as an array formula, or false if ALL cells would NOT be saved as an array formula. + Returns null if some cells would be saved as an array formula and some would not be. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -57083,10 +57297,14 @@ declare namespace Excel { /** * * RangeAreas represents a collection of one or more rectangular ranges in the same worksheet. + To learn how to use discontinguous ranges, read {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-multiple-ranges | Work with multiple ranges simultaneously in Excel add-ins}. * * [Api set: ExcelApi 1.9] */ interface RangeAreasLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -57168,6 +57386,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.3] */ interface RangeViewLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -57254,6 +57475,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.3] */ interface RangeViewCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -57340,6 +57564,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.4] */ interface SettingCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -57363,6 +57590,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.4] */ interface SettingLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -57386,6 +57616,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface NamedItemCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -57465,6 +57698,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface NamedItemLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -57544,6 +57780,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.7] */ interface NamedItemArrayValuesLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -57567,6 +57806,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface BindingLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -57590,6 +57832,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface BindingCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -57613,6 +57858,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface TableCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -57734,6 +57982,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface TableScopedCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -57851,10 +58102,14 @@ declare namespace Excel { /** * * Represents an Excel table. + To learn more about the table object model, read {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-tables | Work with tables using the Excel JavaScript API}. * * [Api set: ExcelApi 1.1] */ interface TableLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -57976,6 +58231,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface TableColumnCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -58020,6 +58278,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface TableColumnLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -58069,6 +58330,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface TableRowCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -58097,6 +58361,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface TableRowLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -58116,10 +58383,14 @@ declare namespace Excel { /** * * Represents the data validation applied to the current range. + To learn more about the data validation object model, read {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-data-validation | Add data validation to Excel ranges}. * * [Api set: ExcelApi 1.8] */ interface DataValidationLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -58173,6 +58444,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface RemoveDuplicatesResultLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -58196,6 +58470,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface RangeFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -58325,6 +58602,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.2] */ interface FormatProtectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -58348,10 +58628,13 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface RangeFillLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * - * HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange") + * HTML color code representing the color of the background, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange") * * [Api set: ExcelApi 1.1] */ @@ -58396,6 +58679,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface RangeBorderLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -58441,6 +58727,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface RangeBorderCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -58486,6 +58775,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface RangeFontLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -58572,6 +58864,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -58749,10 +59044,14 @@ declare namespace Excel { /** * * Represents a chart object in a workbook. + To learn more about the Chart object model, see {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-charts | Work with charts using the Excel JavaScript API}. * * [Api set: ExcelApi 1.1] */ interface ChartLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -58934,6 +59233,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface ChartPivotOptionsLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -58971,6 +59273,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartAreaFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -59008,6 +59313,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartSeriesCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -59334,6 +59642,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartSeriesLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -59660,6 +59971,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartSeriesFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -59676,6 +59990,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartPointsCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -59741,6 +60058,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartPointLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -59806,6 +60126,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartPointFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -59822,6 +60145,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartAxesLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -59852,6 +60178,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartAxisLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -60148,6 +60477,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartAxisFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -60171,6 +60503,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartAxisTitleLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -60201,6 +60536,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartAxisTitleFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -60224,6 +60562,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartDataLabelsLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -60327,7 +60668,7 @@ declare namespace Excel { /** * * Represents the vertical alignment of chart data label. See Excel.ChartTextVerticalAlignment for details. - This property is valid only when TextOrientation of data label is 90, -90 or 180. + This property is valid only when TextOrientation of data label is -90, 90, or 180. * * [Api set: ExcelApi 1.8] */ @@ -60340,6 +60681,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.7] */ interface ChartDataLabelLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -60372,7 +60716,7 @@ declare namespace Excel { /** * * Represents the horizontal alignment for chart data label. See Excel.ChartTextHorizontalAlignment for details. - This property is valid only when TextOrientation of data label is 90, -90 or 180. + This property is valid only when TextOrientation of data label is -90, 90, or 180. * * [Api set: ExcelApi 1.8] */ @@ -60498,6 +60842,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartDataLabelFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -60521,6 +60868,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface ChartErrorBarsLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -60565,6 +60915,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface ChartErrorBarsFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -60581,6 +60934,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartGridlinesLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -60604,6 +60960,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartGridlinesFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -60620,6 +60979,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartLegendLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -60692,6 +61054,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.7] */ interface ChartLegendEntryLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -60743,6 +61108,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.7] */ interface ChartLegendEntryCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -60794,6 +61162,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartLegendFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -60817,6 +61188,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface ChartMapOptionsLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -60847,6 +61221,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartTitleLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -60947,6 +61324,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.7] */ interface ChartFormatStringLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -60963,6 +61343,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartTitleFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -60986,6 +61369,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.7] */ interface ChartBorderLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -61016,6 +61402,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface ChartBinOptionsLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -61074,6 +61463,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface ChartBoxwhiskerOptionsLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -61118,6 +61510,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartLineFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -61148,6 +61543,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartFontLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -61199,6 +61597,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.7] */ interface ChartTrendlineLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -61285,6 +61686,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.7] */ interface ChartTrendlineCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -61371,6 +61775,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.7] */ interface ChartTrendlineFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -61387,6 +61794,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.8] */ interface ChartTrendlineLabelLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -61419,7 +61829,7 @@ declare namespace Excel { /** * * Represents the horizontal alignment for chart trendline label. See Excel.ChartTextHorizontalAlignment for details. - This property is valid only when TextOrientation of trendline label is 90, -90 or 180. + This property is valid only when TextOrientation of trendline label is -90, 90, or 180. * * [Api set: ExcelApi 1.8] */ @@ -61489,6 +61899,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.8] */ interface ChartTrendlineLabelFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -61512,6 +61925,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.8] */ interface ChartPlotAreaLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -61591,6 +62007,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.8] */ interface ChartPlotAreaFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -61607,6 +62026,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.2] */ interface TableSortLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -61637,6 +62059,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.2] */ interface FilterLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -61654,6 +62079,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface AutoFilterLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -61686,6 +62114,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.5] */ interface CustomXmlPartScopedCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -61709,6 +62140,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.5] */ interface CustomXmlPartCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -61732,6 +62166,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.5] */ interface CustomXmlPartLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -61755,6 +62192,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.3] */ interface PivotTableCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -61802,10 +62242,14 @@ declare namespace Excel { /** * * Represents an Excel PivotTable. + To learn more about the PivotTable object model, read {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-pivottables | Work with PivotTables using the Excel JavaScript API}. * * [Api set: ExcelApi 1.3] */ interface PivotTableLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -61857,6 +62301,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.8] */ interface PivotLayoutLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -61916,6 +62363,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.8] */ interface PivotHierarchyCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -61939,6 +62389,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.8] */ interface PivotHierarchyLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -61962,6 +62415,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.8] */ interface RowColumnPivotHierarchyCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -61992,6 +62448,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.8] */ interface RowColumnPivotHierarchyLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -62022,6 +62481,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.8] */ interface FilterPivotHierarchyCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -62059,6 +62521,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.8] */ interface FilterPivotHierarchyLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -62096,6 +62561,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.8] */ interface DataPivotHierarchyCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -62154,6 +62622,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.8] */ interface DataPivotHierarchyLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -62212,6 +62683,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.8] */ interface PivotFieldCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -62249,6 +62723,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.8] */ interface PivotFieldLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -62286,6 +62763,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.8] */ interface PivotItemCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -62323,6 +62803,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.8] */ interface PivotItemLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -62360,6 +62843,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.7] */ interface DocumentPropertiesLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -62446,6 +62932,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.7] */ interface CustomPropertyLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -62476,6 +62965,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.7] */ interface CustomPropertyCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -62506,6 +62998,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.6] */ interface ConditionalFormatCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -62662,10 +63157,14 @@ declare namespace Excel { /** * * An object encapsulating a conditional format's range, format, rule, and other properties. + To learn more about the conditional formatting object model, read {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-conditional-formatting | Apply conditional formatting to Excel ranges}. * * [Api set: ExcelApi 1.6] */ interface ConditionalFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -62826,6 +63325,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.6] */ interface DataBarConditionalFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -62866,6 +63368,7 @@ declare namespace Excel { /** * * The rule for what consistutes the lower bound (and how to calculate it, if applicable) for a data bar. + The `ConditionalDataBarRule` object must be set as a JSON object (use `x.lowerBoundRule = {...}` instead of `x.lowerBoundRule.formula = ...`). * * [Api set: ExcelApi 1.6] */ @@ -62880,6 +63383,7 @@ declare namespace Excel { /** * * The rule for what constitutes the upper bound (and how to calculate it, if applicable) for a data bar. + The `ConditionalDataBarRule` object must be set as a JSON object (use `x.upperBoundRule = {...}` instead of `x.upperBoundRule.formula = ...`). * * [Api set: ExcelApi 1.6] */ @@ -62892,6 +63396,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.6] */ interface ConditionalDataBarPositiveFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -62923,6 +63430,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.6] */ interface ConditionalDataBarNegativeFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -62961,6 +63471,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.6] */ interface CustomConditionalFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -62984,6 +63497,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.6] */ interface ConditionalFormatRuleLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -63014,6 +63530,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.6] */ interface IconSetConditionalFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -63051,6 +63570,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.6] */ interface ColorScaleConditionalFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -63074,6 +63596,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.6] */ interface TopBottomConditionalFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -63097,6 +63622,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.6] */ interface PresetCriteriaConditionalFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -63120,6 +63648,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.6] */ interface TextConditionalFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -63143,6 +63674,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.6] */ interface CellValueConditionalFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -63166,6 +63700,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.6] */ interface ConditionalRangeFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -63203,6 +63740,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.6] */ interface ConditionalRangeFontLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -63247,6 +63787,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.6] */ interface ConditionalRangeFillLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -63263,6 +63806,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.6] */ interface ConditionalRangeBorderLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -63293,6 +63839,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.6] */ interface ConditionalRangeBorderCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -63323,6 +63872,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.7] */ interface StyleLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -63493,6 +64045,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.7] */ interface StyleCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -63664,6 +64219,9 @@ declare namespace Excel { * @beta */ interface TableStyleCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -63690,6 +64248,9 @@ declare namespace Excel { * @beta */ interface TableStyleLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -63716,6 +64277,9 @@ declare namespace Excel { * @beta */ interface PivotTableStyleCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -63742,6 +64306,9 @@ declare namespace Excel { * @beta */ interface PivotTableStyleLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -63768,6 +64335,9 @@ declare namespace Excel { * @beta */ interface SlicerStyleCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -63794,6 +64364,9 @@ declare namespace Excel { * @beta */ interface SlicerStyleLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -63820,6 +64393,9 @@ declare namespace Excel { * @beta */ interface TimelineStyleCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -63846,6 +64422,9 @@ declare namespace Excel { * @beta */ interface TimelineStyleLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -63865,9 +64444,15 @@ declare namespace Excel { readOnly?: boolean; } /** + * + * Represents layout and print settings that are not dependent any printer-specific implementation. These settings include margins, orientation, page numbering, title rows, and print area. + * * [Api set: ExcelApi 1.9] */ interface PageLayoutLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -64005,6 +64590,7 @@ declare namespace Excel { /** * * Gets or sets the worksheet's print zoom options. + The `PageLayoutZoomOptions` object must be set as a JSON object (use `x.zoom = {...}` instead of `x.zoom.scale = ...`). * * [Api set: ExcelApi 1.9] */ @@ -64014,6 +64600,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface HeaderFooterLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -64068,6 +64657,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface HeaderFooterGroupLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -64123,6 +64715,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface PageBreakLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -64143,6 +64738,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface PageBreakCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -64163,6 +64761,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface RangeCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -64322,9 +64923,11 @@ declare namespace Excel { numberFormat?: boolean; /** * - * For EACH ITEM in the collection: Represents Excel's number format code for the given range, based on the language settings of the user. - When setting number format local to a range, the value argument can be either a single value (string) or a two-dimensional array. If the argument is a single value, it will be applied to all cells in the range. - Excel does not perform any language or format coercion when getting or setting the `numberFormatLocal` property. Any returned text uses the locally-formatted strings based on the language specified in the system settings. + * For EACH ITEM in the collection: Represents Excel's number format code for the given range, based on the language settings of the user.​ + When setting number format local to a range, the value argument can be either a single value (string) or a two-dimensional array. + If the argument is a single value, it will be applied to all cells in the range.​ + Excel does not perform any language or format coercion when getting or setting the `numberFormatLocal` property. + Any returned text uses the locally-formatted strings based on the language specified in the system settings. * * [Api set: ExcelApi 1.7] */ @@ -64353,8 +64956,8 @@ declare namespace Excel { /** * * For EACH ITEM in the collection: Represents if ALL the cells would be saved as an array formula. - * Returns true if ALL cells would be saved as an array, or false if ALL cells would NOT be saved as an array formula. - * Returns null if there is a mixture of cells that would and would not be saved as an array formula. + Returns true if ALL cells would be saved as an array formula, or false if ALL cells would NOT be saved as an array formula. + Returns null if some cells would be saved as an array formula and some would not be. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -64416,6 +65019,9 @@ declare namespace Excel { * @beta */ interface CommentCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -64457,6 +65063,14 @@ declare namespace Excel { * @beta */ id?: boolean; + /** + * + * For EACH ITEM in the collection: Gets the entities (e.g. people) that are mentioned in comments. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + mentions?: boolean; /** * * For EACH ITEM in the collection: Gets or sets the comment thread status. A value of "true" means the comment thread is in the resolved state. @@ -64465,15 +65079,26 @@ declare namespace Excel { * @beta */ resolved?: boolean; + /** + * + * For EACH ITEM in the collection: Gets the rich comment content (e.g. mentions in comments). This string is not meant to be displayed to end-users. Your add-in should only use this to parse rich comment content. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + richContent?: boolean; } /** * - * Represents a cell comment object in the workbook. + * Represents a comment in the workbook. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta */ interface CommentLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -64515,6 +65140,14 @@ declare namespace Excel { * @beta */ id?: boolean; + /** + * + * Gets the entities (e.g. people) that are mentioned in comments. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + mentions?: boolean; /** * * Gets or sets the comment thread status. A value of "true" means the comment thread is in the resolved state. @@ -64523,6 +65156,14 @@ declare namespace Excel { * @beta */ resolved?: boolean; + /** + * + * Gets the rich comment content (e.g. mentions in comments). This string is not meant to be displayed to end-users. Your add-in should only use this to parse rich comment content. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + richContent?: boolean; } /** * @@ -64532,6 +65173,9 @@ declare namespace Excel { * @beta */ interface CommentReplyCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -64573,6 +65217,14 @@ declare namespace Excel { * @beta */ id?: boolean; + /** + * + * For EACH ITEM in the collection: Gets the entities (e.g. people) that are mentioned in comments. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + mentions?: boolean; /** * * For EACH ITEM in the collection: Gets or sets the comment reply status. A value of "true" means the comment reply is in the resolved state. @@ -64581,15 +65233,26 @@ declare namespace Excel { * @beta */ resolved?: boolean; + /** + * + * For EACH ITEM in the collection: Gets the rich comment content (e.g. mentions in comments). This string is not meant to be displayed to end-users. Your add-in should only use this to parse rich comment content. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + richContent?: boolean; } /** * - * Represents a cell comment reply object in the workbook. + * Represents a comment reply in the workbook. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta */ interface CommentReplyLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -64631,6 +65294,14 @@ declare namespace Excel { * @beta */ id?: boolean; + /** + * + * Gets the entities (e.g. people) that are mentioned in comments. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + mentions?: boolean; /** * * Gets or sets the comment reply status. A value of "true" means the comment reply is in the resolved state. @@ -64639,6 +65310,14 @@ declare namespace Excel { * @beta */ resolved?: boolean; + /** + * + * Gets the rich comment content (e.g. mentions in comments). This string is not meant to be displayed to end-users. Your add-in should only use this to parse rich comment content. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + richContent?: boolean; } /** * @@ -64647,6 +65326,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface ShapeCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -64832,10 +65514,14 @@ declare namespace Excel { /** * * Represents a generic shape object in the worksheet. A shape could be a geometric shape, a line, a group of shapes, etc. + To learn more about the shape object model, read {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-shapes | Work with shapes using the Excel JavaScript API}. * * [Api set: ExcelApi 1.9] */ interface ShapeLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -65025,6 +65711,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface GeometricShapeLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -65048,6 +65737,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface ImageLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -65078,6 +65770,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface ShapeGroupLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -65101,6 +65796,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface GroupShapeCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -65290,6 +65988,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface LineLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -65404,6 +66105,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface ShapeFillLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -65434,6 +66138,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface ShapeLineFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -65485,6 +66192,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface TextFrameLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -65585,6 +66295,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface TextRangeLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -65608,6 +66321,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface ShapeFontLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -65660,6 +66376,9 @@ declare namespace Excel { * @beta */ interface SlicerLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -65680,7 +66399,7 @@ declare namespace Excel { /** * * Represents the height, in points, of the slicer. - Throws an invalid argument exception when set with negative value or zero as input. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value or zero as input. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -65705,7 +66424,7 @@ declare namespace Excel { /** * * Represents the distance, in points, from the left side of the slicer to the left of the worksheet. - Throws an invalid argument exception when set with negative value as input. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value as input. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -65729,7 +66448,7 @@ declare namespace Excel { nameInFormula?: boolean; /** * - * Represents the sort order of the items in the slicer. Possible values are: DataSourceOrder, Ascending, Descending. + * Represents the sort order of the items in the slicer. Possible values are: "DataSourceOrder", "Ascending", "Descending". * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -65746,7 +66465,7 @@ declare namespace Excel { /** * * Represents the distance, in points, from the top edge of the slicer to the top of the worksheet. - Throws an invalid argument exception when set with negative value as input. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value as input. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -65755,7 +66474,7 @@ declare namespace Excel { /** * * Represents the width, in points, of the slicer. - Throws an invalid argument exception when set with negative value or zero as input. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value or zero as input. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -65770,6 +66489,9 @@ declare namespace Excel { * @beta */ interface SlicerCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -65790,7 +66512,7 @@ declare namespace Excel { /** * * For EACH ITEM in the collection: Represents the height, in points, of the slicer. - Throws an invalid argument exception when set with negative value or zero as input. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value or zero as input. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -65815,7 +66537,7 @@ declare namespace Excel { /** * * For EACH ITEM in the collection: Represents the distance, in points, from the left side of the slicer to the left of the worksheet. - Throws an invalid argument exception when set with negative value as input. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value as input. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -65839,7 +66561,7 @@ declare namespace Excel { nameInFormula?: boolean; /** * - * For EACH ITEM in the collection: Represents the sort order of the items in the slicer. Possible values are: DataSourceOrder, Ascending, Descending. + * For EACH ITEM in the collection: Represents the sort order of the items in the slicer. Possible values are: "DataSourceOrder", "Ascending", "Descending". * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -65856,7 +66578,7 @@ declare namespace Excel { /** * * For EACH ITEM in the collection: Represents the distance, in points, from the top edge of the slicer to the top of the worksheet. - Throws an invalid argument exception when set with negative value as input. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value as input. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -65865,7 +66587,7 @@ declare namespace Excel { /** * * For EACH ITEM in the collection: Represents the width, in points, of the slicer. - Throws an invalid argument exception when set with negative value or zero as input. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value or zero as input. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -65880,6 +66602,9 @@ declare namespace Excel { * @beta */ interface SlicerItemLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -65924,6 +66649,9 @@ declare namespace Excel { * @beta */ interface SlicerItemCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -65967,6 +66695,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.2] */ interface FunctionResultLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -66080,7 +66811,7 @@ declare namespace Word { readonly paragraphs: Word.ParagraphCollection; /** * - * Gets the parent body of the body. For example, a table cell body's parent body could be a header. Throws if there isn't a parent body. Read-only. + * Gets the parent body of the body. For example, a table cell body's parent body could be a header. Throws an error if there isn't a parent body. Read-only. * * [Api set: WordApi 1.3] */ @@ -66094,7 +66825,7 @@ declare namespace Word { readonly parentBodyOrNullObject: Word.Body; /** * - * Gets the content control that contains the body. Throws if there isn't a parent content control. Read-only. + * Gets the content control that contains the body. Throws an error if there isn't a parent content control. Read-only. * * [Api set: WordApi 1.1] */ @@ -66108,7 +66839,7 @@ declare namespace Word { readonly parentContentControlOrNullObject: Word.ContentControl; /** * - * Gets the parent section of the body. Throws if there isn't a parent section. Read-only. + * Gets the parent section of the body. Throws an error if there isn't a parent section. Read-only. * * [Api set: WordApi 1.3] */ @@ -66178,7 +66909,7 @@ declare namespace Word { clear(): void; /** * - * Gets an HTML representation of the body object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match to the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, etc.). If you need exact fidelity, or consistency across platforms, use `Body.getOoxml()` and convert the returned XML to HTML. + * Gets an HTML representation of the body object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, Word for the web, etc.). If you need exact fidelity, or consistency across platforms, use `Body.getOoxml()` and convert the returned XML to HTML. * * [Api set: WordApi 1.1] */ @@ -66210,7 +66941,7 @@ declare namespace Word { getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range; /** * - * Inserts a break at the specified location in the main document. The insertLocation value can be 'Start' or 'End'. + * Inserts a break at the specified location in the main document. * * [Api set: WordApi 1.1] * @@ -66220,7 +66951,7 @@ declare namespace Word { insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void; /** * - * Inserts a break at the specified location in the main document. The insertLocation value can be 'Start' or 'End'. + * Inserts a break at the specified location in the main document. * * [Api set: WordApi 1.1] * @@ -66237,7 +66968,7 @@ declare namespace Word { insertContentControl(): Word.ContentControl; /** * - * Inserts a document into the body at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts a document into the body at the specified location. * * [Api set: WordApi 1.1] * @@ -66247,7 +66978,7 @@ declare namespace Word { insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts a document into the body at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts a document into the body at the specified location. * * [Api set: WordApi 1.1] * @@ -66257,7 +66988,7 @@ declare namespace Word { insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range; /** * - * Inserts HTML at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts HTML at the specified location. * * [Api set: WordApi 1.1] * @@ -66267,7 +66998,7 @@ declare namespace Word { insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts HTML at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts HTML at the specified location. * * [Api set: WordApi 1.1] * @@ -66277,7 +67008,7 @@ declare namespace Word { insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range; /** * - * Inserts a picture into the body at the specified location. The insertLocation value can be 'Start' or 'End'. + * Inserts a picture into the body at the specified location. * * [Api set: WordApi 1.2] * @@ -66287,7 +67018,7 @@ declare namespace Word { insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture; /** * - * Inserts a picture into the body at the specified location. The insertLocation value can be 'Start' or 'End'. + * Inserts a picture into the body at the specified location. * * [Api set: WordApi 1.2] * @@ -66297,7 +67028,7 @@ declare namespace Word { insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.InlinePicture; /** * - * Inserts OOXML at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts OOXML at the specified location. * * [Api set: WordApi 1.1] * @@ -66307,7 +67038,7 @@ declare namespace Word { insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts OOXML at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts OOXML at the specified location. * * [Api set: WordApi 1.1] * @@ -66317,7 +67048,7 @@ declare namespace Word { insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range; /** * - * Inserts a paragraph at the specified location. The insertLocation value can be 'Start' or 'End'. + * Inserts a paragraph at the specified location. * * [Api set: WordApi 1.1] * @@ -66327,7 +67058,7 @@ declare namespace Word { insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph; /** * - * Inserts a paragraph at the specified location. The insertLocation value can be 'Start' or 'End'. + * Inserts a paragraph at the specified location. * * [Api set: WordApi 1.1] * @@ -66337,7 +67068,7 @@ declare namespace Word { insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph; /** * - * Inserts a table with the specified number of rows and columns. The insertLocation value can be 'Start' or 'End'. + * Inserts a table with the specified number of rows and columns. * * [Api set: WordApi 1.3] * @@ -66349,7 +67080,7 @@ declare namespace Word { insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table; /** * - * Inserts a table with the specified number of rows and columns. The insertLocation value can be 'Start' or 'End'. + * Inserts a table with the specified number of rows and columns. * * [Api set: WordApi 1.3] * @@ -66361,7 +67092,7 @@ declare namespace Word { insertTable(rowCount: number, columnCount: number, insertLocation: "Before" | "After" | "Start" | "End" | "Replace", values?: string[][]): Word.Table; /** * - * Inserts text into the body at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts text into the body at the specified location. * * [Api set: WordApi 1.1] * @@ -66371,7 +67102,7 @@ declare namespace Word { insertText(text: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts text into the body at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts text into the body at the specified location. * * [Api set: WordApi 1.1] * @@ -66503,7 +67234,7 @@ declare namespace Word { readonly parentBody: Word.Body; /** * - * Gets the content control that contains the content control. Throws if there isn't a parent content control. Read-only. + * Gets the content control that contains the content control. Throws an error if there isn't a parent content control. Read-only. * * [Api set: WordApi 1.1] */ @@ -66517,14 +67248,14 @@ declare namespace Word { readonly parentContentControlOrNullObject: Word.ContentControl; /** * - * Gets the table that contains the content control. Throws if it is not contained in a table. Read-only. + * Gets the table that contains the content control. Throws an error if it is not contained in a table. Read-only. * * [Api set: WordApi 1.3] */ readonly parentTable: Word.Table; /** * - * Gets the table cell that contains the content control. Throws if it is not contained in a table cell. Read-only. + * Gets the table cell that contains the content control. Throws an error if it is not contained in a table cell. Read-only. * * [Api set: WordApi 1.3] */ @@ -66680,7 +67411,7 @@ declare namespace Word { delete(keepContent: boolean): void; /** * - * Gets an HTML representation of the content control object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match to the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, etc.). If you need exact fidelity, or consistency across platforms, use `ContentControl.getOoxml()` and convert the returned XML to HTML. + * Gets an HTML representation of the content control object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, Word for the web, etc.). If you need exact fidelity, or consistency across platforms, use `ContentControl.getOoxml()` and convert the returned XML to HTML. * * [Api set: WordApi 1.1] */ @@ -66722,7 +67453,7 @@ declare namespace Word { getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection; /** * - * Inserts a break at the specified location in the main document. The insertLocation value can be 'Start', 'End', 'Before', or 'After'. This method cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls. + * Inserts a break at the specified location in the main document. This method cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls. * * [Api set: WordApi 1.1] * @@ -66732,7 +67463,7 @@ declare namespace Word { insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void; /** * - * Inserts a break at the specified location in the main document. The insertLocation value can be 'Start', 'End', 'Before', or 'After'. This method cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls. + * Inserts a break at the specified location in the main document. This method cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls. * * [Api set: WordApi 1.1] * @@ -66742,7 +67473,7 @@ declare namespace Word { insertBreak(breakType: "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): void; /** * - * Inserts a document into the content control at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts a document into the content control at the specified location. * * [Api set: WordApi 1.1] * @@ -66752,7 +67483,7 @@ declare namespace Word { insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts a document into the content control at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts a document into the content control at the specified location. * * [Api set: WordApi 1.1] * @@ -66762,7 +67493,7 @@ declare namespace Word { insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range; /** * - * Inserts HTML into the content control at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts HTML into the content control at the specified location. * * [Api set: WordApi 1.1] * @@ -66772,7 +67503,7 @@ declare namespace Word { insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts HTML into the content control at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts HTML into the content control at the specified location. * * [Api set: WordApi 1.1] * @@ -66782,7 +67513,7 @@ declare namespace Word { insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range; /** * - * Inserts an inline picture into the content control at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts an inline picture into the content control at the specified location. * * [Api set: WordApi 1.2] * @@ -66792,7 +67523,7 @@ declare namespace Word { insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture; /** * - * Inserts an inline picture into the content control at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts an inline picture into the content control at the specified location. * * [Api set: WordApi 1.2] * @@ -66802,7 +67533,7 @@ declare namespace Word { insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.InlinePicture; /** * - * Inserts OOXML into the content control at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts OOXML into the content control at the specified location. * * [Api set: WordApi 1.1] * @@ -66812,7 +67543,7 @@ declare namespace Word { insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts OOXML into the content control at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts OOXML into the content control at the specified location. * * [Api set: WordApi 1.1] * @@ -66822,7 +67553,7 @@ declare namespace Word { insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range; /** * - * Inserts a paragraph at the specified location. The insertLocation value can be 'Start', 'End', 'Before', or 'After'. + * Inserts a paragraph at the specified location. * * [Api set: WordApi 1.1] * @@ -66832,7 +67563,7 @@ declare namespace Word { insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph; /** * - * Inserts a paragraph at the specified location. The insertLocation value can be 'Start', 'End', 'Before', or 'After'. + * Inserts a paragraph at the specified location. * * [Api set: WordApi 1.1] * @@ -66842,7 +67573,7 @@ declare namespace Word { insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph; /** * - * Inserts a table with the specified number of rows and columns into, or next to, a content control. The insertLocation value can be 'Start', 'End', 'Before', or 'After'. + * Inserts a table with the specified number of rows and columns into, or next to, a content control. * * [Api set: WordApi 1.3] * @@ -66854,7 +67585,7 @@ declare namespace Word { insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table; /** * - * Inserts a table with the specified number of rows and columns into, or next to, a content control. The insertLocation value can be 'Start', 'End', 'Before', or 'After'. + * Inserts a table with the specified number of rows and columns into, or next to, a content control. * * [Api set: WordApi 1.3] * @@ -66866,7 +67597,7 @@ declare namespace Word { insertTable(rowCount: number, columnCount: number, insertLocation: "Before" | "After" | "Start" | "End" | "Replace", values?: string[][]): Word.Table; /** * - * Inserts text into the content control at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts text into the content control at the specified location. * * [Api set: WordApi 1.1] * @@ -66876,7 +67607,7 @@ declare namespace Word { insertText(text: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts text into the content control at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts text into the content control at the specified location. * * [Api set: WordApi 1.1] * @@ -67010,7 +67741,7 @@ declare namespace Word { readonly items: Word.ContentControl[]; /** * - * Gets a content control by its identifier. Throws if there isn't a content control with the identifier in this collection. + * Gets a content control by its identifier. Throws an error if there isn't a content control with the identifier in this collection. * * [Api set: WordApi 1.1] * @@ -67055,7 +67786,7 @@ declare namespace Word { getByTypes(types: Word.ContentControlType[]): Word.ContentControlCollection; /** * - * Gets the first content control in this collection. Throws if this collection is empty. + * Gets the first content control in this collection. Throws an error if this collection is empty. * * [Api set: WordApi 1.3] */ @@ -67133,7 +67864,7 @@ declare namespace Word { readonly type: Word.DocumentPropertyType | "String" | "Number" | "Date" | "Boolean"; /** * - * Gets or sets the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * Gets or sets the value of the custom property. Note that even though Word for the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). * * [Api set: WordApi 1.3] */ @@ -67231,7 +67962,7 @@ declare namespace Word { getCount(): OfficeExtension.ClientResult; /** * - * Gets a custom property object by its key, which is case-insensitive. Throws if the custom property does not exist. + * Gets a custom property object by its key, which is case-insensitive. Throws an error if the custom property does not exist. * * [Api set: WordApi 1.3] * @@ -67708,7 +68439,7 @@ declare namespace Word { set(properties: Word.Document): void; /** * - * Deletes a bookmark, if exists, from the document. + * Deletes a bookmark, if it exists, from the document. * * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta @@ -67718,7 +68449,7 @@ declare namespace Word { deleteBookmark(name: string): void; /** * - * Gets a bookmark's range. Throws if the bookmark does not exist. + * Gets a bookmark's range. Throws an error if the bookmark does not exist. * * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta @@ -67745,7 +68476,7 @@ declare namespace Word { getSelection(): Word.Range; /** * - * Saves the document. This will use the Word default file naming convention if the document has not been saved before. + * Saves the document. This uses the Word default file naming convention if the document has not been saved before. * * [Api set: WordApi 1.1] */ @@ -67876,7 +68607,7 @@ declare namespace Word { set(properties: Word.DocumentCreated): void; /** * - * Deletes a bookmark, if exists, from the document. + * Deletes a bookmark, if it exists, from the document. * * [Api set: WordApiHiddenDocument 1.4] * @beta @@ -67886,7 +68617,7 @@ declare namespace Word { deleteBookmark(name: string): void; /** * - * Gets a bookmark's range. Throws if the bookmark does not exist. + * Gets a bookmark's range. Throws an error if the bookmark does not exist. * * [Api set: WordApiHiddenDocument 1.4] * @beta @@ -67913,7 +68644,7 @@ declare namespace Word { open(): void; /** * - * Saves the document. This will use the Word default file naming convention if the document has not been saved before. + * Saves the document. This uses the Word default file naming convention if the document has not been saved before. * * [Api set: WordApiHiddenDocument 1.3] * @beta @@ -68171,11 +68902,8 @@ declare namespace Word { /** * * Gets or sets the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or null for no highlight color. + **Note**: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. * - * **Note**: Only the default highlight colors are available in Office on Windows Desktop. - * These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". - * When the add-in runs in Office on Windows Desktop, any other color is converted to the closest color when applied to the font. - * * [Api set: WordApi 1.1] */ highlightColor: string; @@ -68295,7 +69023,7 @@ declare namespace Word { readonly paragraph: Word.Paragraph; /** * - * Gets the content control that contains the inline image. Throws if there isn't a parent content control. Read-only. + * Gets the content control that contains the inline image. Throws an error if there isn't a parent content control. Read-only. * * [Api set: WordApi 1.1] */ @@ -68309,14 +69037,14 @@ declare namespace Word { readonly parentContentControlOrNullObject: Word.ContentControl; /** * - * Gets the table that contains the inline image. Throws if it is not contained in a table. Read-only. + * Gets the table that contains the inline image. Throws an error if it is not contained in a table. Read-only. * * [Api set: WordApi 1.3] */ readonly parentTable: Word.Table; /** * - * Gets the table cell that contains the inline image. Throws if it is not contained in a table cell. Read-only. + * Gets the table cell that contains the inline image. Throws an error if it is not contained in a table cell. Read-only. * * [Api set: WordApi 1.3] */ @@ -68415,7 +69143,7 @@ declare namespace Word { getBase64ImageSrc(): OfficeExtension.ClientResult; /** * - * Gets the next inline image. Throws if this inline image is the last one. + * Gets the next inline image. Throws an error if this inline image is the last one. * * [Api set: WordApi 1.3] */ @@ -68447,7 +69175,7 @@ declare namespace Word { getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range; /** * - * Inserts a break at the specified location in the main document. The insertLocation value can be 'Before' or 'After'. + * Inserts a break at the specified location in the main document. * * [Api set: WordApi 1.2] * @@ -68457,7 +69185,7 @@ declare namespace Word { insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void; /** * - * Inserts a break at the specified location in the main document. The insertLocation value can be 'Before' or 'After'. + * Inserts a break at the specified location in the main document. * * [Api set: WordApi 1.2] * @@ -68474,7 +69202,7 @@ declare namespace Word { insertContentControl(): Word.ContentControl; /** * - * Inserts a document at the specified location. The insertLocation value can be 'Before' or 'After'. + * Inserts a document at the specified location. * * [Api set: WordApi 1.2] * @@ -68484,7 +69212,7 @@ declare namespace Word { insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts a document at the specified location. The insertLocation value can be 'Before' or 'After'. + * Inserts a document at the specified location. * * [Api set: WordApi 1.2] * @@ -68494,7 +69222,7 @@ declare namespace Word { insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range; /** * - * Inserts HTML at the specified location. The insertLocation value can be 'Before' or 'After'. + * Inserts HTML at the specified location. * * [Api set: WordApi 1.2] * @@ -68504,7 +69232,7 @@ declare namespace Word { insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts HTML at the specified location. The insertLocation value can be 'Before' or 'After'. + * Inserts HTML at the specified location. * * [Api set: WordApi 1.2] * @@ -68514,7 +69242,7 @@ declare namespace Word { insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range; /** * - * Inserts an inline picture at the specified location. The insertLocation value can be 'Replace', 'Before', or 'After'. + * Inserts an inline picture at the specified location. * * [Api set: WordApi 1.2] * @@ -68524,7 +69252,7 @@ declare namespace Word { insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture; /** * - * Inserts an inline picture at the specified location. The insertLocation value can be 'Replace', 'Before', or 'After'. + * Inserts an inline picture at the specified location. * * [Api set: WordApi 1.2] * @@ -68534,7 +69262,7 @@ declare namespace Word { insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.InlinePicture; /** * - * Inserts OOXML at the specified location. The insertLocation value can be 'Before' or 'After'. + * Inserts OOXML at the specified location. * * [Api set: WordApi 1.2] * @@ -68544,7 +69272,7 @@ declare namespace Word { insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts OOXML at the specified location. The insertLocation value can be 'Before' or 'After'. + * Inserts OOXML at the specified location. * * [Api set: WordApi 1.2] * @@ -68554,7 +69282,7 @@ declare namespace Word { insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range; /** * - * Inserts a paragraph at the specified location. The insertLocation value can be 'Before' or 'After'. + * Inserts a paragraph at the specified location. * * [Api set: WordApi 1.2] * @@ -68564,7 +69292,7 @@ declare namespace Word { insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph; /** * - * Inserts a paragraph at the specified location. The insertLocation value can be 'Before' or 'After'. + * Inserts a paragraph at the specified location. * * [Api set: WordApi 1.2] * @@ -68574,7 +69302,7 @@ declare namespace Word { insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph; /** * - * Inserts text at the specified location. The insertLocation value can be 'Before' or 'After'. + * Inserts text at the specified location. * * [Api set: WordApi 1.2] * @@ -68584,7 +69312,7 @@ declare namespace Word { insertText(text: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts text at the specified location. The insertLocation value can be 'Before' or 'After'. + * Inserts text at the specified location. * * [Api set: WordApi 1.2] * @@ -68658,7 +69386,7 @@ declare namespace Word { readonly items: Word.InlinePicture[]; /** * - * Gets the first inline image in this collection. Throws if this collection is empty. + * Gets the first inline image in this collection. Throws an error if this collection is empty. * * [Api set: WordApi 1.3] */ @@ -68741,7 +69469,7 @@ declare namespace Word { readonly levelTypes: Word.ListLevelType[]; /** * - * Gets the font of the bullet, number or picture at the specified level in the list. + * Gets the font of the bullet, number, or picture at the specified level in the list. * * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta @@ -68770,7 +69498,7 @@ declare namespace Word { getLevelPicture(level: number): OfficeExtension.ClientResult; /** * - * Gets the bullet, number or picture at the specified level as a string. + * Gets the bullet, number, or picture at the specified level as a string. * * [Api set: WordApi 1.3] * @@ -68779,7 +69507,7 @@ declare namespace Word { getLevelString(level: number): OfficeExtension.ClientResult; /** * - * Inserts a paragraph at the specified location. The insertLocation value can be 'Start', 'End', 'Before', or 'After'. + * Inserts a paragraph at the specified location. * * [Api set: WordApi 1.3] * @@ -68789,7 +69517,7 @@ declare namespace Word { insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph; /** * - * Inserts a paragraph at the specified location. The insertLocation value can be 'Start', 'End', 'Before', or 'After'. + * Inserts a paragraph at the specified location. * * [Api set: WordApi 1.3] * @@ -68799,7 +69527,7 @@ declare namespace Word { insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph; /** * - * Resets the font of the bullet, number or picture at the specified level in the list. + * Resets the font of the bullet, number, or picture at the specified level in the list. * * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta @@ -68810,7 +69538,7 @@ declare namespace Word { resetLevelFont(level: number, resetFontName?: boolean): void; /** * - * Sets the alignment of the bullet, number or picture at the specified level in the list. + * Sets the alignment of the bullet, number, or picture at the specified level in the list. * * [Api set: WordApi 1.3] * @@ -68820,7 +69548,7 @@ declare namespace Word { setLevelAlignment(level: number, alignment: Word.Alignment): void; /** * - * Sets the alignment of the bullet, number or picture at the specified level in the list. + * Sets the alignment of the bullet, number, or picture at the specified level in the list. * * [Api set: WordApi 1.3] * @@ -68860,7 +69588,7 @@ declare namespace Word { * * @param level Required. The level in the list. * @param textIndent Required. The text indent in points. It is the same as paragraph left indent. - * @param bulletNumberPictureIndent Required. The relative indent, in points, of the bullet, number or picture. It is the same as paragraph first line indent. + * @param bulletNumberPictureIndent Required. The relative indent, in points, of the bullet, number, or picture. It is the same as paragraph first line indent. */ setLevelIndents(level: number, textIndent: number, bulletNumberPictureIndent: number): void; /** @@ -68954,7 +69682,7 @@ declare namespace Word { readonly items: Word.List[]; /** * - * Gets a list by its identifier. Throws if there isn't a list with the identifier in this collection. + * Gets a list by its identifier. Throws an error if there isn't a list with the identifier in this collection. * * [Api set: WordApi 1.3] * @@ -68972,7 +69700,7 @@ declare namespace Word { getByIdOrNullObject(id: number): Word.List; /** * - * Gets the first list in this collection. Throws if this collection is empty. + * Gets the first list in this collection. Throws an error if this collection is empty. * * [Api set: WordApi 1.3] */ @@ -69071,7 +69799,7 @@ declare namespace Word { set(properties: Word.ListItem): void; /** * - * Gets the list item parent, or the closest ancestor if the parent does not exist. Throws if the list item has no ancestor. + * Gets the list item parent, or the closest ancestor if the parent does not exist. Throws an error if the list item has no ancestor. * * [Api set: WordApi 1.3] * @@ -69163,14 +69891,14 @@ declare namespace Word { readonly inlinePictures: Word.InlinePictureCollection; /** * - * Gets the List to which this paragraph belongs. Throws if the paragraph is not in a list. Read-only. + * Gets the List to which this paragraph belongs. Throws an error if the paragraph is not in a list. Read-only. * * [Api set: WordApi 1.3] */ readonly list: Word.List; /** * - * Gets the ListItem for the paragraph. Throws if the paragraph is not part of a list. Read-only. + * Gets the ListItem for the paragraph. Throws an error if the paragraph is not part of a list. Read-only. * * [Api set: WordApi 1.3] */ @@ -69198,7 +69926,7 @@ declare namespace Word { readonly parentBody: Word.Body; /** * - * Gets the content control that contains the paragraph. Throws if there isn't a parent content control. Read-only. + * Gets the content control that contains the paragraph. Throws an error if there isn't a parent content control. Read-only. * * [Api set: WordApi 1.1] */ @@ -69212,14 +69940,14 @@ declare namespace Word { readonly parentContentControlOrNullObject: Word.ContentControl; /** * - * Gets the table that contains the paragraph. Throws if it is not contained in a table. Read-only. + * Gets the table that contains the paragraph. Throws an error if it is not contained in a table. Read-only. * * [Api set: WordApi 1.3] */ readonly parentTable: Word.Table; /** * - * Gets the table cell that contains the paragraph. Throws if it is not contained in a table cell. Read-only. + * Gets the table cell that contains the paragraph. Throws an error if it is not contained in a table cell. Read-only. * * [Api set: WordApi 1.3] */ @@ -69397,14 +70125,14 @@ declare namespace Word { detachFromList(): void; /** * - * Gets an HTML representation of the paragraph object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match to the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, etc.). If you need exact fidelity, or consistency across platforms, use `Paragraph.getOoxml()` and convert the returned XML to HTML. + * Gets an HTML representation of the paragraph object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, Word for the web, etc.). If you need exact fidelity, or consistency across platforms, use `Paragraph.getOoxml()` and convert the returned XML to HTML. * * [Api set: WordApi 1.1] */ getHtml(): OfficeExtension.ClientResult; /** * - * Gets the next paragraph. Throws if the paragraph is the last one. + * Gets the next paragraph. Throws an error if the paragraph is the last one. * * [Api set: WordApi 1.3] */ @@ -69425,7 +70153,7 @@ declare namespace Word { getOoxml(): OfficeExtension.ClientResult; /** * - * Gets the previous paragraph. Throws if the paragraph is the first one. + * Gets the previous paragraph. Throws an error if the paragraph is the first one. * * [Api set: WordApi 1.3] */ @@ -69467,7 +70195,7 @@ declare namespace Word { getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection; /** * - * Inserts a break at the specified location in the main document. The insertLocation value can be 'Before' or 'After'. + * Inserts a break at the specified location in the main document. * * [Api set: WordApi 1.1] * @@ -69477,7 +70205,7 @@ declare namespace Word { insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void; /** * - * Inserts a break at the specified location in the main document. The insertLocation value can be 'Before' or 'After'. + * Inserts a break at the specified location in the main document. * * [Api set: WordApi 1.1] * @@ -69494,7 +70222,7 @@ declare namespace Word { insertContentControl(): Word.ContentControl; /** * - * Inserts a document into the paragraph at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts a document into the paragraph at the specified location. * * [Api set: WordApi 1.1] * @@ -69504,7 +70232,7 @@ declare namespace Word { insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts a document into the paragraph at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts a document into the paragraph at the specified location. * * [Api set: WordApi 1.1] * @@ -69514,7 +70242,7 @@ declare namespace Word { insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range; /** * - * Inserts HTML into the paragraph at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts HTML into the paragraph at the specified location. * * [Api set: WordApi 1.1] * @@ -69524,7 +70252,7 @@ declare namespace Word { insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts HTML into the paragraph at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts HTML into the paragraph at the specified location. * * [Api set: WordApi 1.1] * @@ -69534,7 +70262,7 @@ declare namespace Word { insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range; /** * - * Inserts a picture into the paragraph at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts a picture into the paragraph at the specified location. * * [Api set: WordApi 1.1] * @@ -69544,7 +70272,7 @@ declare namespace Word { insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture; /** * - * Inserts a picture into the paragraph at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts a picture into the paragraph at the specified location. * * [Api set: WordApi 1.1] * @@ -69554,7 +70282,7 @@ declare namespace Word { insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.InlinePicture; /** * - * Inserts OOXML into the paragraph at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts OOXML into the paragraph at the specified location. * * [Api set: WordApi 1.1] * @@ -69564,7 +70292,7 @@ declare namespace Word { insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts OOXML into the paragraph at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts OOXML into the paragraph at the specified location. * * [Api set: WordApi 1.1] * @@ -69574,7 +70302,7 @@ declare namespace Word { insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range; /** * - * Inserts a paragraph at the specified location. The insertLocation value can be 'Before' or 'After'. + * Inserts a paragraph at the specified location. * * [Api set: WordApi 1.1] * @@ -69584,7 +70312,7 @@ declare namespace Word { insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph; /** * - * Inserts a paragraph at the specified location. The insertLocation value can be 'Before' or 'After'. + * Inserts a paragraph at the specified location. * * [Api set: WordApi 1.1] * @@ -69594,7 +70322,7 @@ declare namespace Word { insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph; /** * - * Inserts a table with the specified number of rows and columns. The insertLocation value can be 'Before' or 'After'. + * Inserts a table with the specified number of rows and columns. * * [Api set: WordApi 1.3] * @@ -69606,7 +70334,7 @@ declare namespace Word { insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table; /** * - * Inserts a table with the specified number of rows and columns. The insertLocation value can be 'Before' or 'After'. + * Inserts a table with the specified number of rows and columns. * * [Api set: WordApi 1.3] * @@ -69618,7 +70346,7 @@ declare namespace Word { insertTable(rowCount: number, columnCount: number, insertLocation: "Before" | "After" | "Start" | "End" | "Replace", values?: string[][]): Word.Table; /** * - * Inserts text into the paragraph at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts text into the paragraph at the specified location. * * [Api set: WordApi 1.1] * @@ -69628,7 +70356,7 @@ declare namespace Word { insertText(text: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts text into the paragraph at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts text into the paragraph at the specified location. * * [Api set: WordApi 1.1] * @@ -69738,7 +70466,7 @@ declare namespace Word { readonly items: Word.Paragraph[]; /** * - * Gets the first paragraph in this collection. Throws if the collection is empty. + * Gets the first paragraph in this collection. Throws an error if the collection is empty. * * [Api set: WordApi 1.3] */ @@ -69752,7 +70480,7 @@ declare namespace Word { getFirstOrNullObject(): Word.Paragraph; /** * - * Gets the last paragraph in this collection. Throws if the collection is empty. + * Gets the last paragraph in this collection. Throws an error if the collection is empty. * * [Api set: WordApi 1.3] */ @@ -69849,7 +70577,7 @@ declare namespace Word { readonly parentBody: Word.Body; /** * - * Gets the content control that contains the range. Throws if there isn't a parent content control. Read-only. + * Gets the content control that contains the range. Throws an error if there isn't a parent content control. Read-only. * * [Api set: WordApi 1.1] */ @@ -69863,14 +70591,14 @@ declare namespace Word { readonly parentContentControlOrNullObject: Word.ContentControl; /** * - * Gets the table that contains the range. Throws if it is not contained in a table. Read-only. + * Gets the table that contains the range. Throws an error if it is not contained in a table. Read-only. * * [Api set: WordApi 1.3] */ readonly parentTable: Word.Table; /** * - * Gets the table cell that contains the range. Throws if it is not contained in a table cell. Read-only. + * Gets the table cell that contains the range. Throws an error if it is not contained in a table cell. Read-only. * * [Api set: WordApi 1.3] */ @@ -69970,7 +70698,7 @@ declare namespace Word { delete(): void; /** * - * Returns a new range that extends from this range in either direction to cover another range. This range is not changed. Throws if the two ranges do not have a union. + * Returns a new range that extends from this range in either direction to cover another range. This range is not changed. Throws an error if the two ranges do not have a union. * * [Api set: WordApi 1.3] * @@ -69999,7 +70727,7 @@ declare namespace Word { getBookmarks(includeHidden?: boolean, includeAdjacent?: boolean): OfficeExtension.ClientResult; /** * - * Gets an HTML representation of the range object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match to the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, etc.). If you need exact fidelity, or consistency across platforms, use `Range.getOoxml()` and convert the returned XML to HTML. + * Gets an HTML representation of the range object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, Word for the web, etc.). If you need exact fidelity, or consistency across platforms, use `Range.getOoxml()` and convert the returned XML to HTML. * * [Api set: WordApi 1.1] */ @@ -70013,7 +70741,7 @@ declare namespace Word { getHyperlinkRanges(): Word.RangeCollection; /** * - * Gets the next text range by using punctuation marks and/or other ending marks. Throws if this text range is the last one. + * Gets the next text range by using punctuation marks and/or other ending marks. Throws an error if this text range is the last one. * * [Api set: WordApi 1.3] * @@ -70078,7 +70806,7 @@ declare namespace Word { insertBookmark(name: string): void; /** * - * Inserts a break at the specified location in the main document. The insertLocation value can be 'Before' or 'After'. + * Inserts a break at the specified location in the main document. * * [Api set: WordApi 1.1] * @@ -70088,7 +70816,7 @@ declare namespace Word { insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void; /** * - * Inserts a break at the specified location in the main document. The insertLocation value can be 'Before' or 'After'. + * Inserts a break at the specified location in the main document. * * [Api set: WordApi 1.1] * @@ -70105,7 +70833,7 @@ declare namespace Word { insertContentControl(): Word.ContentControl; /** * - * Inserts a document at the specified location. The insertLocation value can be 'Replace', 'Start', 'End', 'Before', or 'After'. + * Inserts a document at the specified location. * * [Api set: WordApi 1.1] * @@ -70115,7 +70843,7 @@ declare namespace Word { insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts a document at the specified location. The insertLocation value can be 'Replace', 'Start', 'End', 'Before', or 'After'. + * Inserts a document at the specified location. * * [Api set: WordApi 1.1] * @@ -70125,7 +70853,7 @@ declare namespace Word { insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range; /** * - * Inserts HTML at the specified location. The insertLocation value can be 'Replace', 'Start', 'End', 'Before', or 'After'. + * Inserts HTML at the specified location. * * [Api set: WordApi 1.1] * @@ -70135,7 +70863,7 @@ declare namespace Word { insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts HTML at the specified location. The insertLocation value can be 'Replace', 'Start', 'End', 'Before', or 'After'. + * Inserts HTML at the specified location. * * [Api set: WordApi 1.1] * @@ -70145,7 +70873,7 @@ declare namespace Word { insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range; /** * - * Inserts a picture at the specified location. The insertLocation value can be 'Replace', 'Start', 'End', 'Before', or 'After'. + * Inserts a picture at the specified location. * * [Api set: WordApi 1.2] * @@ -70155,7 +70883,7 @@ declare namespace Word { insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture; /** * - * Inserts a picture at the specified location. The insertLocation value can be 'Replace', 'Start', 'End', 'Before', or 'After'. + * Inserts a picture at the specified location. * * [Api set: WordApi 1.2] * @@ -70165,7 +70893,7 @@ declare namespace Word { insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.InlinePicture; /** * - * Inserts OOXML at the specified location. The insertLocation value can be 'Replace', 'Start', 'End', 'Before', or 'After'. + * Inserts OOXML at the specified location. * * [Api set: WordApi 1.1] * @@ -70175,7 +70903,7 @@ declare namespace Word { insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts OOXML at the specified location. The insertLocation value can be 'Replace', 'Start', 'End', 'Before', or 'After'. + * Inserts OOXML at the specified location. * * [Api set: WordApi 1.1] * @@ -70185,7 +70913,7 @@ declare namespace Word { insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range; /** * - * Inserts a paragraph at the specified location. The insertLocation value can be 'Before' or 'After'. + * Inserts a paragraph at the specified location. * * [Api set: WordApi 1.1] * @@ -70195,7 +70923,7 @@ declare namespace Word { insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph; /** * - * Inserts a paragraph at the specified location. The insertLocation value can be 'Before' or 'After'. + * Inserts a paragraph at the specified location. * * [Api set: WordApi 1.1] * @@ -70205,7 +70933,7 @@ declare namespace Word { insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph; /** * - * Inserts a table with the specified number of rows and columns. The insertLocation value can be 'Before' or 'After'. + * Inserts a table with the specified number of rows and columns. * * [Api set: WordApi 1.3] * @@ -70217,7 +70945,7 @@ declare namespace Word { insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table; /** * - * Inserts a table with the specified number of rows and columns. The insertLocation value can be 'Before' or 'After'. + * Inserts a table with the specified number of rows and columns. * * [Api set: WordApi 1.3] * @@ -70229,7 +70957,7 @@ declare namespace Word { insertTable(rowCount: number, columnCount: number, insertLocation: "Before" | "After" | "Start" | "End" | "Replace", values?: string[][]): Word.Table; /** * - * Inserts text at the specified location. The insertLocation value can be 'Replace', 'Start', 'End', 'Before', or 'After'. + * Inserts text at the specified location. * * [Api set: WordApi 1.1] * @@ -70239,7 +70967,7 @@ declare namespace Word { insertText(text: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts text at the specified location. The insertLocation value can be 'Replace', 'Start', 'End', 'Before', or 'After'. + * Inserts text at the specified location. * * [Api set: WordApi 1.1] * @@ -70249,7 +70977,7 @@ declare namespace Word { insertText(text: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range; /** * - * Returns a new range as the intersection of this range with another range. This range is not changed. Throws if the two ranges are not overlapped or adjacent. + * Returns a new range as the intersection of this range with another range. This range is not changed. Throws an error if the two ranges are not overlapped or adjacent. * * [Api set: WordApi 1.3] * @@ -70361,7 +71089,7 @@ declare namespace Word { readonly items: Word.Range[]; /** * - * Gets the first range in this collection. Throws if this collection is empty. + * Gets the first range in this collection. Throws an error if this collection is empty. * * [Api set: WordApi 1.3] */ @@ -70577,7 +71305,7 @@ declare namespace Word { getHeader(type: "Primary" | "FirstPage" | "EvenPages"): Word.Body; /** * - * Gets the next section. Throws if this section is the last one. + * Gets the next section. Throws an error if this section is the last one. * * [Api set: WordApi 1.3] */ @@ -70637,7 +71365,7 @@ declare namespace Word { readonly items: Word.Section[]; /** * - * Gets the first section in this collection. Throws if this collection is empty. + * Gets the first section in this collection. Throws an error if this collection is empty. * * [Api set: WordApi 1.3] */ @@ -70809,7 +71537,7 @@ declare namespace Word { getCount(): OfficeExtension.ClientResult; /** * - * Gets a setting object by its key, which is case-sensitive. Throws if the setting does not exist. + * Gets a setting object by its key, which is case-sensitive. Throws an error if the setting does not exist. * * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta @@ -70884,7 +71612,7 @@ declare namespace Word { readonly parentBody: Word.Body; /** * - * Gets the content control that contains the table. Throws if there isn't a parent content control. Read-only. + * Gets the content control that contains the table. Throws an error if there isn't a parent content control. Read-only. * * [Api set: WordApi 1.3] */ @@ -70898,14 +71626,14 @@ declare namespace Word { readonly parentContentControlOrNullObject: Word.ContentControl; /** * - * Gets the table that contains this table. Throws if it is not contained in a table. Read-only. + * Gets the table that contains this table. Throws an error if it is not contained in a table. Read-only. * * [Api set: WordApi 1.3] */ readonly parentTable: Word.Table; /** * - * Gets the table cell that contains this table. Throws if it is not contained in a table cell. Read-only. + * Gets the table cell that contains this table. Throws an error if it is not contained in a table cell. Read-only. * * [Api set: WordApi 1.3] */ @@ -71183,7 +71911,7 @@ declare namespace Word { getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder; /** * - * Gets the table cell at a specified row and column. Throws if the specified table cell does not exist. + * Gets the table cell at a specified row and column. Throws an error if the specified table cell does not exist. * * [Api set: WordApi 1.3] * @@ -71221,7 +71949,7 @@ declare namespace Word { getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; /** * - * Gets the next table. Throws if this table is the last one. + * Gets the next table. Throws an error if this table is the last one. * * [Api set: WordApi 1.3] */ @@ -71235,7 +71963,7 @@ declare namespace Word { getNextOrNullObject(): Word.Table; /** * - * Gets the paragraph after the table. Throws if there isn't a paragraph after the table. + * Gets the paragraph after the table. Throws an error if there isn't a paragraph after the table. * * [Api set: WordApi 1.3] */ @@ -71249,7 +71977,7 @@ declare namespace Word { getParagraphAfterOrNullObject(): Word.Paragraph; /** * - * Gets the paragraph before the table. Throws if there isn't a paragraph before the table. + * Gets the paragraph before the table. Throws an error if there isn't a paragraph before the table. * * [Api set: WordApi 1.3] */ @@ -71288,7 +72016,7 @@ declare namespace Word { insertContentControl(): Word.ContentControl; /** * - * Inserts a paragraph at the specified location. The insertLocation value can be 'Before' or 'After'. + * Inserts a paragraph at the specified location. * * [Api set: WordApi 1.3] * @@ -71298,7 +72026,7 @@ declare namespace Word { insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph; /** * - * Inserts a paragraph at the specified location. The insertLocation value can be 'Before' or 'After'. + * Inserts a paragraph at the specified location. * * [Api set: WordApi 1.3] * @@ -71308,7 +72036,7 @@ declare namespace Word { insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph; /** * - * Inserts a table with the specified number of rows and columns. The insertLocation value can be 'Before' or 'After'. + * Inserts a table with the specified number of rows and columns. * * [Api set: WordApi 1.3] * @@ -71320,7 +72048,7 @@ declare namespace Word { insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table; /** * - * Inserts a table with the specified number of rows and columns. The insertLocation value can be 'Before' or 'After'. + * Inserts a table with the specified number of rows and columns. * * [Api set: WordApi 1.3] * @@ -71447,7 +72175,7 @@ declare namespace Word { readonly items: Word.Table[]; /** * - * Gets the first table in this collection. Throws if this collection is empty. + * Gets the first table in this collection. Throws an error if this collection is empty. * * [Api set: WordApi 1.3] */ @@ -71643,7 +72371,7 @@ declare namespace Word { getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; /** * - * Gets the next row. Throws if this row is the last one. + * Gets the next row. Throws an error if this row is the last one. * * [Api set: WordApi 1.3] */ @@ -71797,7 +72525,7 @@ declare namespace Word { readonly items: Word.TableRow[]; /** * - * Gets the first row in this collection. Throws if this collection is empty. + * Gets the first row in this collection. Throws an error if this collection is empty. * * [Api set: WordApi 1.3] */ @@ -71993,7 +72721,7 @@ declare namespace Word { getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; /** * - * Gets the next cell. Throws if this cell is the last one. + * Gets the next cell. Throws an error if this cell is the last one. * * [Api set: WordApi 1.3] */ @@ -72128,7 +72856,7 @@ declare namespace Word { readonly items: Word.TableCell[]; /** * - * Gets the first table cell in this collection. Throws if this collection is empty. + * Gets the first table cell in this collection. Throws an error if this collection is empty. * * [Api set: WordApi 1.3] */ @@ -72613,7 +73341,7 @@ declare namespace Word { enum HeaderFooterType { /** * - * Returns the header or footer on all pages of a section, with the first page or odd pages excluded if they are different. + * Returns the header or footer on all pages of a section, but excludes the first page or odd pages if they are different. * */ primary = "Primary", @@ -73265,7 +73993,7 @@ declare namespace Word { interface CustomPropertyUpdateData { /** * - * Gets or sets the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * Gets or sets the value of the custom property. Note that even though Word for the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). * * [Api set: WordApi 1.3] */ @@ -73411,11 +74139,8 @@ declare namespace Word { /** * * Gets or sets the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or null for no highlight color. + **Note**: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. * - * **Note**: Only the default highlight colors are available in Office on Windows Desktop. - * These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". - * When the add-in runs in Office on Windows Desktop, any other color is converted to the closest color when applied to the font. - * * [Api set: WordApi 1.1] */ highlightColor?: string; @@ -73543,7 +74268,7 @@ declare namespace Word { font?: Word.Interfaces.FontUpdateData; /** * - * Gets the ListItem for the paragraph. Throws if the paragraph is not part of a list. + * Gets the ListItem for the paragraph. Throws an error if the paragraph is not part of a list. * * [Api set: WordApi 1.3] */ @@ -74232,7 +74957,7 @@ declare namespace Word { type?: Word.DocumentPropertyType | "String" | "Number" | "Date" | "Boolean"; /** * - * Gets or sets the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * Gets or sets the value of the custom property. Note that even though Word for the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). * * [Api set: WordApi 1.3] */ @@ -74537,11 +75262,8 @@ declare namespace Word { /** * * Gets or sets the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or null for no highlight color. + **Note**: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. * - * **Note**: Only the default highlight colors are available in Office on Windows Desktop. - * These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". - * When the add-in runs in Office on Windows Desktop, any other color is converted to the closest color when applied to the font. - * * [Api set: WordApi 1.1] */ highlightColor?: string; @@ -74729,7 +75451,7 @@ declare namespace Word { inlinePictures?: Word.Interfaces.InlinePictureData[]; /** * - * Gets the ListItem for the paragraph. Throws if the paragraph is not part of a list. Read-only. + * Gets the ListItem for the paragraph. Throws an error if the paragraph is not part of a list. Read-only. * * [Api set: WordApi 1.3] */ @@ -75338,7 +76060,7 @@ declare namespace Word { font?: Word.Interfaces.FontLoadOptions; /** * - * Gets the parent body of the body. For example, a table cell body's parent body could be a header. Throws if there isn't a parent body. + * Gets the parent body of the body. For example, a table cell body's parent body could be a header. Throws an error if there isn't a parent body. * * [Api set: WordApi 1.3] */ @@ -75352,7 +76074,7 @@ declare namespace Word { parentBodyOrNullObject?: Word.Interfaces.BodyLoadOptions; /** * - * Gets the content control that contains the body. Throws if there isn't a parent content control. + * Gets the content control that contains the body. Throws an error if there isn't a parent content control. * * [Api set: WordApi 1.1] */ @@ -75366,7 +76088,7 @@ declare namespace Word { parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** * - * Gets the parent section of the body. Throws if there isn't a parent section. + * Gets the parent section of the body. Throws an error if there isn't a parent section. * * [Api set: WordApi 1.3] */ @@ -75431,7 +76153,7 @@ declare namespace Word { parentBody?: Word.Interfaces.BodyLoadOptions; /** * - * Gets the content control that contains the content control. Throws if there isn't a parent content control. + * Gets the content control that contains the content control. Throws an error if there isn't a parent content control. * * [Api set: WordApi 1.1] */ @@ -75445,14 +76167,14 @@ declare namespace Word { parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** * - * Gets the table that contains the content control. Throws if it is not contained in a table. + * Gets the table that contains the content control. Throws an error if it is not contained in a table. * * [Api set: WordApi 1.3] */ parentTable?: Word.Interfaces.TableLoadOptions; /** * - * Gets the table cell that contains the content control. Throws if it is not contained in a table cell. + * Gets the table cell that contains the content control. Throws an error if it is not contained in a table cell. * * [Api set: WordApi 1.3] */ @@ -75594,7 +76316,7 @@ declare namespace Word { parentBody?: Word.Interfaces.BodyLoadOptions; /** * - * For EACH ITEM in the collection: Gets the content control that contains the content control. Throws if there isn't a parent content control. + * For EACH ITEM in the collection: Gets the content control that contains the content control. Throws an error if there isn't a parent content control. * * [Api set: WordApi 1.1] */ @@ -75608,14 +76330,14 @@ declare namespace Word { parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** * - * For EACH ITEM in the collection: Gets the table that contains the content control. Throws if it is not contained in a table. + * For EACH ITEM in the collection: Gets the table that contains the content control. Throws an error if it is not contained in a table. * * [Api set: WordApi 1.3] */ parentTable?: Word.Interfaces.TableLoadOptions; /** * - * For EACH ITEM in the collection: Gets the table cell that contains the content control. Throws if it is not contained in a table cell. + * For EACH ITEM in the collection: Gets the table cell that contains the content control. Throws an error if it is not contained in a table cell. * * [Api set: WordApi 1.3] */ @@ -75757,7 +76479,7 @@ declare namespace Word { type?: boolean; /** * - * Gets or sets the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * Gets or sets the value of the custom property. Note that even though Word for the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). * * [Api set: WordApi 1.3] */ @@ -75787,7 +76509,7 @@ declare namespace Word { type?: boolean; /** * - * For EACH ITEM in the collection: Gets or sets the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * For EACH ITEM in the collection: Gets or sets the value of the custom property. Note that even though Word for the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). * * [Api set: WordApi 1.3] */ @@ -76101,11 +76823,8 @@ declare namespace Word { /** * * Gets or sets the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or null for no highlight color. + **Note**: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. * - * **Note**: Only the default highlight colors are available in Office on Windows Desktop. - * These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". - * When the add-in runs in Office on Windows Desktop, any other color is converted to the closest color when applied to the font. - * * [Api set: WordApi 1.1] */ highlightColor?: boolean; @@ -76176,7 +76895,7 @@ declare namespace Word { paragraph?: Word.Interfaces.ParagraphLoadOptions; /** * - * Gets the content control that contains the inline image. Throws if there isn't a parent content control. + * Gets the content control that contains the inline image. Throws an error if there isn't a parent content control. * * [Api set: WordApi 1.1] */ @@ -76190,14 +76909,14 @@ declare namespace Word { parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** * - * Gets the table that contains the inline image. Throws if it is not contained in a table. + * Gets the table that contains the inline image. Throws an error if it is not contained in a table. * * [Api set: WordApi 1.3] */ parentTable?: Word.Interfaces.TableLoadOptions; /** * - * Gets the table cell that contains the inline image. Throws if it is not contained in a table cell. + * Gets the table cell that contains the inline image. Throws an error if it is not contained in a table cell. * * [Api set: WordApi 1.3] */ @@ -76284,7 +77003,7 @@ declare namespace Word { paragraph?: Word.Interfaces.ParagraphLoadOptions; /** * - * For EACH ITEM in the collection: Gets the content control that contains the inline image. Throws if there isn't a parent content control. + * For EACH ITEM in the collection: Gets the content control that contains the inline image. Throws an error if there isn't a parent content control. * * [Api set: WordApi 1.1] */ @@ -76298,14 +77017,14 @@ declare namespace Word { parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** * - * For EACH ITEM in the collection: Gets the table that contains the inline image. Throws if it is not contained in a table. + * For EACH ITEM in the collection: Gets the table that contains the inline image. Throws an error if it is not contained in a table. * * [Api set: WordApi 1.3] */ parentTable?: Word.Interfaces.TableLoadOptions; /** * - * For EACH ITEM in the collection: Gets the table cell that contains the inline image. Throws if it is not contained in a table cell. + * For EACH ITEM in the collection: Gets the table cell that contains the inline image. Throws an error if it is not contained in a table cell. * * [Api set: WordApi 1.3] */ @@ -76482,14 +77201,14 @@ declare namespace Word { font?: Word.Interfaces.FontLoadOptions; /** * - * Gets the List to which this paragraph belongs. Throws if the paragraph is not in a list. + * Gets the List to which this paragraph belongs. Throws an error if the paragraph is not in a list. * * [Api set: WordApi 1.3] */ list?: Word.Interfaces.ListLoadOptions; /** * - * Gets the ListItem for the paragraph. Throws if the paragraph is not part of a list. + * Gets the ListItem for the paragraph. Throws an error if the paragraph is not part of a list. * * [Api set: WordApi 1.3] */ @@ -76517,7 +77236,7 @@ declare namespace Word { parentBody?: Word.Interfaces.BodyLoadOptions; /** * - * Gets the content control that contains the paragraph. Throws if there isn't a parent content control. + * Gets the content control that contains the paragraph. Throws an error if there isn't a parent content control. * * [Api set: WordApi 1.1] */ @@ -76531,14 +77250,14 @@ declare namespace Word { parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** * - * Gets the table that contains the paragraph. Throws if it is not contained in a table. + * Gets the table that contains the paragraph. Throws an error if it is not contained in a table. * * [Api set: WordApi 1.3] */ parentTable?: Word.Interfaces.TableLoadOptions; /** * - * Gets the table cell that contains the paragraph. Throws if it is not contained in a table cell. + * Gets the table cell that contains the paragraph. Throws an error if it is not contained in a table cell. * * [Api set: WordApi 1.3] */ @@ -76687,14 +77406,14 @@ declare namespace Word { font?: Word.Interfaces.FontLoadOptions; /** * - * For EACH ITEM in the collection: Gets the List to which this paragraph belongs. Throws if the paragraph is not in a list. + * For EACH ITEM in the collection: Gets the List to which this paragraph belongs. Throws an error if the paragraph is not in a list. * * [Api set: WordApi 1.3] */ list?: Word.Interfaces.ListLoadOptions; /** * - * For EACH ITEM in the collection: Gets the ListItem for the paragraph. Throws if the paragraph is not part of a list. + * For EACH ITEM in the collection: Gets the ListItem for the paragraph. Throws an error if the paragraph is not part of a list. * * [Api set: WordApi 1.3] */ @@ -76722,7 +77441,7 @@ declare namespace Word { parentBody?: Word.Interfaces.BodyLoadOptions; /** * - * For EACH ITEM in the collection: Gets the content control that contains the paragraph. Throws if there isn't a parent content control. + * For EACH ITEM in the collection: Gets the content control that contains the paragraph. Throws an error if there isn't a parent content control. * * [Api set: WordApi 1.1] */ @@ -76736,14 +77455,14 @@ declare namespace Word { parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** * - * For EACH ITEM in the collection: Gets the table that contains the paragraph. Throws if it is not contained in a table. + * For EACH ITEM in the collection: Gets the table that contains the paragraph. Throws an error if it is not contained in a table. * * [Api set: WordApi 1.3] */ parentTable?: Word.Interfaces.TableLoadOptions; /** * - * For EACH ITEM in the collection: Gets the table cell that contains the paragraph. Throws if it is not contained in a table cell. + * For EACH ITEM in the collection: Gets the table cell that contains the paragraph. Throws an error if it is not contained in a table cell. * * [Api set: WordApi 1.3] */ @@ -76899,7 +77618,7 @@ declare namespace Word { parentBody?: Word.Interfaces.BodyLoadOptions; /** * - * Gets the content control that contains the range. Throws if there isn't a parent content control. + * Gets the content control that contains the range. Throws an error if there isn't a parent content control. * * [Api set: WordApi 1.1] */ @@ -76913,14 +77632,14 @@ declare namespace Word { parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** * - * Gets the table that contains the range. Throws if it is not contained in a table. + * Gets the table that contains the range. Throws an error if it is not contained in a table. * * [Api set: WordApi 1.3] */ parentTable?: Word.Interfaces.TableLoadOptions; /** * - * Gets the table cell that contains the range. Throws if it is not contained in a table cell. + * Gets the table cell that contains the range. Throws an error if it is not contained in a table cell. * * [Api set: WordApi 1.3] */ @@ -76999,7 +77718,7 @@ declare namespace Word { parentBody?: Word.Interfaces.BodyLoadOptions; /** * - * For EACH ITEM in the collection: Gets the content control that contains the range. Throws if there isn't a parent content control. + * For EACH ITEM in the collection: Gets the content control that contains the range. Throws an error if there isn't a parent content control. * * [Api set: WordApi 1.1] */ @@ -77013,14 +77732,14 @@ declare namespace Word { parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** * - * For EACH ITEM in the collection: Gets the table that contains the range. Throws if it is not contained in a table. + * For EACH ITEM in the collection: Gets the table that contains the range. Throws an error if it is not contained in a table. * * [Api set: WordApi 1.3] */ parentTable?: Word.Interfaces.TableLoadOptions; /** * - * For EACH ITEM in the collection: Gets the table cell that contains the range. Throws if it is not contained in a table cell. + * For EACH ITEM in the collection: Gets the table cell that contains the range. Throws an error if it is not contained in a table cell. * * [Api set: WordApi 1.3] */ @@ -77241,7 +77960,7 @@ declare namespace Word { parentBody?: Word.Interfaces.BodyLoadOptions; /** * - * Gets the content control that contains the table. Throws if there isn't a parent content control. + * Gets the content control that contains the table. Throws an error if there isn't a parent content control. * * [Api set: WordApi 1.3] */ @@ -77255,14 +77974,14 @@ declare namespace Word { parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** * - * Gets the table that contains this table. Throws if it is not contained in a table. + * Gets the table that contains this table. Throws an error if it is not contained in a table. * * [Api set: WordApi 1.3] */ parentTable?: Word.Interfaces.TableLoadOptions; /** * - * Gets the table cell that contains this table. Throws if it is not contained in a table cell. + * Gets the table cell that contains this table. Throws an error if it is not contained in a table cell. * * [Api set: WordApi 1.3] */ @@ -77425,7 +78144,7 @@ declare namespace Word { parentBody?: Word.Interfaces.BodyLoadOptions; /** * - * For EACH ITEM in the collection: Gets the content control that contains the table. Throws if there isn't a parent content control. + * For EACH ITEM in the collection: Gets the content control that contains the table. Throws an error if there isn't a parent content control. * * [Api set: WordApi 1.3] */ @@ -77439,14 +78158,14 @@ declare namespace Word { parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** * - * For EACH ITEM in the collection: Gets the table that contains this table. Throws if it is not contained in a table. + * For EACH ITEM in the collection: Gets the table that contains this table. Throws an error if it is not contained in a table. * * [Api set: WordApi 1.3] */ parentTable?: Word.Interfaces.TableLoadOptions; /** * - * For EACH ITEM in the collection: Gets the table cell that contains this table. Throws if it is not contained in a table cell. + * For EACH ITEM in the collection: Gets the table cell that contains this table. Throws an error if it is not contained in a table cell. * * [Api set: WordApi 1.3] */ diff --git a/types/office-js/index.d.ts b/types/office-js/index.d.ts index 57340e3b5e..aa75faa856 100644 --- a/types/office-js/index.d.ts +++ b/types/office-js/index.d.ts @@ -17217,7 +17217,7 @@ declare namespace Excel { */ class Runtime extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Toggle JavaScript events in the current task pane or content add-in. @@ -17240,23 +17240,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.Runtime): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.Runtime` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.Runtime` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Runtime` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.RuntimeLoadOptions): Excel.Runtime; - load(option?: string | string[]): Excel.Runtime; - load(option?: { + load(options?: Excel.Interfaces.RuntimeLoadOptions): Excel.Runtime; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Runtime; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.Runtime; @@ -17274,7 +17274,7 @@ declare namespace Excel { */ class Application extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns the Iterative Calculation settings. @@ -17352,23 +17352,23 @@ declare namespace Excel { */ suspendScreenUpdatingUntilNextSync(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.Application` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.Application` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Application` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ApplicationLoadOptions): Excel.Application; - load(option?: string | string[]): Excel.Application; - load(option?: { + load(options?: Excel.Interfaces.ApplicationLoadOptions): Excel.Application; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Application; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.Application; @@ -17386,7 +17386,7 @@ declare namespace Excel { */ class IterativeCalculation extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * True if Excel will use iteration to resolve circular references. @@ -17423,23 +17423,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.IterativeCalculation): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.IterativeCalculation` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.IterativeCalculation` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.IterativeCalculation` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.IterativeCalculationLoadOptions): Excel.IterativeCalculation; - load(option?: string | string[]): Excel.IterativeCalculation; - load(option?: { + load(options?: Excel.Interfaces.IterativeCalculationLoadOptions): Excel.IterativeCalculation; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.IterativeCalculation; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.IterativeCalculation; @@ -17458,7 +17458,7 @@ declare namespace Excel { */ class Workbook extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the Excel application instance that contains this workbook. Read-only. @@ -17667,23 +17667,23 @@ declare namespace Excel { */ getSelectedRanges(): Excel.RangeAreas; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.Workbook` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.Workbook` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Workbook` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.WorkbookLoadOptions): Excel.Workbook; - load(option?: string | string[]): Excel.Workbook; - load(option?: { + load(options?: Excel.Interfaces.WorkbookLoadOptions): Excel.Workbook; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Workbook; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.Workbook; @@ -17719,7 +17719,7 @@ declare namespace Excel { */ class WorkbookProtection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Indicates if the workbook is protected. Read-Only. @@ -17746,23 +17746,23 @@ declare namespace Excel { */ unprotect(password?: string): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.WorkbookProtection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.WorkbookProtection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.WorkbookProtection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.WorkbookProtectionLoadOptions): Excel.WorkbookProtection; - load(option?: string | string[]): Excel.WorkbookProtection; - load(option?: { + load(options?: Excel.Interfaces.WorkbookProtectionLoadOptions): Excel.WorkbookProtection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.WorkbookProtection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.WorkbookProtection; @@ -17780,24 +17780,19 @@ declare namespace Excel { */ class WorkbookCreated extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.WorkbookCreated` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.WorkbookCreated` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.WorkbookCreated` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. - * - * @param options Provides options for which properties of the object to load. + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(option?: string | string[]): Excel.WorkbookCreated; - load(option?: { + load(propertyNames?: string | string[]): Excel.WorkbookCreated; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.WorkbookCreated; @@ -17816,7 +17811,7 @@ declare namespace Excel { */ class Worksheet extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the AutoFilter object of the worksheet. Read-Only. @@ -18156,23 +18151,23 @@ declare namespace Excel { */ replaceAll(text: string, replacement: string, criteria: Excel.ReplaceCriteria): OfficeExtension.ClientResult; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.Worksheet` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.Worksheet` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Worksheet` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.WorksheetLoadOptions): Excel.Worksheet; - load(option?: string | string[]): Excel.Worksheet; - load(option?: { + load(options?: Excel.Interfaces.WorksheetLoadOptions): Excel.Worksheet; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Worksheet; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.Worksheet; @@ -18244,7 +18239,7 @@ declare namespace Excel { */ class WorksheetCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.Worksheet[]; /** @@ -18309,23 +18304,23 @@ declare namespace Excel { */ getLast(visibleOnly?: boolean): Excel.Worksheet; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.WorksheetCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.WorksheetCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.WorksheetCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.WorksheetCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.WorksheetCollection; - load(option?: string | string[]): Excel.WorksheetCollection; - load(option?: OfficeExtension.LoadOption): Excel.WorksheetCollection; + load(options?: Excel.Interfaces.WorksheetCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.WorksheetCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.WorksheetCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.WorksheetCollection; /** * * Occurs when any worksheet in the workbook is activated. @@ -18412,7 +18407,7 @@ declare namespace Excel { */ class WorksheetProtection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Sheet protection options. Read-only. @@ -18447,23 +18442,23 @@ declare namespace Excel { */ unprotect(password?: string): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.WorksheetProtection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.WorksheetProtection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.WorksheetProtection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.WorksheetProtectionLoadOptions): Excel.WorksheetProtection; - load(option?: string | string[]): Excel.WorksheetProtection; - load(option?: { + load(options?: Excel.Interfaces.WorksheetProtectionLoadOptions): Excel.WorksheetProtection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.WorksheetProtection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.WorksheetProtection; @@ -18584,7 +18579,7 @@ declare namespace Excel { */ class WorksheetFreezePanes extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Sets the frozen cells in the active worksheet view. @@ -18655,7 +18650,7 @@ declare namespace Excel { */ class Range extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Collection of ConditionalFormats that intersect the range. Read-only. @@ -18880,22 +18875,18 @@ declare namespace Excel { /** * * Fills range from the current range to the destination range. - The destination range must extend the source either horizontally or vertically. - - For more information, read {@link https://support.office.com/article/video-use-autofill-and-flash-fill-2e79a709-c814-4b27-8bc2-c4dc84d49464 | Use AutoFill and Flash Fill}. + The destination range must extend the source either horizontally or vertically. Discontiguous ranges are not supported. * * [Api set: ExcelApi 1.9] * - * @param destinationRange The destination range to autofill. Discontiguous ranges are not supported. + * @param destinationRange The destination range to autofill. * @param autoFillType The type of autofill. Specifies how the destination range is to be filled, based on the contents of the current range. Default is "FillDefault". */ autoFill(destinationRange: Range | string, autoFillType?: Excel.AutoFillType): void; /** * - * Fills range from the current range to the destination range. Discontiguous ranges are not supported. - The destination range must extend the source either horizontally or vertically. - - For more information, read {@link https://support.office.com/article/video-use-autofill-and-flash-fill-2e79a709-c814-4b27-8bc2-c4dc84d49464 | Use AutoFill and Flash Fill}. + * Fills range from the current range to the destination range. + The destination range must extend the source either horizontally or vertically. Discontiguous ranges are not supported. * * [Api set: ExcelApi 1.9] * @@ -18998,7 +18989,7 @@ declare namespace Excel { * * @param text The string to find. * @param criteria Additional search criteria, including the search direction and whether the search needs to match the entire cell or be case sensitive. - * @returns The Range which matched the search criteria. + * @returns The Range object representing the first cell that contains a value matching the search text and criteria. */ find(text: string, criteria: Excel.SearchCriteria): Excel.Range; /** @@ -19405,32 +19396,32 @@ declare namespace Excel { */ unmerge(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.Range` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.Range` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Range` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.RangeLoadOptions): Excel.Range; - load(option?: string | string[]): Excel.Range; - load(option?: { + load(options?: Excel.Interfaces.RangeLoadOptions): Excel.Range; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Range; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.Range; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created. + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created. */ track(): Excel.Range; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `context.trackedObjects.remove(thisObject)`. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect. */ untrack(): Excel.Range; /** @@ -19499,7 +19490,7 @@ declare namespace Excel { */ class RangeAreas extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns a collection of rectangular ranges that comprise this RangeAreas object. @@ -19787,32 +19778,32 @@ declare namespace Excel { */ setDirty(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.RangeAreas` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.RangeAreas` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.RangeAreas` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.RangeAreasLoadOptions): Excel.RangeAreas; - load(option?: string | string[]): Excel.RangeAreas; - load(option?: { + load(options?: Excel.Interfaces.RangeAreasLoadOptions): Excel.RangeAreas; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.RangeAreas; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.RangeAreas; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created. + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created. */ track(): Excel.RangeAreas; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `context.trackedObjects.remove(thisObject)`. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect. */ untrack(): Excel.RangeAreas; /** @@ -20302,7 +20293,7 @@ declare namespace Excel { */ class RangeView extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents a collection of range views associated with the range. Read-only. @@ -20409,23 +20400,23 @@ declare namespace Excel { */ getRange(): Excel.Range; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.RangeView` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.RangeView` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.RangeView` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.RangeViewLoadOptions): Excel.RangeView; - load(option?: string | string[]): Excel.RangeView; - load(option?: { + load(options?: Excel.Interfaces.RangeViewLoadOptions): Excel.RangeView; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.RangeView; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.RangeView; @@ -20443,7 +20434,7 @@ declare namespace Excel { */ class RangeViewCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.RangeView[]; /** @@ -20463,23 +20454,23 @@ declare namespace Excel { */ getItemAt(index: number): Excel.RangeView; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.RangeViewCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.RangeViewCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.RangeViewCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.RangeViewCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.RangeViewCollection; - load(option?: string | string[]): Excel.RangeViewCollection; - load(option?: OfficeExtension.LoadOption): Excel.RangeViewCollection; + load(options?: Excel.Interfaces.RangeViewCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.RangeViewCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.RangeViewCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.RangeViewCollection; /** * 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.RangeViewCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.RangeViewCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -20494,7 +20485,7 @@ declare namespace Excel { */ class SettingCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.Setting[]; /** @@ -20533,23 +20524,23 @@ declare namespace Excel { */ getItemOrNullObject(key: string): Excel.Setting; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.SettingCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.SettingCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.SettingCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.SettingCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SettingCollection; - load(option?: string | string[]): Excel.SettingCollection; - load(option?: OfficeExtension.LoadOption): Excel.SettingCollection; + load(options?: Excel.Interfaces.SettingCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SettingCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.SettingCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.SettingCollection; /** * * Occurs when the Settings in the document are changed. @@ -20573,7 +20564,7 @@ declare namespace Excel { */ class Setting extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; private static DateJSONPrefix; private static DateJSONSuffix; private static replaceStringDateWithDate; @@ -20613,23 +20604,23 @@ declare namespace Excel { */ delete(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.Setting` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.Setting` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Setting` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.SettingLoadOptions): Excel.Setting; - load(option?: string | string[]): Excel.Setting; - load(option?: { + load(options?: Excel.Interfaces.SettingLoadOptions): Excel.Setting; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Setting; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.Setting; @@ -20647,7 +20638,7 @@ declare namespace Excel { */ class NamedItemCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.NamedItem[]; /** @@ -20700,23 +20691,23 @@ declare namespace Excel { */ getItemOrNullObject(name: string): Excel.NamedItem; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.NamedItemCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.NamedItemCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.NamedItemCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.NamedItemCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.NamedItemCollection; - load(option?: string | string[]): Excel.NamedItemCollection; - load(option?: OfficeExtension.LoadOption): Excel.NamedItemCollection; + load(options?: Excel.Interfaces.NamedItemCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.NamedItemCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.NamedItemCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.NamedItemCollection; /** * 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.NamedItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.NamedItemCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -20731,7 +20722,7 @@ declare namespace Excel { */ class NamedItem extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns an object containing values and types of the named item. Read-only. @@ -20838,23 +20829,23 @@ declare namespace Excel { */ getRangeOrNullObject(): Excel.Range; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.NamedItem` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.NamedItem` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.NamedItem` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.NamedItemLoadOptions): Excel.NamedItem; - load(option?: string | string[]): Excel.NamedItem; - load(option?: { + load(options?: Excel.Interfaces.NamedItemLoadOptions): Excel.NamedItem; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.NamedItem; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.NamedItem; @@ -20872,7 +20863,7 @@ declare namespace Excel { */ class NamedItemArrayValues extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the types for each item in the named item array @@ -20888,23 +20879,23 @@ declare namespace Excel { */ readonly values: any[][]; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.NamedItemArrayValues` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.NamedItemArrayValues` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.NamedItemArrayValues` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.NamedItemArrayValuesLoadOptions): Excel.NamedItemArrayValues; - load(option?: string | string[]): Excel.NamedItemArrayValues; - load(option?: { + load(options?: Excel.Interfaces.NamedItemArrayValuesLoadOptions): Excel.NamedItemArrayValues; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.NamedItemArrayValues; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.NamedItemArrayValues; @@ -20922,7 +20913,7 @@ declare namespace Excel { */ class Binding extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents binding identifier. Read-only. @@ -20966,23 +20957,23 @@ declare namespace Excel { */ getText(): OfficeExtension.ClientResult; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.Binding` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.Binding` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Binding` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.BindingLoadOptions): Excel.Binding; - load(option?: string | string[]): Excel.Binding; - load(option?: { + load(options?: Excel.Interfaces.BindingLoadOptions): Excel.Binding; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Binding; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.Binding; @@ -21018,7 +21009,7 @@ declare namespace Excel { */ class BindingCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.Binding[]; /** @@ -21131,23 +21122,23 @@ declare namespace Excel { */ getItemOrNullObject(id: string): Excel.Binding; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.BindingCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.BindingCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.BindingCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.BindingCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.BindingCollection; - load(option?: string | string[]): Excel.BindingCollection; - load(option?: OfficeExtension.LoadOption): Excel.BindingCollection; + load(options?: Excel.Interfaces.BindingCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.BindingCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.BindingCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.BindingCollection; /** * 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.BindingCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.BindingCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -21162,7 +21153,7 @@ declare namespace Excel { */ class TableCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.Table[]; /** @@ -21217,23 +21208,23 @@ declare namespace Excel { */ getItemOrNullObject(key: string): Excel.Table; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.TableCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.TableCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.TableCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.TableCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableCollection; - load(option?: string | string[]): Excel.TableCollection; - load(option?: OfficeExtension.LoadOption): Excel.TableCollection; + load(options?: Excel.Interfaces.TableCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TableCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.TableCollection; /** * * Occurs when new table is added in a workbook. @@ -21275,7 +21266,7 @@ declare namespace Excel { */ class TableScopedCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.Table[]; /** @@ -21302,23 +21293,23 @@ declare namespace Excel { */ getItem(key: string): Excel.Table; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.TableScopedCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.TableScopedCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.TableScopedCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.TableScopedCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableScopedCollection; - load(option?: string | string[]): Excel.TableScopedCollection; - load(option?: OfficeExtension.LoadOption): Excel.TableScopedCollection; + load(options?: Excel.Interfaces.TableScopedCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableScopedCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TableScopedCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.TableScopedCollection; /** * 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.TableScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.TableScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -21334,7 +21325,7 @@ declare namespace Excel { */ class Table extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the AutoFilter object of the table. Read-Only. @@ -21518,23 +21509,23 @@ declare namespace Excel { */ reapplyFilters(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.Table` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.Table` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Table` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.TableLoadOptions): Excel.Table; - load(option?: string | string[]): Excel.Table; - load(option?: { + load(options?: Excel.Interfaces.TableLoadOptions): Excel.Table; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Table; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.Table; @@ -21570,7 +21561,7 @@ declare namespace Excel { */ class TableColumnCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.TableColumn[]; /** @@ -21626,23 +21617,23 @@ declare namespace Excel { */ getItemOrNullObject(key: number | string): Excel.TableColumn; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.TableColumnCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.TableColumnCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.TableColumnCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.TableColumnCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableColumnCollection; - load(option?: string | string[]): Excel.TableColumnCollection; - load(option?: OfficeExtension.LoadOption): Excel.TableColumnCollection; + load(options?: Excel.Interfaces.TableColumnCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableColumnCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TableColumnCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.TableColumnCollection; /** * 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.TableColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.TableColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -21657,7 +21648,7 @@ declare namespace Excel { */ class TableColumn extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Retrieve the filter applied to the column. Read-only. @@ -21743,23 +21734,23 @@ declare namespace Excel { */ getTotalRowRange(): Excel.Range; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.TableColumn` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.TableColumn` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.TableColumn` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.TableColumnLoadOptions): Excel.TableColumn; - load(option?: string | string[]): Excel.TableColumn; - load(option?: { + load(options?: Excel.Interfaces.TableColumnLoadOptions): Excel.TableColumn; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TableColumn; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.TableColumn; @@ -21782,7 +21773,7 @@ declare namespace Excel { */ class TableRowCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.TableRow[]; /** @@ -21829,23 +21820,23 @@ declare namespace Excel { */ getItemAt(index: number): Excel.TableRow; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.TableRowCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.TableRowCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.TableRowCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.TableRowCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableRowCollection; - load(option?: string | string[]): Excel.TableRowCollection; - load(option?: OfficeExtension.LoadOption): Excel.TableRowCollection; + load(options?: Excel.Interfaces.TableRowCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableRowCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TableRowCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.TableRowCollection; /** * 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.TableRowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.TableRowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -21865,7 +21856,7 @@ declare namespace Excel { */ class TableRow extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns the index number of the row within the rows collection of the table. Zero-indexed. Read-only. @@ -21909,23 +21900,23 @@ declare namespace Excel { */ getRange(): Excel.Range; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.TableRow` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.TableRow` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.TableRow` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.TableRowLoadOptions): Excel.TableRow; - load(option?: string | string[]): Excel.TableRow; - load(option?: { + load(options?: Excel.Interfaces.TableRowLoadOptions): Excel.TableRow; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TableRow; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.TableRow; @@ -21944,7 +21935,7 @@ declare namespace Excel { */ class DataValidation extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Error alert when user enters invalid data. @@ -22025,23 +22016,23 @@ declare namespace Excel { */ getInvalidCellsOrNullObject(): Excel.RangeAreas; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.DataValidation` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.DataValidation` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.DataValidation` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.DataValidationLoadOptions): Excel.DataValidation; - load(option?: string | string[]): Excel.DataValidation; - load(option?: { + load(options?: Excel.Interfaces.DataValidationLoadOptions): Excel.DataValidation; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.DataValidation; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.DataValidation; @@ -22116,7 +22107,7 @@ declare namespace Excel { */ class RemoveDuplicatesResult extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Number of duplicated rows removed by the operation. @@ -22132,23 +22123,23 @@ declare namespace Excel { */ readonly uniqueRemaining: number; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.RemoveDuplicatesResult` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.RemoveDuplicatesResult` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.RemoveDuplicatesResult` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.RemoveDuplicatesResultLoadOptions): Excel.RemoveDuplicatesResult; - load(option?: string | string[]): Excel.RemoveDuplicatesResult; - load(option?: { + load(options?: Excel.Interfaces.RemoveDuplicatesResultLoadOptions): Excel.RemoveDuplicatesResult; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.RemoveDuplicatesResult; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.RemoveDuplicatesResult; @@ -22336,7 +22327,7 @@ declare namespace Excel { */ class RangeFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Collection of border objects that apply to the overall range. Read-only. @@ -22486,23 +22477,23 @@ declare namespace Excel { */ autofitRows(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.RangeFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.RangeFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.RangeFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.RangeFormatLoadOptions): Excel.RangeFormat; - load(option?: string | string[]): Excel.RangeFormat; - load(option?: { + load(options?: Excel.Interfaces.RangeFormatLoadOptions): Excel.RangeFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.RangeFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.RangeFormat; @@ -22520,7 +22511,7 @@ declare namespace Excel { */ class FormatProtection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Indicates if Excel hides the formula for the cells in the range. A null value indicates that the entire range doesn't have uniform formula hidden setting. @@ -22550,23 +22541,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.FormatProtection): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.FormatProtection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.FormatProtection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.FormatProtection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.FormatProtectionLoadOptions): Excel.FormatProtection; - load(option?: string | string[]): Excel.FormatProtection; - load(option?: { + load(options?: Excel.Interfaces.FormatProtectionLoadOptions): Excel.FormatProtection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.FormatProtection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.FormatProtection; @@ -22584,10 +22575,10 @@ declare namespace Excel { */ class RangeFill extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * - * HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange") + * HTML color code representing the color of the background, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange") * * [Api set: ExcelApi 1.1] */ @@ -22646,23 +22637,23 @@ declare namespace Excel { */ clear(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.RangeFill` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.RangeFill` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.RangeFill` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.RangeFillLoadOptions): Excel.RangeFill; - load(option?: string | string[]): Excel.RangeFill; - load(option?: { + load(options?: Excel.Interfaces.RangeFillLoadOptions): Excel.RangeFill; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.RangeFill; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.RangeFill; @@ -22680,7 +22671,7 @@ declare namespace Excel { */ class RangeBorder extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange"). @@ -22732,23 +22723,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.RangeBorder): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.RangeBorder` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.RangeBorder` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.RangeBorder` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.RangeBorderLoadOptions): Excel.RangeBorder; - load(option?: string | string[]): Excel.RangeBorder; - load(option?: { + load(options?: Excel.Interfaces.RangeBorderLoadOptions): Excel.RangeBorder; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.RangeBorder; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.RangeBorder; @@ -22766,7 +22757,7 @@ declare namespace Excel { */ class RangeBorderCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.RangeBorder[]; /** @@ -22812,23 +22803,23 @@ declare namespace Excel { */ getItemAt(index: number): Excel.RangeBorder; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.RangeBorderCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.RangeBorderCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.RangeBorderCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.RangeBorderCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.RangeBorderCollection; - load(option?: string | string[]): Excel.RangeBorderCollection; - load(option?: OfficeExtension.LoadOption): Excel.RangeBorderCollection; + load(options?: Excel.Interfaces.RangeBorderCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.RangeBorderCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.RangeBorderCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.RangeBorderCollection; /** * 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.RangeBorderCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.RangeBorderCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -22843,7 +22834,7 @@ declare namespace Excel { */ class RangeFont extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the bold status of font. @@ -22936,23 +22927,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.RangeFont): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.RangeFont` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.RangeFont` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.RangeFont` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.RangeFontLoadOptions): Excel.RangeFont; - load(option?: string | string[]): Excel.RangeFont; - load(option?: { + load(options?: Excel.Interfaces.RangeFontLoadOptions): Excel.RangeFont; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.RangeFont; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.RangeFont; @@ -22970,7 +22961,7 @@ declare namespace Excel { */ class ChartCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.Chart[]; /** @@ -23038,23 +23029,23 @@ declare namespace Excel { */ getItemOrNullObject(name: string): Excel.Chart; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartCollection; - load(option?: string | string[]): Excel.ChartCollection; - load(option?: OfficeExtension.LoadOption): Excel.ChartCollection; + load(options?: Excel.Interfaces.ChartCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ChartCollection; /** * * Occurs when a chart is activated. @@ -23106,7 +23097,7 @@ declare namespace Excel { */ class Chart extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents chart axes. Read-only. @@ -23362,23 +23353,23 @@ declare namespace Excel { */ setPosition(startCell: Range | string, endCell?: Range | string): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.Chart` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.Chart` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Chart` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartLoadOptions): Excel.Chart; - load(option?: string | string[]): Excel.Chart; - load(option?: { + load(options?: Excel.Interfaces.ChartLoadOptions): Excel.Chart; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Chart; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.Chart; @@ -23414,7 +23405,7 @@ declare namespace Excel { */ class ChartPivotOptions extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Specifies whether or not to display the axis field buttons on a PivotChart. The ShowAxisFieldButtons property corresponds to the "Show Axis Field Buttons" command on the "Field Buttons" drop-down list of the "Analyze" tab, which is available when a PivotChart is selected. @@ -23458,23 +23449,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartPivotOptions): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartPivotOptions` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartPivotOptions` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartPivotOptions` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartPivotOptionsLoadOptions): Excel.ChartPivotOptions; - load(option?: string | string[]): Excel.ChartPivotOptions; - load(option?: { + load(options?: Excel.Interfaces.ChartPivotOptionsLoadOptions): Excel.ChartPivotOptions; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartPivotOptions; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartPivotOptions; @@ -23492,7 +23483,7 @@ declare namespace Excel { */ class ChartAreaFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the border format of chart area, which includes color, linestyle, and weight. Read-only. @@ -23543,23 +23534,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartAreaFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartAreaFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartAreaFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartAreaFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartAreaFormatLoadOptions): Excel.ChartAreaFormat; - load(option?: string | string[]): Excel.ChartAreaFormat; - load(option?: { + load(options?: Excel.Interfaces.ChartAreaFormatLoadOptions): Excel.ChartAreaFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartAreaFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartAreaFormat; @@ -23577,7 +23568,7 @@ declare namespace Excel { */ class ChartSeriesCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.ChartSeries[]; /** @@ -23614,23 +23605,23 @@ declare namespace Excel { */ getItemAt(index: number): Excel.ChartSeries; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartSeriesCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartSeriesCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartSeriesCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartSeriesCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartSeriesCollection; - load(option?: string | string[]): Excel.ChartSeriesCollection; - load(option?: OfficeExtension.LoadOption): Excel.ChartSeriesCollection; + load(options?: Excel.Interfaces.ChartSeriesCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartSeriesCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartSeriesCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ChartSeriesCollection; /** * 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.ChartSeriesCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartSeriesCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -23645,7 +23636,7 @@ declare namespace Excel { */ class ChartSeries extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Encapsulates the bin options for histogram charts and pareto charts. Read-only. @@ -24019,23 +24010,23 @@ declare namespace Excel { */ setXAxisValues(sourceData: Range): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartSeries` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartSeries` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartSeries` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartSeriesLoadOptions): Excel.ChartSeries; - load(option?: string | string[]): Excel.ChartSeries; - load(option?: { + load(options?: Excel.Interfaces.ChartSeriesLoadOptions): Excel.ChartSeries; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartSeries; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartSeries; @@ -24053,7 +24044,7 @@ declare namespace Excel { */ class ChartSeriesFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the fill format of a chart series, which includes background formatting information. Read-only. @@ -24083,23 +24074,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartSeriesFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartSeriesFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartSeriesFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartSeriesFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartSeriesFormatLoadOptions): Excel.ChartSeriesFormat; - load(option?: string | string[]): Excel.ChartSeriesFormat; - load(option?: { + load(options?: Excel.Interfaces.ChartSeriesFormatLoadOptions): Excel.ChartSeriesFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartSeriesFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartSeriesFormat; @@ -24117,7 +24108,7 @@ declare namespace Excel { */ class ChartPointsCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.ChartPoint[]; /** @@ -24144,23 +24135,23 @@ declare namespace Excel { */ getItemAt(index: number): Excel.ChartPoint; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartPointsCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartPointsCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartPointsCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartPointsCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartPointsCollection; - load(option?: string | string[]): Excel.ChartPointsCollection; - load(option?: OfficeExtension.LoadOption): Excel.ChartPointsCollection; + load(options?: Excel.Interfaces.ChartPointsCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartPointsCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartPointsCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ChartPointsCollection; /** * 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.ChartPointsCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartPointsCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -24175,7 +24166,7 @@ declare namespace Excel { */ class ChartPoint extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns the data label of a chart point. Read-only. @@ -24247,23 +24238,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartPoint): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartPoint` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartPoint` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartPoint` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartPointLoadOptions): Excel.ChartPoint; - load(option?: string | string[]): Excel.ChartPoint; - load(option?: { + load(options?: Excel.Interfaces.ChartPointLoadOptions): Excel.ChartPoint; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartPoint; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartPoint; @@ -24281,7 +24272,7 @@ declare namespace Excel { */ class ChartPointFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the border format of a chart data point, which includes color, style, and weight information. Read-only. @@ -24311,23 +24302,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartPointFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartPointFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartPointFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartPointFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartPointFormatLoadOptions): Excel.ChartPointFormat; - load(option?: string | string[]): Excel.ChartPointFormat; - load(option?: { + load(options?: Excel.Interfaces.ChartPointFormatLoadOptions): Excel.ChartPointFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartPointFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartPointFormat; @@ -24345,7 +24336,7 @@ declare namespace Excel { */ class ChartAxes extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the category axis in a chart. Read-only. @@ -24402,23 +24393,23 @@ declare namespace Excel { */ getItem(type: "Invalid" | "Category" | "Value" | "Series", group?: "Primary" | "Secondary"): Excel.ChartAxis; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartAxes` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartAxes` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartAxes` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartAxesLoadOptions): Excel.ChartAxes; - load(option?: string | string[]): Excel.ChartAxes; - load(option?: { + load(options?: Excel.Interfaces.ChartAxesLoadOptions): Excel.ChartAxes; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartAxes; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartAxes; @@ -24436,7 +24427,7 @@ declare namespace Excel { */ class ChartAxis extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the formatting of a chart object, which includes line and font formatting. Read-only. @@ -24752,23 +24743,23 @@ declare namespace Excel { */ setPositionAt(value: number): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartAxis` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartAxis` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartAxis` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartAxisLoadOptions): Excel.ChartAxis; - load(option?: string | string[]): Excel.ChartAxis; - load(option?: { + load(options?: Excel.Interfaces.ChartAxisLoadOptions): Excel.ChartAxis; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartAxis; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartAxis; @@ -24786,7 +24777,7 @@ declare namespace Excel { */ class ChartAxisFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents chart fill formatting. Read-only. @@ -24823,23 +24814,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartAxisFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartAxisFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartAxisFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartAxisFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartAxisFormatLoadOptions): Excel.ChartAxisFormat; - load(option?: string | string[]): Excel.ChartAxisFormat; - load(option?: { + load(options?: Excel.Interfaces.ChartAxisFormatLoadOptions): Excel.ChartAxisFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartAxisFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartAxisFormat; @@ -24857,7 +24848,7 @@ declare namespace Excel { */ class ChartAxisTitle extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the formatting of chart axis title. Read-only. @@ -24903,23 +24894,23 @@ declare namespace Excel { */ setFormula(formula: string): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartAxisTitle` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartAxisTitle` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartAxisTitle` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartAxisTitleLoadOptions): Excel.ChartAxisTitle; - load(option?: string | string[]): Excel.ChartAxisTitle; - load(option?: { + load(options?: Excel.Interfaces.ChartAxisTitleLoadOptions): Excel.ChartAxisTitle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartAxisTitle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartAxisTitle; @@ -24937,7 +24928,7 @@ declare namespace Excel { */ class ChartAxisTitleFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the border format, which includes color, linestyle, and weight. @@ -24974,23 +24965,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartAxisTitleFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartAxisTitleFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartAxisTitleFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartAxisTitleFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartAxisTitleFormatLoadOptions): Excel.ChartAxisTitleFormat; - load(option?: string | string[]): Excel.ChartAxisTitleFormat; - load(option?: { + load(options?: Excel.Interfaces.ChartAxisTitleFormatLoadOptions): Excel.ChartAxisTitleFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartAxisTitleFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartAxisTitleFormat; @@ -25008,7 +24999,7 @@ declare namespace Excel { */ class ChartDataLabels extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the format of chart data labels, which includes fill and font formatting. Read-only. @@ -25131,23 +25122,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartDataLabels): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartDataLabels` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartDataLabels` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartDataLabels` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartDataLabelsLoadOptions): Excel.ChartDataLabels; - load(option?: string | string[]): Excel.ChartDataLabels; - load(option?: { + load(options?: Excel.Interfaces.ChartDataLabelsLoadOptions): Excel.ChartDataLabels; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartDataLabels; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartDataLabels; @@ -25165,7 +25156,7 @@ declare namespace Excel { */ class ChartDataLabel extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the format of chart data label. @@ -25330,23 +25321,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartDataLabel): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartDataLabel` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartDataLabel` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartDataLabel` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartDataLabelLoadOptions): Excel.ChartDataLabel; - load(option?: string | string[]): Excel.ChartDataLabel; - load(option?: { + load(options?: Excel.Interfaces.ChartDataLabelLoadOptions): Excel.ChartDataLabel; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartDataLabel; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartDataLabel; @@ -25364,7 +25355,7 @@ declare namespace Excel { */ class ChartDataLabelFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the border format, which includes color, linestyle, and weight. Read-only. @@ -25401,23 +25392,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartDataLabelFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartDataLabelFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartDataLabelFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartDataLabelFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartDataLabelFormatLoadOptions): Excel.ChartDataLabelFormat; - load(option?: string | string[]): Excel.ChartDataLabelFormat; - load(option?: { + load(options?: Excel.Interfaces.ChartDataLabelFormatLoadOptions): Excel.ChartDataLabelFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartDataLabelFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartDataLabelFormat; @@ -25435,7 +25426,7 @@ declare namespace Excel { */ class ChartErrorBars extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Specifies the formatting type of the error bars. @@ -25486,23 +25477,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartErrorBars): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartErrorBars` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartErrorBars` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartErrorBars` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartErrorBarsLoadOptions): Excel.ChartErrorBars; - load(option?: string | string[]): Excel.ChartErrorBars; - load(option?: { + load(options?: Excel.Interfaces.ChartErrorBarsLoadOptions): Excel.ChartErrorBars; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartErrorBars; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartErrorBars; @@ -25520,7 +25511,7 @@ declare namespace Excel { */ class ChartErrorBarsFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the chart line formatting. @@ -25543,23 +25534,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartErrorBarsFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartErrorBarsFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartErrorBarsFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartErrorBarsFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartErrorBarsFormatLoadOptions): Excel.ChartErrorBarsFormat; - load(option?: string | string[]): Excel.ChartErrorBarsFormat; - load(option?: { + load(options?: Excel.Interfaces.ChartErrorBarsFormatLoadOptions): Excel.ChartErrorBarsFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartErrorBarsFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartErrorBarsFormat; @@ -25577,7 +25568,7 @@ declare namespace Excel { */ class ChartGridlines extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the formatting of chart gridlines. Read-only. @@ -25607,23 +25598,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartGridlines): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartGridlines` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartGridlines` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartGridlines` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartGridlinesLoadOptions): Excel.ChartGridlines; - load(option?: string | string[]): Excel.ChartGridlines; - load(option?: { + load(options?: Excel.Interfaces.ChartGridlinesLoadOptions): Excel.ChartGridlines; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartGridlines; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartGridlines; @@ -25641,7 +25632,7 @@ declare namespace Excel { */ class ChartGridlinesFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents chart line formatting. Read-only. @@ -25664,23 +25655,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartGridlinesFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartGridlinesFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartGridlinesFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartGridlinesFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartGridlinesFormatLoadOptions): Excel.ChartGridlinesFormat; - load(option?: string | string[]): Excel.ChartGridlinesFormat; - load(option?: { + load(options?: Excel.Interfaces.ChartGridlinesFormatLoadOptions): Excel.ChartGridlinesFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartGridlinesFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartGridlinesFormat; @@ -25698,7 +25689,7 @@ declare namespace Excel { */ class ChartLegend extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the formatting of a chart legend, which includes fill and font formatting. Read-only. @@ -25784,23 +25775,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartLegend): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartLegend` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartLegend` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartLegend` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartLegendLoadOptions): Excel.ChartLegend; - load(option?: string | string[]): Excel.ChartLegend; - load(option?: { + load(options?: Excel.Interfaces.ChartLegendLoadOptions): Excel.ChartLegend; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartLegend; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartLegend; @@ -25818,7 +25809,7 @@ declare namespace Excel { */ class ChartLegendEntry extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the height of the legendEntry on the chart legend. @@ -25876,23 +25867,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartLegendEntry): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartLegendEntry` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartLegendEntry` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartLegendEntry` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartLegendEntryLoadOptions): Excel.ChartLegendEntry; - load(option?: string | string[]): Excel.ChartLegendEntry; - load(option?: { + load(options?: Excel.Interfaces.ChartLegendEntryLoadOptions): Excel.ChartLegendEntry; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartLegendEntry; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartLegendEntry; @@ -25910,7 +25901,7 @@ declare namespace Excel { */ class ChartLegendEntryCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.ChartLegendEntry[]; /** @@ -25930,23 +25921,23 @@ declare namespace Excel { */ getItemAt(index: number): Excel.ChartLegendEntry; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartLegendEntryCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartLegendEntryCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartLegendEntryCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartLegendEntryCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartLegendEntryCollection; - load(option?: string | string[]): Excel.ChartLegendEntryCollection; - load(option?: OfficeExtension.LoadOption): Excel.ChartLegendEntryCollection; + load(options?: Excel.Interfaces.ChartLegendEntryCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartLegendEntryCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartLegendEntryCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ChartLegendEntryCollection; /** * 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.ChartLegendEntryCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartLegendEntryCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -25961,7 +25952,7 @@ declare namespace Excel { */ class ChartLegendFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the border format, which includes color, linestyle, and weight. Read-only. @@ -25998,23 +25989,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartLegendFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartLegendFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartLegendFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartLegendFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartLegendFormatLoadOptions): Excel.ChartLegendFormat; - load(option?: string | string[]): Excel.ChartLegendFormat; - load(option?: { + load(options?: Excel.Interfaces.ChartLegendFormatLoadOptions): Excel.ChartLegendFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartLegendFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartLegendFormat; @@ -26032,7 +26023,7 @@ declare namespace Excel { */ class ChartMapOptions extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns or sets the series map labels strategy of a region map chart. Read/Write. @@ -26069,23 +26060,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartMapOptions): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartMapOptions` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartMapOptions` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartMapOptions` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartMapOptionsLoadOptions): Excel.ChartMapOptions; - load(option?: string | string[]): Excel.ChartMapOptions; - load(option?: { + load(options?: Excel.Interfaces.ChartMapOptionsLoadOptions): Excel.ChartMapOptions; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartMapOptions; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartMapOptions; @@ -26103,7 +26094,7 @@ declare namespace Excel { */ class ChartTitle extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the formatting of a chart title, which includes fill and font formatting. Read-only. @@ -26229,23 +26220,23 @@ declare namespace Excel { */ setFormula(formula: string): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartTitle` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartTitle` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartTitle` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartTitleLoadOptions): Excel.ChartTitle; - load(option?: string | string[]): Excel.ChartTitle; - load(option?: { + load(options?: Excel.Interfaces.ChartTitleLoadOptions): Excel.ChartTitle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartTitle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartTitle; @@ -26263,7 +26254,7 @@ declare namespace Excel { */ class ChartFormatString extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the font attributes, such as font name, font size, color, etc. of chart characters object. @@ -26286,23 +26277,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartFormatString): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartFormatString` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartFormatString` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartFormatString` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartFormatStringLoadOptions): Excel.ChartFormatString; - load(option?: string | string[]): Excel.ChartFormatString; - load(option?: { + load(options?: Excel.Interfaces.ChartFormatStringLoadOptions): Excel.ChartFormatString; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartFormatString; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartFormatString; @@ -26320,7 +26311,7 @@ declare namespace Excel { */ class ChartTitleFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the border format of chart title, which includes color, linestyle, and weight. Read-only. @@ -26357,23 +26348,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartTitleFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartTitleFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartTitleFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartTitleFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartTitleFormatLoadOptions): Excel.ChartTitleFormat; - load(option?: string | string[]): Excel.ChartTitleFormat; - load(option?: { + load(options?: Excel.Interfaces.ChartTitleFormatLoadOptions): Excel.ChartTitleFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartTitleFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartTitleFormat; @@ -26391,7 +26382,7 @@ declare namespace Excel { */ class ChartFill extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. */ @@ -26409,7 +26400,7 @@ declare namespace Excel { * * [Api set: ExcelApi 1.1] * - * @param color HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange"). + * @param color HTML color code representing the color of the background, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange"). */ setSolidColor(color: string): void; /** @@ -26428,7 +26419,7 @@ declare namespace Excel { */ class ChartBorder extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * HTML color code representing the color of borders in the chart. @@ -26472,23 +26463,23 @@ declare namespace Excel { */ clear(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartBorder` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartBorder` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartBorder` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartBorderLoadOptions): Excel.ChartBorder; - load(option?: string | string[]): Excel.ChartBorder; - load(option?: { + load(options?: Excel.Interfaces.ChartBorderLoadOptions): Excel.ChartBorder; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartBorder; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartBorder; @@ -26506,7 +26497,7 @@ declare namespace Excel { */ class ChartBinOptions extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Specifies whether or not the bin overflow is enabled in a histogram chart or pareto chart. Read/Write. @@ -26571,23 +26562,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartBinOptions): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartBinOptions` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartBinOptions` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartBinOptions` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartBinOptionsLoadOptions): Excel.ChartBinOptions; - load(option?: string | string[]): Excel.ChartBinOptions; - load(option?: { + load(options?: Excel.Interfaces.ChartBinOptionsLoadOptions): Excel.ChartBinOptions; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartBinOptions; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartBinOptions; @@ -26605,7 +26596,7 @@ declare namespace Excel { */ class ChartBoxwhiskerOptions extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns or sets the quartile calculation type of a box and whisker chart. Read/Write. @@ -26656,23 +26647,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartBoxwhiskerOptions): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartBoxwhiskerOptions` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartBoxwhiskerOptions` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartBoxwhiskerOptions` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartBoxwhiskerOptionsLoadOptions): Excel.ChartBoxwhiskerOptions; - load(option?: string | string[]): Excel.ChartBoxwhiskerOptions; - load(option?: { + load(options?: Excel.Interfaces.ChartBoxwhiskerOptionsLoadOptions): Excel.ChartBoxwhiskerOptions; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartBoxwhiskerOptions; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartBoxwhiskerOptions; @@ -26690,7 +26681,7 @@ declare namespace Excel { */ class ChartLineFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * HTML color code representing the color of lines in the chart. @@ -26734,23 +26725,23 @@ declare namespace Excel { */ clear(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartLineFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartLineFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartLineFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartLineFormatLoadOptions): Excel.ChartLineFormat; - load(option?: string | string[]): Excel.ChartLineFormat; - load(option?: { + load(options?: Excel.Interfaces.ChartLineFormatLoadOptions): Excel.ChartLineFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartLineFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartLineFormat; @@ -26768,7 +26759,7 @@ declare namespace Excel { */ class ChartFont extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the bold status of font. @@ -26826,23 +26817,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartFont): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartFont` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartFont` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartFont` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartFontLoadOptions): Excel.ChartFont; - load(option?: string | string[]): Excel.ChartFont; - load(option?: { + load(options?: Excel.Interfaces.ChartFontLoadOptions): Excel.ChartFont; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartFont; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartFont; @@ -26860,7 +26851,7 @@ declare namespace Excel { */ class ChartTrendline extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the formatting of a chart trendline. @@ -26960,23 +26951,23 @@ declare namespace Excel { */ delete(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartTrendline` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartTrendline` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartTrendline` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartTrendlineLoadOptions): Excel.ChartTrendline; - load(option?: string | string[]): Excel.ChartTrendline; - load(option?: { + load(options?: Excel.Interfaces.ChartTrendlineLoadOptions): Excel.ChartTrendline; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartTrendline; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartTrendline; @@ -26994,7 +26985,7 @@ declare namespace Excel { */ class ChartTrendlineCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.ChartTrendline[]; /** @@ -27032,23 +27023,23 @@ declare namespace Excel { */ getItem(index: number): Excel.ChartTrendline; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartTrendlineCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartTrendlineCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartTrendlineCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartTrendlineCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartTrendlineCollection; - load(option?: string | string[]): Excel.ChartTrendlineCollection; - load(option?: OfficeExtension.LoadOption): Excel.ChartTrendlineCollection; + load(options?: Excel.Interfaces.ChartTrendlineCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartTrendlineCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartTrendlineCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ChartTrendlineCollection; /** * 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.ChartTrendlineCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartTrendlineCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -27063,7 +27054,7 @@ declare namespace Excel { */ class ChartTrendlineFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents chart line formatting. Read-only. @@ -27086,23 +27077,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartTrendlineFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartTrendlineFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartTrendlineFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartTrendlineFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartTrendlineFormatLoadOptions): Excel.ChartTrendlineFormat; - load(option?: string | string[]): Excel.ChartTrendlineFormat; - load(option?: { + load(options?: Excel.Interfaces.ChartTrendlineFormatLoadOptions): Excel.ChartTrendlineFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartTrendlineFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartTrendlineFormat; @@ -27120,7 +27111,7 @@ declare namespace Excel { */ class ChartTrendlineLabel extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the format of chart trendline label. @@ -27229,23 +27220,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartTrendlineLabel): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartTrendlineLabel` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartTrendlineLabel` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartTrendlineLabel` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartTrendlineLabelLoadOptions): Excel.ChartTrendlineLabel; - load(option?: string | string[]): Excel.ChartTrendlineLabel; - load(option?: { + load(options?: Excel.Interfaces.ChartTrendlineLabelLoadOptions): Excel.ChartTrendlineLabel; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartTrendlineLabel; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartTrendlineLabel; @@ -27263,7 +27254,7 @@ declare namespace Excel { */ class ChartTrendlineLabelFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the border format, which includes color, linestyle, and weight. @@ -27300,23 +27291,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartTrendlineLabelFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartTrendlineLabelFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartTrendlineLabelFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartTrendlineLabelFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartTrendlineLabelFormatLoadOptions): Excel.ChartTrendlineLabelFormat; - load(option?: string | string[]): Excel.ChartTrendlineLabelFormat; - load(option?: { + load(options?: Excel.Interfaces.ChartTrendlineLabelFormatLoadOptions): Excel.ChartTrendlineLabelFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartTrendlineLabelFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartTrendlineLabelFormat; @@ -27334,7 +27325,7 @@ declare namespace Excel { */ class ChartPlotArea extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the formatting of a chart plotArea. @@ -27420,23 +27411,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartPlotArea): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartPlotArea` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartPlotArea` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartPlotArea` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartPlotAreaLoadOptions): Excel.ChartPlotArea; - load(option?: string | string[]): Excel.ChartPlotArea; - load(option?: { + load(options?: Excel.Interfaces.ChartPlotAreaLoadOptions): Excel.ChartPlotArea; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartPlotArea; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartPlotArea; @@ -27454,7 +27445,7 @@ declare namespace Excel { */ class ChartPlotAreaFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the border attributes of a chart plotArea. @@ -27484,23 +27475,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ChartPlotAreaFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ChartPlotAreaFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ChartPlotAreaFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartPlotAreaFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ChartPlotAreaFormatLoadOptions): Excel.ChartPlotAreaFormat; - load(option?: string | string[]): Excel.ChartPlotAreaFormat; - load(option?: { + load(options?: Excel.Interfaces.ChartPlotAreaFormatLoadOptions): Excel.ChartPlotAreaFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartPlotAreaFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartPlotAreaFormat; @@ -27518,7 +27509,7 @@ declare namespace Excel { */ class RangeSort extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Perform a sort operation. @@ -27561,7 +27552,7 @@ declare namespace Excel { */ class TableSort extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the current conditions used to last sort the table. Read-only. @@ -27620,23 +27611,23 @@ declare namespace Excel { */ reapply(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.TableSort` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.TableSort` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.TableSort` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.TableSortLoadOptions): Excel.TableSort; - load(option?: string | string[]): Excel.TableSort; - load(option?: { + load(options?: Excel.Interfaces.TableSortLoadOptions): Excel.TableSort; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TableSort; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.TableSort; @@ -27711,7 +27702,7 @@ declare namespace Excel { */ class Filter extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * The currently applied filter on the given column. Read-only. @@ -27848,23 +27839,23 @@ declare namespace Excel { */ clear(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.Filter` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.Filter` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Filter` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.FilterLoadOptions): Excel.Filter; - load(option?: string | string[]): Excel.Filter; - load(option?: { + load(options?: Excel.Interfaces.FilterLoadOptions): Excel.Filter; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Filter; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.Filter; @@ -27979,7 +27970,7 @@ declare namespace Excel { */ class AutoFilter extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * An array that holds all the filter criteria in the autofiltered range. Read-Only. @@ -28049,23 +28040,23 @@ declare namespace Excel { */ remove(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.AutoFilter` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.AutoFilter` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.AutoFilter` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.AutoFilterLoadOptions): Excel.AutoFilter; - load(option?: string | string[]): Excel.AutoFilter; - load(option?: { + load(options?: Excel.Interfaces.AutoFilterLoadOptions): Excel.AutoFilter; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.AutoFilter; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.AutoFilter; @@ -28107,7 +28098,7 @@ declare namespace Excel { */ class CustomXmlPartScopedCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.CustomXmlPart[]; /** @@ -28153,23 +28144,23 @@ declare namespace Excel { */ getOnlyItemOrNullObject(): Excel.CustomXmlPart; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.CustomXmlPartScopedCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.CustomXmlPartScopedCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.CustomXmlPartScopedCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.CustomXmlPartScopedCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CustomXmlPartScopedCollection; - load(option?: string | string[]): Excel.CustomXmlPartScopedCollection; - load(option?: OfficeExtension.LoadOption): Excel.CustomXmlPartScopedCollection; + load(options?: Excel.Interfaces.CustomXmlPartScopedCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CustomXmlPartScopedCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.CustomXmlPartScopedCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.CustomXmlPartScopedCollection; /** * 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.CustomXmlPartScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.CustomXmlPartScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -28184,7 +28175,7 @@ declare namespace Excel { */ class CustomXmlPartCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.CustomXmlPart[]; /** @@ -28232,23 +28223,23 @@ declare namespace Excel { */ getItemOrNullObject(id: string): Excel.CustomXmlPart; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.CustomXmlPartCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.CustomXmlPartCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.CustomXmlPartCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.CustomXmlPartCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CustomXmlPartCollection; - load(option?: string | string[]): Excel.CustomXmlPartCollection; - load(option?: OfficeExtension.LoadOption): Excel.CustomXmlPartCollection; + load(options?: Excel.Interfaces.CustomXmlPartCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CustomXmlPartCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.CustomXmlPartCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.CustomXmlPartCollection; /** * 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.CustomXmlPartCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.CustomXmlPartCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -28263,7 +28254,7 @@ declare namespace Excel { */ class CustomXmlPart extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * The custom XML part's ID. Read-only. @@ -28302,23 +28293,23 @@ declare namespace Excel { */ setXml(xml: string): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.CustomXmlPart` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.CustomXmlPart` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.CustomXmlPart` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.CustomXmlPartLoadOptions): Excel.CustomXmlPart; - load(option?: string | string[]): Excel.CustomXmlPart; - load(option?: { + load(options?: Excel.Interfaces.CustomXmlPartLoadOptions): Excel.CustomXmlPart; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.CustomXmlPart; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.CustomXmlPart; @@ -28336,7 +28327,7 @@ declare namespace Excel { */ class PivotTableCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.PivotTable[]; /** @@ -28384,23 +28375,23 @@ declare namespace Excel { */ refreshAll(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.PivotTableCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.PivotTableCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PivotTableCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.PivotTableCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotTableCollection; - load(option?: string | string[]): Excel.PivotTableCollection; - load(option?: OfficeExtension.LoadOption): Excel.PivotTableCollection; + load(options?: Excel.Interfaces.PivotTableCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotTableCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PivotTableCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.PivotTableCollection; /** * 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.PivotTableCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.PivotTableCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -28416,7 +28407,7 @@ declare namespace Excel { */ class PivotTable extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * The Column Pivot Hierarchies of the PivotTable. @@ -28523,23 +28514,23 @@ declare namespace Excel { */ refresh(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.PivotTable` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.PivotTable` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PivotTable` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.PivotTableLoadOptions): Excel.PivotTable; - load(option?: string | string[]): Excel.PivotTable; - load(option?: { + load(options?: Excel.Interfaces.PivotTableLoadOptions): Excel.PivotTable; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PivotTable; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.PivotTable; @@ -28557,7 +28548,7 @@ declare namespace Excel { */ class PivotLayout extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Specifies whether formatting will be automatically formatted when it’s refreshed or when fields are moved @@ -28702,23 +28693,23 @@ declare namespace Excel { */ setAutoSortOnCell(cell: Range | string, sortBy: "Ascending" | "Descending"): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.PivotLayout` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.PivotLayout` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PivotLayout` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.PivotLayoutLoadOptions): Excel.PivotLayout; - load(option?: string | string[]): Excel.PivotLayout; - load(option?: { + load(options?: Excel.Interfaces.PivotLayoutLoadOptions): Excel.PivotLayout; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PivotLayout; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.PivotLayout; @@ -28736,7 +28727,7 @@ declare namespace Excel { */ class PivotHierarchyCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.PivotHierarchy[]; /** @@ -28765,23 +28756,23 @@ declare namespace Excel { */ getItemOrNullObject(name: string): Excel.PivotHierarchy; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.PivotHierarchyCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.PivotHierarchyCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PivotHierarchyCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.PivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotHierarchyCollection; - load(option?: string | string[]): Excel.PivotHierarchyCollection; - load(option?: OfficeExtension.LoadOption): Excel.PivotHierarchyCollection; + load(options?: Excel.Interfaces.PivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotHierarchyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PivotHierarchyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.PivotHierarchyCollection; /** * 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.PivotHierarchyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.PivotHierarchyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -28796,7 +28787,7 @@ declare namespace Excel { */ class PivotHierarchy extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns the PivotFields associated with the PivotHierarchy. @@ -28833,23 +28824,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.PivotHierarchy): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.PivotHierarchy` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.PivotHierarchy` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PivotHierarchy` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.PivotHierarchyLoadOptions): Excel.PivotHierarchy; - load(option?: string | string[]): Excel.PivotHierarchy; - load(option?: { + load(options?: Excel.Interfaces.PivotHierarchyLoadOptions): Excel.PivotHierarchy; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PivotHierarchy; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.PivotHierarchy; @@ -28867,7 +28858,7 @@ declare namespace Excel { */ class RowColumnPivotHierarchyCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.RowColumnPivotHierarchy[]; /** @@ -28911,23 +28902,23 @@ declare namespace Excel { */ remove(rowColumnPivotHierarchy: Excel.RowColumnPivotHierarchy): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.RowColumnPivotHierarchyCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.RowColumnPivotHierarchyCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.RowColumnPivotHierarchyCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.RowColumnPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.RowColumnPivotHierarchyCollection; - load(option?: string | string[]): Excel.RowColumnPivotHierarchyCollection; - load(option?: OfficeExtension.LoadOption): Excel.RowColumnPivotHierarchyCollection; + load(options?: Excel.Interfaces.RowColumnPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.RowColumnPivotHierarchyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.RowColumnPivotHierarchyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.RowColumnPivotHierarchyCollection; /** * 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.RowColumnPivotHierarchyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.RowColumnPivotHierarchyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -28942,7 +28933,7 @@ declare namespace Excel { */ class RowColumnPivotHierarchy extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns the PivotFields associated with the RowColumnPivotHierarchy. @@ -28993,23 +28984,23 @@ declare namespace Excel { */ setToDefault(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.RowColumnPivotHierarchy` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.RowColumnPivotHierarchy` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.RowColumnPivotHierarchy` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.RowColumnPivotHierarchyLoadOptions): Excel.RowColumnPivotHierarchy; - load(option?: string | string[]): Excel.RowColumnPivotHierarchy; - load(option?: { + load(options?: Excel.Interfaces.RowColumnPivotHierarchyLoadOptions): Excel.RowColumnPivotHierarchy; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.RowColumnPivotHierarchy; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.RowColumnPivotHierarchy; @@ -29027,7 +29018,7 @@ declare namespace Excel { */ class FilterPivotHierarchyCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.FilterPivotHierarchy[]; /** @@ -29071,23 +29062,23 @@ declare namespace Excel { */ remove(filterPivotHierarchy: Excel.FilterPivotHierarchy): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.FilterPivotHierarchyCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.FilterPivotHierarchyCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.FilterPivotHierarchyCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.FilterPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.FilterPivotHierarchyCollection; - load(option?: string | string[]): Excel.FilterPivotHierarchyCollection; - load(option?: OfficeExtension.LoadOption): Excel.FilterPivotHierarchyCollection; + load(options?: Excel.Interfaces.FilterPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.FilterPivotHierarchyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.FilterPivotHierarchyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.FilterPivotHierarchyCollection; /** * 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.FilterPivotHierarchyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.FilterPivotHierarchyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -29102,7 +29093,7 @@ declare namespace Excel { */ class FilterPivotHierarchy extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns the PivotFields associated with the FilterPivotHierarchy. @@ -29160,23 +29151,23 @@ declare namespace Excel { */ setToDefault(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.FilterPivotHierarchy` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.FilterPivotHierarchy` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.FilterPivotHierarchy` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.FilterPivotHierarchyLoadOptions): Excel.FilterPivotHierarchy; - load(option?: string | string[]): Excel.FilterPivotHierarchy; - load(option?: { + load(options?: Excel.Interfaces.FilterPivotHierarchyLoadOptions): Excel.FilterPivotHierarchy; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.FilterPivotHierarchy; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.FilterPivotHierarchy; @@ -29194,7 +29185,7 @@ declare namespace Excel { */ class DataPivotHierarchyCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.DataPivotHierarchy[]; /** @@ -29237,23 +29228,23 @@ declare namespace Excel { */ remove(DataPivotHierarchy: Excel.DataPivotHierarchy): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.DataPivotHierarchyCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.DataPivotHierarchyCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.DataPivotHierarchyCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.DataPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.DataPivotHierarchyCollection; - load(option?: string | string[]): Excel.DataPivotHierarchyCollection; - load(option?: OfficeExtension.LoadOption): Excel.DataPivotHierarchyCollection; + load(options?: Excel.Interfaces.DataPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.DataPivotHierarchyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.DataPivotHierarchyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.DataPivotHierarchyCollection; /** * 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.DataPivotHierarchyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.DataPivotHierarchyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -29268,7 +29259,7 @@ declare namespace Excel { */ class DataPivotHierarchy extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns the PivotFields associated with the DataPivotHierarchy. @@ -29340,23 +29331,23 @@ declare namespace Excel { */ setToDefault(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.DataPivotHierarchy` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.DataPivotHierarchy` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.DataPivotHierarchy` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.DataPivotHierarchyLoadOptions): Excel.DataPivotHierarchy; - load(option?: string | string[]): Excel.DataPivotHierarchy; - load(option?: { + load(options?: Excel.Interfaces.DataPivotHierarchyLoadOptions): Excel.DataPivotHierarchy; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.DataPivotHierarchy; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.DataPivotHierarchy; @@ -29400,7 +29391,7 @@ declare namespace Excel { */ class PivotFieldCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.PivotField[]; /** @@ -29429,23 +29420,23 @@ declare namespace Excel { */ getItemOrNullObject(name: string): Excel.PivotField; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.PivotFieldCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.PivotFieldCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PivotFieldCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.PivotFieldCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotFieldCollection; - load(option?: string | string[]): Excel.PivotFieldCollection; - load(option?: OfficeExtension.LoadOption): Excel.PivotFieldCollection; + load(options?: Excel.Interfaces.PivotFieldCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotFieldCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PivotFieldCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.PivotFieldCollection; /** * 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.PivotFieldCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.PivotFieldCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -29460,7 +29451,7 @@ declare namespace Excel { */ class PivotField extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns the PivotFields associated with the PivotField. @@ -29550,23 +29541,23 @@ declare namespace Excel { */ sortByValues(sortBy: "Ascending" | "Descending", valuesHierarchy: Excel.DataPivotHierarchy, pivotItemScope?: Array): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.PivotField` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.PivotField` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PivotField` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.PivotFieldLoadOptions): Excel.PivotField; - load(option?: string | string[]): Excel.PivotField; - load(option?: { + load(options?: Excel.Interfaces.PivotFieldLoadOptions): Excel.PivotField; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PivotField; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.PivotField; @@ -29584,7 +29575,7 @@ declare namespace Excel { */ class PivotItemCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.PivotItem[]; /** @@ -29613,23 +29604,23 @@ declare namespace Excel { */ getItemOrNullObject(name: string): Excel.PivotItem; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.PivotItemCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.PivotItemCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PivotItemCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.PivotItemCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotItemCollection; - load(option?: string | string[]): Excel.PivotItemCollection; - load(option?: OfficeExtension.LoadOption): Excel.PivotItemCollection; + load(options?: Excel.Interfaces.PivotItemCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotItemCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PivotItemCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.PivotItemCollection; /** * 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.PivotItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.PivotItemCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -29644,7 +29635,7 @@ declare namespace Excel { */ class PivotItem extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Id of the PivotItem. @@ -29688,23 +29679,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.PivotItem): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.PivotItem` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.PivotItem` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PivotItem` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.PivotItemLoadOptions): Excel.PivotItem; - load(option?: string | string[]): Excel.PivotItem; - load(option?: { + load(options?: Excel.Interfaces.PivotItemLoadOptions): Excel.PivotItem; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PivotItem; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.PivotItem; @@ -30012,7 +30003,7 @@ declare namespace Excel { */ class DocumentProperties extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Gets the collection of custom properties of the workbook. Read only. @@ -30112,23 +30103,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.DocumentProperties): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.DocumentProperties` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.DocumentProperties` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.DocumentProperties` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.DocumentPropertiesLoadOptions): Excel.DocumentProperties; - load(option?: string | string[]): Excel.DocumentProperties; - load(option?: { + load(options?: Excel.Interfaces.DocumentPropertiesLoadOptions): Excel.DocumentProperties; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.DocumentProperties; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.DocumentProperties; @@ -30146,7 +30137,7 @@ declare namespace Excel { */ class CustomProperty extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Gets the key of the custom property. Read only. @@ -30190,23 +30181,23 @@ declare namespace Excel { */ delete(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.CustomProperty` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.CustomProperty` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.CustomProperty` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.CustomPropertyLoadOptions): Excel.CustomProperty; - load(option?: string | string[]): Excel.CustomProperty; - load(option?: { + load(options?: Excel.Interfaces.CustomPropertyLoadOptions): Excel.CustomProperty; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.CustomProperty; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.CustomProperty; @@ -30224,7 +30215,7 @@ declare namespace Excel { */ class CustomPropertyCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.CustomProperty[]; /** @@ -30270,23 +30261,23 @@ declare namespace Excel { */ getItemOrNullObject(key: string): Excel.CustomProperty; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.CustomPropertyCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.CustomPropertyCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.CustomPropertyCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.CustomPropertyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CustomPropertyCollection; - load(option?: string | string[]): Excel.CustomPropertyCollection; - load(option?: OfficeExtension.LoadOption): Excel.CustomPropertyCollection; + load(options?: Excel.Interfaces.CustomPropertyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CustomPropertyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.CustomPropertyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.CustomPropertyCollection; /** * 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.CustomPropertyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.CustomPropertyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -30301,7 +30292,7 @@ declare namespace Excel { */ class ConditionalFormatCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.ConditionalFormat[]; /** @@ -30356,23 +30347,23 @@ declare namespace Excel { */ getItemAt(index: number): Excel.ConditionalFormat; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ConditionalFormatCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ConditionalFormatCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ConditionalFormatCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ConditionalFormatCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ConditionalFormatCollection; - load(option?: string | string[]): Excel.ConditionalFormatCollection; - load(option?: OfficeExtension.LoadOption): Excel.ConditionalFormatCollection; + load(options?: Excel.Interfaces.ConditionalFormatCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ConditionalFormatCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ConditionalFormatCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ConditionalFormatCollection; /** * 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.ConditionalFormatCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ConditionalFormatCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -30388,7 +30379,7 @@ declare namespace Excel { */ class ConditionalFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns the cell value conditional format properties if the current conditional format is a CellValue type. @@ -30583,23 +30574,23 @@ declare namespace Excel { */ getRanges(): Excel.RangeAreas; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ConditionalFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ConditionalFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ConditionalFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ConditionalFormatLoadOptions): Excel.ConditionalFormat; - load(option?: string | string[]): Excel.ConditionalFormat; - load(option?: { + load(options?: Excel.Interfaces.ConditionalFormatLoadOptions): Excel.ConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ConditionalFormat; @@ -30617,7 +30608,7 @@ declare namespace Excel { */ class DataBarConditionalFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Representation of all values to the left of the axis in an Excel data bar. Read-only. @@ -30692,23 +30683,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.DataBarConditionalFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.DataBarConditionalFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.DataBarConditionalFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.DataBarConditionalFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.DataBarConditionalFormatLoadOptions): Excel.DataBarConditionalFormat; - load(option?: string | string[]): Excel.DataBarConditionalFormat; - load(option?: { + load(options?: Excel.Interfaces.DataBarConditionalFormatLoadOptions): Excel.DataBarConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.DataBarConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.DataBarConditionalFormat; @@ -30726,7 +30717,7 @@ declare namespace Excel { */ class ConditionalDataBarPositiveFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange"). @@ -30764,23 +30755,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ConditionalDataBarPositiveFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ConditionalDataBarPositiveFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ConditionalDataBarPositiveFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ConditionalDataBarPositiveFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ConditionalDataBarPositiveFormatLoadOptions): Excel.ConditionalDataBarPositiveFormat; - load(option?: string | string[]): Excel.ConditionalDataBarPositiveFormat; - load(option?: { + load(options?: Excel.Interfaces.ConditionalDataBarPositiveFormatLoadOptions): Excel.ConditionalDataBarPositiveFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ConditionalDataBarPositiveFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ConditionalDataBarPositiveFormat; @@ -30798,7 +30789,7 @@ declare namespace Excel { */ class ConditionalDataBarNegativeFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange"). @@ -30843,23 +30834,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ConditionalDataBarNegativeFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ConditionalDataBarNegativeFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ConditionalDataBarNegativeFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ConditionalDataBarNegativeFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ConditionalDataBarNegativeFormatLoadOptions): Excel.ConditionalDataBarNegativeFormat; - load(option?: string | string[]): Excel.ConditionalDataBarNegativeFormat; - load(option?: { + load(options?: Excel.Interfaces.ConditionalDataBarNegativeFormatLoadOptions): Excel.ConditionalDataBarNegativeFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ConditionalDataBarNegativeFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ConditionalDataBarNegativeFormat; @@ -30899,7 +30890,7 @@ declare namespace Excel { */ class CustomConditionalFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. Read-only. @@ -30929,23 +30920,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.CustomConditionalFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.CustomConditionalFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.CustomConditionalFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.CustomConditionalFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.CustomConditionalFormatLoadOptions): Excel.CustomConditionalFormat; - load(option?: string | string[]): Excel.CustomConditionalFormat; - load(option?: { + load(options?: Excel.Interfaces.CustomConditionalFormatLoadOptions): Excel.CustomConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.CustomConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.CustomConditionalFormat; @@ -30963,7 +30954,7 @@ declare namespace Excel { */ class ConditionalFormatRule extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * The formula, if required, to evaluate the conditional format rule on. @@ -31000,23 +30991,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ConditionalFormatRule): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ConditionalFormatRule` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ConditionalFormatRule` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ConditionalFormatRule` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ConditionalFormatRuleLoadOptions): Excel.ConditionalFormatRule; - load(option?: string | string[]): Excel.ConditionalFormatRule; - load(option?: { + load(options?: Excel.Interfaces.ConditionalFormatRuleLoadOptions): Excel.ConditionalFormatRule; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ConditionalFormatRule; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ConditionalFormatRule; @@ -31034,7 +31025,7 @@ declare namespace Excel { */ class IconSetConditionalFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * An array of Criteria and IconSets for the rules and potential custom icons for conditional icons. Note that for the first criterion only the custom icon can be modified, while type, formula, and operator will be ignored when set. @@ -31078,23 +31069,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.IconSetConditionalFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.IconSetConditionalFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.IconSetConditionalFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.IconSetConditionalFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.IconSetConditionalFormatLoadOptions): Excel.IconSetConditionalFormat; - load(option?: string | string[]): Excel.IconSetConditionalFormat; - load(option?: { + load(options?: Excel.Interfaces.IconSetConditionalFormatLoadOptions): Excel.IconSetConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.IconSetConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.IconSetConditionalFormat; @@ -31148,7 +31139,7 @@ declare namespace Excel { */ class ColorScaleConditionalFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * The criteria of the color scale. Midpoint is optional when using a two point color scale. @@ -31178,23 +31169,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ColorScaleConditionalFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ColorScaleConditionalFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ColorScaleConditionalFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ColorScaleConditionalFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ColorScaleConditionalFormatLoadOptions): Excel.ColorScaleConditionalFormat; - load(option?: string | string[]): Excel.ColorScaleConditionalFormat; - load(option?: { + load(options?: Excel.Interfaces.ColorScaleConditionalFormatLoadOptions): Excel.ColorScaleConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ColorScaleConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ColorScaleConditionalFormat; @@ -31270,7 +31261,7 @@ declare namespace Excel { */ class TopBottomConditionalFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. Read-only. @@ -31300,23 +31291,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.TopBottomConditionalFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.TopBottomConditionalFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.TopBottomConditionalFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.TopBottomConditionalFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.TopBottomConditionalFormatLoadOptions): Excel.TopBottomConditionalFormat; - load(option?: string | string[]): Excel.TopBottomConditionalFormat; - load(option?: { + load(options?: Excel.Interfaces.TopBottomConditionalFormatLoadOptions): Excel.TopBottomConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TopBottomConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.TopBottomConditionalFormat; @@ -31356,7 +31347,7 @@ declare namespace Excel { */ class PresetCriteriaConditionalFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. @@ -31386,23 +31377,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.PresetCriteriaConditionalFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.PresetCriteriaConditionalFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.PresetCriteriaConditionalFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PresetCriteriaConditionalFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.PresetCriteriaConditionalFormatLoadOptions): Excel.PresetCriteriaConditionalFormat; - load(option?: string | string[]): Excel.PresetCriteriaConditionalFormat; - load(option?: { + load(options?: Excel.Interfaces.PresetCriteriaConditionalFormatLoadOptions): Excel.PresetCriteriaConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PresetCriteriaConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.PresetCriteriaConditionalFormat; @@ -31435,7 +31426,7 @@ declare namespace Excel { */ class TextConditionalFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. Read-only. @@ -31465,23 +31456,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.TextConditionalFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.TextConditionalFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.TextConditionalFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.TextConditionalFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.TextConditionalFormatLoadOptions): Excel.TextConditionalFormat; - load(option?: string | string[]): Excel.TextConditionalFormat; - load(option?: { + load(options?: Excel.Interfaces.TextConditionalFormatLoadOptions): Excel.TextConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TextConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.TextConditionalFormat; @@ -31521,7 +31512,7 @@ declare namespace Excel { */ class CellValueConditionalFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. @@ -31551,23 +31542,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.CellValueConditionalFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.CellValueConditionalFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.CellValueConditionalFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.CellValueConditionalFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.CellValueConditionalFormatLoadOptions): Excel.CellValueConditionalFormat; - load(option?: string | string[]): Excel.CellValueConditionalFormat; - load(option?: { + load(options?: Excel.Interfaces.CellValueConditionalFormatLoadOptions): Excel.CellValueConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.CellValueConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.CellValueConditionalFormat; @@ -31614,7 +31605,7 @@ declare namespace Excel { */ class ConditionalRangeFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Collection of border objects that apply to the overall conditional format range. Read-only. @@ -31658,23 +31649,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ConditionalRangeFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ConditionalRangeFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ConditionalRangeFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ConditionalRangeFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ConditionalRangeFormatLoadOptions): Excel.ConditionalRangeFormat; - load(option?: string | string[]): Excel.ConditionalRangeFormat; - load(option?: { + load(options?: Excel.Interfaces.ConditionalRangeFormatLoadOptions): Excel.ConditionalRangeFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ConditionalRangeFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ConditionalRangeFormat; @@ -31692,7 +31683,7 @@ declare namespace Excel { */ class ConditionalRangeFont extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the bold status of font. @@ -31750,23 +31741,23 @@ declare namespace Excel { */ clear(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ConditionalRangeFont` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ConditionalRangeFont` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ConditionalRangeFont` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ConditionalRangeFontLoadOptions): Excel.ConditionalRangeFont; - load(option?: string | string[]): Excel.ConditionalRangeFont; - load(option?: { + load(options?: Excel.Interfaces.ConditionalRangeFontLoadOptions): Excel.ConditionalRangeFont; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ConditionalRangeFont; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ConditionalRangeFont; @@ -31784,7 +31775,7 @@ declare namespace Excel { */ class ConditionalRangeFill extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * HTML color code representing the color of the fill, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange"). @@ -31814,23 +31805,23 @@ declare namespace Excel { */ clear(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ConditionalRangeFill` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ConditionalRangeFill` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ConditionalRangeFill` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ConditionalRangeFillLoadOptions): Excel.ConditionalRangeFill; - load(option?: string | string[]): Excel.ConditionalRangeFill; - load(option?: { + load(options?: Excel.Interfaces.ConditionalRangeFillLoadOptions): Excel.ConditionalRangeFill; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ConditionalRangeFill; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ConditionalRangeFill; @@ -31848,7 +31839,7 @@ declare namespace Excel { */ class ConditionalRangeBorder extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange"). @@ -31885,23 +31876,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ConditionalRangeBorder): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ConditionalRangeBorder` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ConditionalRangeBorder` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ConditionalRangeBorder` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ConditionalRangeBorderLoadOptions): Excel.ConditionalRangeBorder; - load(option?: string | string[]): Excel.ConditionalRangeBorder; - load(option?: { + load(options?: Excel.Interfaces.ConditionalRangeBorderLoadOptions): Excel.ConditionalRangeBorder; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ConditionalRangeBorder; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ConditionalRangeBorder; @@ -31919,7 +31910,7 @@ declare namespace Excel { */ class ConditionalRangeBorderCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Gets the bottom border. Read-only. @@ -31985,23 +31976,23 @@ declare namespace Excel { */ getItemAt(index: number): Excel.ConditionalRangeBorder; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ConditionalRangeBorderCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ConditionalRangeBorderCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ConditionalRangeBorderCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ConditionalRangeBorderCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ConditionalRangeBorderCollection; - load(option?: string | string[]): Excel.ConditionalRangeBorderCollection; - load(option?: OfficeExtension.LoadOption): Excel.ConditionalRangeBorderCollection; + load(options?: Excel.Interfaces.ConditionalRangeBorderCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ConditionalRangeBorderCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ConditionalRangeBorderCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ConditionalRangeBorderCollection; /** * 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.ConditionalRangeBorderCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ConditionalRangeBorderCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -32016,7 +32007,7 @@ declare namespace Excel { */ class Style extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * A Border collection of four Border objects that represent the style of the four borders. @@ -32200,23 +32191,23 @@ declare namespace Excel { */ delete(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.Style` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.Style` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Style` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.StyleLoadOptions): Excel.Style; - load(option?: string | string[]): Excel.Style; - load(option?: { + load(options?: Excel.Interfaces.StyleLoadOptions): Excel.Style; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Style; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.Style; @@ -32234,7 +32225,7 @@ declare namespace Excel { */ class StyleCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.Style[]; /** @@ -32272,23 +32263,23 @@ declare namespace Excel { */ getItemAt(index: number): Excel.Style; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.StyleCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.StyleCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.StyleCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.StyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.StyleCollection; - load(option?: string | string[]): Excel.StyleCollection; - load(option?: OfficeExtension.LoadOption): Excel.StyleCollection; + load(options?: Excel.Interfaces.StyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.StyleCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.StyleCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.StyleCollection; /** * 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.StyleCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.StyleCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -32303,7 +32294,7 @@ declare namespace Excel { */ class PageLayout extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Header and footer configuration for the worksheet. @@ -32549,23 +32540,23 @@ declare namespace Excel { */ setPrintTitleRows(printTitleRows: Range | string): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.PageLayout` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.PageLayout` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PageLayout` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.PageLayoutLoadOptions): Excel.PageLayout; - load(option?: string | string[]): Excel.PageLayout; - load(option?: { + load(options?: Excel.Interfaces.PageLayoutLoadOptions): Excel.PageLayout; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PageLayout; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.PageLayout; @@ -32659,7 +32650,7 @@ declare namespace Excel { */ class HeaderFooter extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Gets or sets the center footer of the worksheet. @@ -32723,23 +32714,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.HeaderFooter): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.HeaderFooter` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.HeaderFooter` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.HeaderFooter` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.HeaderFooterLoadOptions): Excel.HeaderFooter; - load(option?: string | string[]): Excel.HeaderFooter; - load(option?: { + load(options?: Excel.Interfaces.HeaderFooterLoadOptions): Excel.HeaderFooter; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.HeaderFooter; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.HeaderFooter; @@ -32754,7 +32745,7 @@ declare namespace Excel { */ class HeaderFooterGroup extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * The general header/footer, used for all pages unless even/odd or first page is specified. @@ -32819,23 +32810,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.HeaderFooterGroup): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.HeaderFooterGroup` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.HeaderFooterGroup` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.HeaderFooterGroup` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.HeaderFooterGroupLoadOptions): Excel.HeaderFooterGroup; - load(option?: string | string[]): Excel.HeaderFooterGroup; - load(option?: { + load(options?: Excel.Interfaces.HeaderFooterGroupLoadOptions): Excel.HeaderFooterGroup; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.HeaderFooterGroup; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.HeaderFooterGroup; @@ -32850,7 +32841,7 @@ declare namespace Excel { */ class PageBreak extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the column index for the page break @@ -32880,23 +32871,23 @@ declare namespace Excel { */ getCellAfterBreak(): Excel.Range; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.PageBreak` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.PageBreak` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PageBreak` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.PageBreakLoadOptions): Excel.PageBreak; - load(option?: string | string[]): Excel.PageBreak; - load(option?: { + load(options?: Excel.Interfaces.PageBreakLoadOptions): Excel.PageBreak; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PageBreak; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.PageBreak; @@ -32911,7 +32902,7 @@ declare namespace Excel { */ class PageBreakCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.PageBreak[]; /** @@ -32947,23 +32938,23 @@ declare namespace Excel { */ removePageBreaks(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.PageBreakCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.PageBreakCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PageBreakCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.PageBreakCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PageBreakCollection; - load(option?: string | string[]): Excel.PageBreakCollection; - load(option?: OfficeExtension.LoadOption): Excel.PageBreakCollection; + load(options?: Excel.Interfaces.PageBreakCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PageBreakCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PageBreakCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.PageBreakCollection; /** * 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.PageBreakCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.PageBreakCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -32978,7 +32969,7 @@ declare namespace Excel { */ class DataConnectionCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Refreshes all the Data Connections in the collection. @@ -32999,7 +32990,7 @@ declare namespace Excel { */ class RangeCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.Range[]; /** @@ -33019,23 +33010,23 @@ declare namespace Excel { */ getItemAt(index: number): Excel.Range; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.RangeCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.RangeCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.RangeCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.RangeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.RangeCollection; - load(option?: string | string[]): Excel.RangeCollection; - load(option?: OfficeExtension.LoadOption): Excel.RangeCollection; + load(options?: Excel.Interfaces.RangeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.RangeCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.RangeCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.RangeCollection; /** * 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.RangeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.RangeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -33050,7 +33041,7 @@ declare namespace Excel { */ class ShapeCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.Shape[]; /** @@ -33150,23 +33141,23 @@ declare namespace Excel { */ getItemAt(index: number): Excel.Shape; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ShapeCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ShapeCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ShapeCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ShapeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ShapeCollection; - load(option?: string | string[]): Excel.ShapeCollection; - load(option?: OfficeExtension.LoadOption): Excel.ShapeCollection; + load(options?: Excel.Interfaces.ShapeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ShapeCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ShapeCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ShapeCollection; /** * 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.ShapeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ShapeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -33182,7 +33173,7 @@ declare namespace Excel { */ class Shape extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns the fill formatting of this shape. Read-only. @@ -33485,23 +33476,23 @@ declare namespace Excel { */ setZOrder(position: "BringToFront" | "BringForward" | "SendToBack" | "SendBackward"): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.Shape` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.Shape` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Shape` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ShapeLoadOptions): Excel.Shape; - load(option?: string | string[]): Excel.Shape; - load(option?: { + load(options?: Excel.Interfaces.ShapeLoadOptions): Excel.Shape; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Shape; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.Shape; @@ -33537,7 +33528,7 @@ declare namespace Excel { */ class GeometricShape extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns the Shape object for the geometric shape. Read-only. @@ -33553,23 +33544,23 @@ declare namespace Excel { */ readonly id: string; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.GeometricShape` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.GeometricShape` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.GeometricShape` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.GeometricShapeLoadOptions): Excel.GeometricShape; - load(option?: string | string[]): Excel.GeometricShape; - load(option?: { + load(options?: Excel.Interfaces.GeometricShapeLoadOptions): Excel.GeometricShape; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.GeometricShape; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.GeometricShape; @@ -33587,7 +33578,7 @@ declare namespace Excel { */ class Image extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns the Shape object associated with the image. Read-only. @@ -33610,23 +33601,23 @@ declare namespace Excel { */ readonly format: Excel.PictureFormat | "UNKNOWN" | "BMP" | "JPEG" | "GIF" | "PNG" | "SVG"; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.Image` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.Image` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Image` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ImageLoadOptions): Excel.Image; - load(option?: string | string[]): Excel.Image; - load(option?: { + load(options?: Excel.Interfaces.ImageLoadOptions): Excel.Image; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Image; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.Image; @@ -33644,7 +33635,7 @@ declare namespace Excel { */ class ShapeGroup extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns the Shape object associated with the group. Read-only. @@ -33674,23 +33665,23 @@ declare namespace Excel { */ ungroup(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ShapeGroup` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ShapeGroup` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ShapeGroup` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ShapeGroupLoadOptions): Excel.ShapeGroup; - load(option?: string | string[]): Excel.ShapeGroup; - load(option?: { + load(options?: Excel.Interfaces.ShapeGroupLoadOptions): Excel.ShapeGroup; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ShapeGroup; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ShapeGroup; @@ -33708,7 +33699,7 @@ declare namespace Excel { */ class GroupShapeCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Excel.Shape[]; /** @@ -33737,23 +33728,23 @@ declare namespace Excel { */ getItemAt(index: number): Excel.Shape; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.GroupShapeCollection` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.GroupShapeCollection` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.GroupShapeCollection` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.GroupShapeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.GroupShapeCollection; - load(option?: string | string[]): Excel.GroupShapeCollection; - load(option?: OfficeExtension.LoadOption): Excel.GroupShapeCollection; + load(options?: Excel.Interfaces.GroupShapeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.GroupShapeCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.GroupShapeCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.GroupShapeCollection; /** * 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.GroupShapeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.GroupShapeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -33768,7 +33759,7 @@ declare namespace Excel { */ class Line extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the shape to which the beginning of the specified line is attached. Read-only. @@ -33923,23 +33914,23 @@ declare namespace Excel { */ disconnectEndShape(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.Line` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.Line` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Line` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.LineLoadOptions): Excel.Line; - load(option?: string | string[]): Excel.Line; - load(option?: { + load(options?: Excel.Interfaces.LineLoadOptions): Excel.Line; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Line; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.Line; @@ -33957,7 +33948,7 @@ declare namespace Excel { */ class ShapeFill extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the shape fill foreground color in HTML color format, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange") @@ -34010,23 +34001,23 @@ declare namespace Excel { */ setSolidColor(color: string): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ShapeFill` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ShapeFill` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ShapeFill` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ShapeFillLoadOptions): Excel.ShapeFill; - load(option?: string | string[]): Excel.ShapeFill; - load(option?: { + load(options?: Excel.Interfaces.ShapeFillLoadOptions): Excel.ShapeFill; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ShapeFill; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ShapeFill; @@ -34044,7 +34035,7 @@ declare namespace Excel { */ class ShapeLineFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the line color in HTML color format, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange"). @@ -34102,23 +34093,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ShapeLineFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ShapeLineFormat` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ShapeLineFormat` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ShapeLineFormat` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ShapeLineFormatLoadOptions): Excel.ShapeLineFormat; - load(option?: string | string[]): Excel.ShapeLineFormat; - load(option?: { + load(options?: Excel.Interfaces.ShapeLineFormatLoadOptions): Excel.ShapeLineFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ShapeLineFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ShapeLineFormat; @@ -34136,7 +34127,7 @@ declare namespace Excel { */ class TextFrame extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the text that is attached to a shape in the text frame, and properties and methods for manipulating the text. See Excel.TextRange for details. @@ -34250,23 +34241,23 @@ declare namespace Excel { */ deleteText(): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.TextFrame` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.TextFrame` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.TextFrame` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.TextFrameLoadOptions): Excel.TextFrame; - load(option?: string | string[]): Excel.TextFrame; - load(option?: { + load(options?: Excel.Interfaces.TextFrameLoadOptions): Excel.TextFrame; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TextFrame; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.TextFrame; @@ -34284,7 +34275,7 @@ declare namespace Excel { */ class TextRange extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns a ShapeFont object that represents the font attributes for the text range. Read-only. @@ -34324,23 +34315,23 @@ declare namespace Excel { */ getSubstring(start: number, length?: number): Excel.TextRange; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.TextRange` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.TextRange` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.TextRange` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.TextRangeLoadOptions): Excel.TextRange; - load(option?: string | string[]): Excel.TextRange; - load(option?: { + load(options?: Excel.Interfaces.TextRangeLoadOptions): Excel.TextRange; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TextRange; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.TextRange; @@ -34358,7 +34349,7 @@ declare namespace Excel { */ class ShapeFont extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Represents the bold status of font. Returns null the TextRange includes both bold and non-bold text fragments. @@ -34416,23 +34407,23 @@ declare namespace Excel { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.ShapeFont): void; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): Excel.ShapeFont` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): Excel.ShapeFont` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ShapeFont` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.ShapeFontLoadOptions): Excel.ShapeFont; - load(option?: string | string[]): Excel.ShapeFont; - load(option?: { + load(options?: Excel.Interfaces.ShapeFontLoadOptions): Excel.ShapeFont; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ShapeFont; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ShapeFont; @@ -37161,7 +37152,7 @@ declare namespace Excel { */ class FunctionResult extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Error value (such as "#DIV/0") representing the error. If the error string is not set, then the function succeeded, and its result is written to the Value field. The error is always in the English locale. @@ -37177,23 +37168,23 @@ declare namespace Excel { */ readonly value: T; /** - * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. - * - * @remarks - * - * In addition to this signature, this method has the following signatures: - * - * `load(option?: string | string[]): FunctionResult` - Where option is a comma-delimited string or an array of strings that specify the properties to load. - * - * `load(option?: { select?: string; expand?: string; }): FunctionResult` - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load. - * - * `load(option?: { select?: string; expand?: string; top?: number; skip?: number }): FunctionResult` - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(option?: Excel.Interfaces.FunctionResultLoadOptions): FunctionResult; - load(option?: string | string[]): FunctionResult; - load(option?: { + load(options?: Excel.Interfaces.FunctionResultLoadOptions): FunctionResult; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): FunctionResult; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { select?: string; expand?: string; }): FunctionResult; @@ -37211,7 +37202,7 @@ declare namespace Excel { */ class Functions extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Returns the absolute value of a number, a number without its sign. @@ -40989,7 +40980,7 @@ declare namespace Excel { */ $skip?: number; } - /** An interface for updating data on the Runtime object, for use in "runtime.set({ ... })". */ + /** An interface for updating data on the Runtime object, for use in `runtime.set({ ... })`. */ interface RuntimeUpdateData { /** * @@ -40999,7 +40990,7 @@ declare namespace Excel { */ enableEvents?: boolean; } - /** An interface for updating data on the Application object, for use in "application.set({ ... })". */ + /** An interface for updating data on the Application object, for use in `application.set({ ... })`. */ interface ApplicationUpdateData { /** * @@ -41018,7 +41009,7 @@ declare namespace Excel { */ calculationMode?: Excel.CalculationMode | "Automatic" | "AutomaticExceptTables" | "Manual"; } - /** An interface for updating data on the IterativeCalculation object, for use in "iterativeCalculation.set({ ... })". */ + /** An interface for updating data on the IterativeCalculation object, for use in `iterativeCalculation.set({ ... })`. */ interface IterativeCalculationUpdateData { /** * @@ -41042,7 +41033,7 @@ declare namespace Excel { */ maxIteration?: number; } - /** An interface for updating data on the Workbook object, for use in "workbook.set({ ... })". */ + /** An interface for updating data on the Workbook object, for use in `workbook.set({ ... })`. */ interface WorkbookUpdateData { /** * @@ -41076,7 +41067,7 @@ declare namespace Excel { */ usePrecisionAsDisplayed?: boolean; } - /** An interface for updating data on the Worksheet object, for use in "worksheet.set({ ... })". */ + /** An interface for updating data on the Worksheet object, for use in `worksheet.set({ ... })`. */ interface WorksheetUpdateData { /** * @@ -41148,11 +41139,11 @@ declare namespace Excel { */ visibility?: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden"; } - /** An interface for updating data on the WorksheetCollection object, for use in "worksheetCollection.set({ ... })". */ + /** An interface for updating data on the WorksheetCollection object, for use in `worksheetCollection.set({ ... })`. */ interface WorksheetCollectionUpdateData { items?: Excel.Interfaces.WorksheetData[]; } - /** An interface for updating data on the Range object, for use in "range.set({ ... })". */ + /** An interface for updating data on the Range object, for use in `range.set({ ... })`. */ interface RangeUpdateData { /** * @@ -41250,7 +41241,7 @@ declare namespace Excel { */ values?: any[][]; } - /** An interface for updating data on the RangeAreas object, for use in "rangeAreas.set({ ... })". */ + /** An interface for updating data on the RangeAreas object, for use in `rangeAreas.set({ ... })`. */ interface RangeAreasUpdateData { /** * @@ -41276,7 +41267,7 @@ declare namespace Excel { */ style?: string; } - /** An interface for updating data on the RangeView object, for use in "rangeView.set({ ... })". */ + /** An interface for updating data on the RangeView object, for use in `rangeView.set({ ... })`. */ interface RangeViewUpdateData { /** * @@ -41314,15 +41305,15 @@ declare namespace Excel { */ values?: any[][]; } - /** An interface for updating data on the RangeViewCollection object, for use in "rangeViewCollection.set({ ... })". */ + /** An interface for updating data on the RangeViewCollection object, for use in `rangeViewCollection.set({ ... })`. */ interface RangeViewCollectionUpdateData { items?: Excel.Interfaces.RangeViewData[]; } - /** An interface for updating data on the SettingCollection object, for use in "settingCollection.set({ ... })". */ + /** An interface for updating data on the SettingCollection object, for use in `settingCollection.set({ ... })`. */ interface SettingCollectionUpdateData { items?: Excel.Interfaces.SettingData[]; } - /** An interface for updating data on the Setting object, for use in "setting.set({ ... })". */ + /** An interface for updating data on the Setting object, for use in `setting.set({ ... })`. */ interface SettingUpdateData { /** * @@ -41332,11 +41323,11 @@ declare namespace Excel { */ value?: any; } - /** An interface for updating data on the NamedItemCollection object, for use in "namedItemCollection.set({ ... })". */ + /** An interface for updating data on the NamedItemCollection object, for use in `namedItemCollection.set({ ... })`. */ interface NamedItemCollectionUpdateData { items?: Excel.Interfaces.NamedItemData[]; } - /** An interface for updating data on the NamedItem object, for use in "namedItem.set({ ... })". */ + /** An interface for updating data on the NamedItem object, for use in `namedItem.set({ ... })`. */ interface NamedItemUpdateData { /** * @@ -41360,19 +41351,19 @@ declare namespace Excel { */ visible?: boolean; } - /** An interface for updating data on the BindingCollection object, for use in "bindingCollection.set({ ... })". */ + /** An interface for updating data on the BindingCollection object, for use in `bindingCollection.set({ ... })`. */ interface BindingCollectionUpdateData { items?: Excel.Interfaces.BindingData[]; } - /** An interface for updating data on the TableCollection object, for use in "tableCollection.set({ ... })". */ + /** An interface for updating data on the TableCollection object, for use in `tableCollection.set({ ... })`. */ interface TableCollectionUpdateData { items?: Excel.Interfaces.TableData[]; } - /** An interface for updating data on the TableScopedCollection object, for use in "tableScopedCollection.set({ ... })". */ + /** An interface for updating data on the TableScopedCollection object, for use in `tableScopedCollection.set({ ... })`. */ interface TableScopedCollectionUpdateData { items?: Excel.Interfaces.TableData[]; } - /** An interface for updating data on the Table object, for use in "table.set({ ... })". */ + /** An interface for updating data on the Table object, for use in `table.set({ ... })`. */ interface TableUpdateData { /** * @@ -41438,11 +41429,11 @@ declare namespace Excel { */ style?: string; } - /** An interface for updating data on the TableColumnCollection object, for use in "tableColumnCollection.set({ ... })". */ + /** An interface for updating data on the TableColumnCollection object, for use in `tableColumnCollection.set({ ... })`. */ interface TableColumnCollectionUpdateData { items?: Excel.Interfaces.TableColumnData[]; } - /** An interface for updating data on the TableColumn object, for use in "tableColumn.set({ ... })". */ + /** An interface for updating data on the TableColumn object, for use in `tableColumn.set({ ... })`. */ interface TableColumnUpdateData { /** * @@ -41459,11 +41450,11 @@ declare namespace Excel { */ values?: any[][]; } - /** An interface for updating data on the TableRowCollection object, for use in "tableRowCollection.set({ ... })". */ + /** An interface for updating data on the TableRowCollection object, for use in `tableRowCollection.set({ ... })`. */ interface TableRowCollectionUpdateData { items?: Excel.Interfaces.TableRowData[]; } - /** An interface for updating data on the TableRow object, for use in "tableRow.set({ ... })". */ + /** An interface for updating data on the TableRow object, for use in `tableRow.set({ ... })`. */ interface TableRowUpdateData { /** * @@ -41473,7 +41464,7 @@ declare namespace Excel { */ values?: any[][]; } - /** An interface for updating data on the DataValidation object, for use in "dataValidation.set({ ... })". */ + /** An interface for updating data on the DataValidation object, for use in `dataValidation.set({ ... })`. */ interface DataValidationUpdateData { /** * @@ -41504,7 +41495,7 @@ declare namespace Excel { */ rule?: Excel.DataValidationRule; } - /** An interface for updating data on the RangeFormat object, for use in "rangeFormat.set({ ... })". */ + /** An interface for updating data on the RangeFormat object, for use in `rangeFormat.set({ ... })`. */ interface RangeFormatUpdateData { /** * @@ -41627,7 +41618,7 @@ declare namespace Excel { */ wrapText?: boolean; } - /** An interface for updating data on the FormatProtection object, for use in "formatProtection.set({ ... })". */ + /** An interface for updating data on the FormatProtection object, for use in `formatProtection.set({ ... })`. */ interface FormatProtectionUpdateData { /** * @@ -41644,11 +41635,11 @@ declare namespace Excel { */ locked?: boolean; } - /** An interface for updating data on the RangeFill object, for use in "rangeFill.set({ ... })". */ + /** An interface for updating data on the RangeFill object, for use in `rangeFill.set({ ... })`. */ interface RangeFillUpdateData { /** * - * HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange") + * HTML color code representing the color of the background, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange") * * [Api set: ExcelApi 1.1] */ @@ -41686,7 +41677,7 @@ declare namespace Excel { */ tintAndShade?: number; } - /** An interface for updating data on the RangeBorder object, for use in "rangeBorder.set({ ... })". */ + /** An interface for updating data on the RangeBorder object, for use in `rangeBorder.set({ ... })`. */ interface RangeBorderUpdateData { /** * @@ -41718,7 +41709,7 @@ declare namespace Excel { */ weight?: Excel.BorderWeight | "Hairline" | "Thin" | "Medium" | "Thick"; } - /** An interface for updating data on the RangeBorderCollection object, for use in "rangeBorderCollection.set({ ... })". */ + /** An interface for updating data on the RangeBorderCollection object, for use in `rangeBorderCollection.set({ ... })`. */ interface RangeBorderCollectionUpdateData { /** * @@ -41730,7 +41721,7 @@ declare namespace Excel { tintAndShade?: number; items?: Excel.Interfaces.RangeBorderData[]; } - /** An interface for updating data on the RangeFont object, for use in "rangeFont.set({ ... })". */ + /** An interface for updating data on the RangeFont object, for use in `rangeFont.set({ ... })`. */ interface RangeFontUpdateData { /** * @@ -41810,11 +41801,11 @@ declare namespace Excel { */ underline?: Excel.RangeUnderlineStyle | "None" | "Single" | "Double" | "SingleAccountant" | "DoubleAccountant"; } - /** An interface for updating data on the ChartCollection object, for use in "chartCollection.set({ ... })". */ + /** An interface for updating data on the ChartCollection object, for use in `chartCollection.set({ ... })`. */ interface ChartCollectionUpdateData { items?: Excel.Interfaces.ChartData[]; } - /** An interface for updating data on the Chart object, for use in "chart.set({ ... })". */ + /** An interface for updating data on the Chart object, for use in `chart.set({ ... })`. */ interface ChartUpdateData { /** * @@ -41968,7 +41959,7 @@ declare namespace Excel { */ width?: number; } - /** An interface for updating data on the ChartPivotOptions object, for use in "chartPivotOptions.set({ ... })". */ + /** An interface for updating data on the ChartPivotOptions object, for use in `chartPivotOptions.set({ ... })`. */ interface ChartPivotOptionsUpdateData { /** * @@ -41999,7 +41990,7 @@ declare namespace Excel { */ showValueFieldButtons?: boolean; } - /** An interface for updating data on the ChartAreaFormat object, for use in "chartAreaFormat.set({ ... })". */ + /** An interface for updating data on the ChartAreaFormat object, for use in `chartAreaFormat.set({ ... })`. */ interface ChartAreaFormatUpdateData { /** * @@ -42030,11 +42021,11 @@ declare namespace Excel { */ roundedCorners?: boolean; } - /** An interface for updating data on the ChartSeriesCollection object, for use in "chartSeriesCollection.set({ ... })". */ + /** An interface for updating data on the ChartSeriesCollection object, for use in `chartSeriesCollection.set({ ... })`. */ interface ChartSeriesCollectionUpdateData { items?: Excel.Interfaces.ChartSeriesData[]; } - /** An interface for updating data on the ChartSeries object, for use in "chartSeries.set({ ... })". */ + /** An interface for updating data on the ChartSeries object, for use in `chartSeries.set({ ... })`. */ interface ChartSeriesUpdateData { /** * @@ -42347,7 +42338,7 @@ declare namespace Excel { */ varyByCategories?: boolean; } - /** An interface for updating data on the ChartSeriesFormat object, for use in "chartSeriesFormat.set({ ... })". */ + /** An interface for updating data on the ChartSeriesFormat object, for use in `chartSeriesFormat.set({ ... })`. */ interface ChartSeriesFormatUpdateData { /** * @@ -42357,11 +42348,11 @@ declare namespace Excel { */ line?: Excel.Interfaces.ChartLineFormatUpdateData; } - /** An interface for updating data on the ChartPointsCollection object, for use in "chartPointsCollection.set({ ... })". */ + /** An interface for updating data on the ChartPointsCollection object, for use in `chartPointsCollection.set({ ... })`. */ interface ChartPointsCollectionUpdateData { items?: Excel.Interfaces.ChartPointData[]; } - /** An interface for updating data on the ChartPoint object, for use in "chartPoint.set({ ... })". */ + /** An interface for updating data on the ChartPoint object, for use in `chartPoint.set({ ... })`. */ interface ChartPointUpdateData { /** * @@ -42413,7 +42404,7 @@ declare namespace Excel { */ markerStyle?: Excel.ChartMarkerStyle | "Invalid" | "Automatic" | "None" | "Square" | "Diamond" | "Triangle" | "X" | "Star" | "Dot" | "Dash" | "Circle" | "Plus" | "Picture"; } - /** An interface for updating data on the ChartPointFormat object, for use in "chartPointFormat.set({ ... })". */ + /** An interface for updating data on the ChartPointFormat object, for use in `chartPointFormat.set({ ... })`. */ interface ChartPointFormatUpdateData { /** * @@ -42423,7 +42414,7 @@ declare namespace Excel { */ border?: Excel.Interfaces.ChartBorderUpdateData; } - /** An interface for updating data on the ChartAxes object, for use in "chartAxes.set({ ... })". */ + /** An interface for updating data on the ChartAxes object, for use in `chartAxes.set({ ... })`. */ interface ChartAxesUpdateData { /** * @@ -42447,7 +42438,7 @@ declare namespace Excel { */ valueAxis?: Excel.Interfaces.ChartAxisUpdateData; } - /** An interface for updating data on the ChartAxis object, for use in "chartAxis.set({ ... })". */ + /** An interface for updating data on the ChartAxis object, for use in `chartAxis.set({ ... })`. */ interface ChartAxisUpdateData { /** * @@ -42667,7 +42658,7 @@ declare namespace Excel { */ visible?: boolean; } - /** An interface for updating data on the ChartAxisFormat object, for use in "chartAxisFormat.set({ ... })". */ + /** An interface for updating data on the ChartAxisFormat object, for use in `chartAxisFormat.set({ ... })`. */ interface ChartAxisFormatUpdateData { /** * @@ -42684,7 +42675,7 @@ declare namespace Excel { */ line?: Excel.Interfaces.ChartLineFormatUpdateData; } - /** An interface for updating data on the ChartAxisTitle object, for use in "chartAxisTitle.set({ ... })". */ + /** An interface for updating data on the ChartAxisTitle object, for use in `chartAxisTitle.set({ ... })`. */ interface ChartAxisTitleUpdateData { /** * @@ -42708,7 +42699,7 @@ declare namespace Excel { */ visible?: boolean; } - /** An interface for updating data on the ChartAxisTitleFormat object, for use in "chartAxisTitleFormat.set({ ... })". */ + /** An interface for updating data on the ChartAxisTitleFormat object, for use in `chartAxisTitleFormat.set({ ... })`. */ interface ChartAxisTitleFormatUpdateData { /** * @@ -42725,7 +42716,7 @@ declare namespace Excel { */ font?: Excel.Interfaces.ChartFontUpdateData; } - /** An interface for updating data on the ChartDataLabels object, for use in "chartDataLabels.set({ ... })". */ + /** An interface for updating data on the ChartDataLabels object, for use in `chartDataLabels.set({ ... })`. */ interface ChartDataLabelsUpdateData { /** * @@ -42835,7 +42826,7 @@ declare namespace Excel { */ verticalAlignment?: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"; } - /** An interface for updating data on the ChartDataLabel object, for use in "chartDataLabel.set({ ... })". */ + /** An interface for updating data on the ChartDataLabel object, for use in `chartDataLabel.set({ ... })`. */ interface ChartDataLabelUpdateData { /** * @@ -42973,7 +42964,7 @@ declare namespace Excel { */ verticalAlignment?: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"; } - /** An interface for updating data on the ChartDataLabelFormat object, for use in "chartDataLabelFormat.set({ ... })". */ + /** An interface for updating data on the ChartDataLabelFormat object, for use in `chartDataLabelFormat.set({ ... })`. */ interface ChartDataLabelFormatUpdateData { /** * @@ -42990,7 +42981,7 @@ declare namespace Excel { */ font?: Excel.Interfaces.ChartFontUpdateData; } - /** An interface for updating data on the ChartErrorBars object, for use in "chartErrorBars.set({ ... })". */ + /** An interface for updating data on the ChartErrorBars object, for use in `chartErrorBars.set({ ... })`. */ interface ChartErrorBarsUpdateData { /** * @@ -43028,7 +43019,7 @@ declare namespace Excel { */ visible?: boolean; } - /** An interface for updating data on the ChartErrorBarsFormat object, for use in "chartErrorBarsFormat.set({ ... })". */ + /** An interface for updating data on the ChartErrorBarsFormat object, for use in `chartErrorBarsFormat.set({ ... })`. */ interface ChartErrorBarsFormatUpdateData { /** * @@ -43038,7 +43029,7 @@ declare namespace Excel { */ line?: Excel.Interfaces.ChartLineFormatUpdateData; } - /** An interface for updating data on the ChartGridlines object, for use in "chartGridlines.set({ ... })". */ + /** An interface for updating data on the ChartGridlines object, for use in `chartGridlines.set({ ... })`. */ interface ChartGridlinesUpdateData { /** * @@ -43055,7 +43046,7 @@ declare namespace Excel { */ visible?: boolean; } - /** An interface for updating data on the ChartGridlinesFormat object, for use in "chartGridlinesFormat.set({ ... })". */ + /** An interface for updating data on the ChartGridlinesFormat object, for use in `chartGridlinesFormat.set({ ... })`. */ interface ChartGridlinesFormatUpdateData { /** * @@ -43065,7 +43056,7 @@ declare namespace Excel { */ line?: Excel.Interfaces.ChartLineFormatUpdateData; } - /** An interface for updating data on the ChartLegend object, for use in "chartLegend.set({ ... })". */ + /** An interface for updating data on the ChartLegend object, for use in `chartLegend.set({ ... })`. */ interface ChartLegendUpdateData { /** * @@ -43131,7 +43122,7 @@ declare namespace Excel { */ width?: number; } - /** An interface for updating data on the ChartLegendEntry object, for use in "chartLegendEntry.set({ ... })". */ + /** An interface for updating data on the ChartLegendEntry object, for use in `chartLegendEntry.set({ ... })`. */ interface ChartLegendEntryUpdateData { /** * @@ -43141,11 +43132,11 @@ declare namespace Excel { */ visible?: boolean; } - /** An interface for updating data on the ChartLegendEntryCollection object, for use in "chartLegendEntryCollection.set({ ... })". */ + /** An interface for updating data on the ChartLegendEntryCollection object, for use in `chartLegendEntryCollection.set({ ... })`. */ interface ChartLegendEntryCollectionUpdateData { items?: Excel.Interfaces.ChartLegendEntryData[]; } - /** An interface for updating data on the ChartLegendFormat object, for use in "chartLegendFormat.set({ ... })". */ + /** An interface for updating data on the ChartLegendFormat object, for use in `chartLegendFormat.set({ ... })`. */ interface ChartLegendFormatUpdateData { /** * @@ -43162,7 +43153,7 @@ declare namespace Excel { */ font?: Excel.Interfaces.ChartFontUpdateData; } - /** An interface for updating data on the ChartMapOptions object, for use in "chartMapOptions.set({ ... })". */ + /** An interface for updating data on the ChartMapOptions object, for use in `chartMapOptions.set({ ... })`. */ interface ChartMapOptionsUpdateData { /** * @@ -43186,7 +43177,7 @@ declare namespace Excel { */ projectionType?: Excel.ChartMapProjectionType | "Automatic" | "Mercator" | "Miller" | "Robinson" | "Albers"; } - /** An interface for updating data on the ChartTitle object, for use in "chartTitle.set({ ... })". */ + /** An interface for updating data on the ChartTitle object, for use in `chartTitle.set({ ... })`. */ interface ChartTitleUpdateData { /** * @@ -43266,7 +43257,7 @@ declare namespace Excel { */ visible?: boolean; } - /** An interface for updating data on the ChartFormatString object, for use in "chartFormatString.set({ ... })". */ + /** An interface for updating data on the ChartFormatString object, for use in `chartFormatString.set({ ... })`. */ interface ChartFormatStringUpdateData { /** * @@ -43276,7 +43267,7 @@ declare namespace Excel { */ font?: Excel.Interfaces.ChartFontUpdateData; } - /** An interface for updating data on the ChartTitleFormat object, for use in "chartTitleFormat.set({ ... })". */ + /** An interface for updating data on the ChartTitleFormat object, for use in `chartTitleFormat.set({ ... })`. */ interface ChartTitleFormatUpdateData { /** * @@ -43293,7 +43284,7 @@ declare namespace Excel { */ font?: Excel.Interfaces.ChartFontUpdateData; } - /** An interface for updating data on the ChartBorder object, for use in "chartBorder.set({ ... })". */ + /** An interface for updating data on the ChartBorder object, for use in `chartBorder.set({ ... })`. */ interface ChartBorderUpdateData { /** * @@ -43317,7 +43308,7 @@ declare namespace Excel { */ weight?: number; } - /** An interface for updating data on the ChartBinOptions object, for use in "chartBinOptions.set({ ... })". */ + /** An interface for updating data on the ChartBinOptions object, for use in `chartBinOptions.set({ ... })`. */ interface ChartBinOptionsUpdateData { /** * @@ -43369,7 +43360,7 @@ declare namespace Excel { */ width?: number; } - /** An interface for updating data on the ChartBoxwhiskerOptions object, for use in "chartBoxwhiskerOptions.set({ ... })". */ + /** An interface for updating data on the ChartBoxwhiskerOptions object, for use in `chartBoxwhiskerOptions.set({ ... })`. */ interface ChartBoxwhiskerOptionsUpdateData { /** * @@ -43407,7 +43398,7 @@ declare namespace Excel { */ showOutlierPoints?: boolean; } - /** An interface for updating data on the ChartLineFormat object, for use in "chartLineFormat.set({ ... })". */ + /** An interface for updating data on the ChartLineFormat object, for use in `chartLineFormat.set({ ... })`. */ interface ChartLineFormatUpdateData { /** * @@ -43431,7 +43422,7 @@ declare namespace Excel { */ weight?: number; } - /** An interface for updating data on the ChartFont object, for use in "chartFont.set({ ... })". */ + /** An interface for updating data on the ChartFont object, for use in `chartFont.set({ ... })`. */ interface ChartFontUpdateData { /** * @@ -43476,7 +43467,7 @@ declare namespace Excel { */ underline?: Excel.ChartUnderlineStyle | "None" | "Single"; } - /** An interface for updating data on the ChartTrendline object, for use in "chartTrendline.set({ ... })". */ + /** An interface for updating data on the ChartTrendline object, for use in `chartTrendline.set({ ... })`. */ interface ChartTrendlineUpdateData { /** * @@ -43556,11 +43547,11 @@ declare namespace Excel { */ type?: Excel.ChartTrendlineType | "Linear" | "Exponential" | "Logarithmic" | "MovingAverage" | "Polynomial" | "Power"; } - /** An interface for updating data on the ChartTrendlineCollection object, for use in "chartTrendlineCollection.set({ ... })". */ + /** An interface for updating data on the ChartTrendlineCollection object, for use in `chartTrendlineCollection.set({ ... })`. */ interface ChartTrendlineCollectionUpdateData { items?: Excel.Interfaces.ChartTrendlineData[]; } - /** An interface for updating data on the ChartTrendlineFormat object, for use in "chartTrendlineFormat.set({ ... })". */ + /** An interface for updating data on the ChartTrendlineFormat object, for use in `chartTrendlineFormat.set({ ... })`. */ interface ChartTrendlineFormatUpdateData { /** * @@ -43570,7 +43561,7 @@ declare namespace Excel { */ line?: Excel.Interfaces.ChartLineFormatUpdateData; } - /** An interface for updating data on the ChartTrendlineLabel object, for use in "chartTrendlineLabel.set({ ... })". */ + /** An interface for updating data on the ChartTrendlineLabel object, for use in `chartTrendlineLabel.set({ ... })`. */ interface ChartTrendlineLabelUpdateData { /** * @@ -43652,7 +43643,7 @@ declare namespace Excel { */ verticalAlignment?: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"; } - /** An interface for updating data on the ChartTrendlineLabelFormat object, for use in "chartTrendlineLabelFormat.set({ ... })". */ + /** An interface for updating data on the ChartTrendlineLabelFormat object, for use in `chartTrendlineLabelFormat.set({ ... })`. */ interface ChartTrendlineLabelFormatUpdateData { /** * @@ -43669,7 +43660,7 @@ declare namespace Excel { */ font?: Excel.Interfaces.ChartFontUpdateData; } - /** An interface for updating data on the ChartPlotArea object, for use in "chartPlotArea.set({ ... })". */ + /** An interface for updating data on the ChartPlotArea object, for use in `chartPlotArea.set({ ... })`. */ interface ChartPlotAreaUpdateData { /** * @@ -43742,7 +43733,7 @@ declare namespace Excel { */ width?: number; } - /** An interface for updating data on the ChartPlotAreaFormat object, for use in "chartPlotAreaFormat.set({ ... })". */ + /** An interface for updating data on the ChartPlotAreaFormat object, for use in `chartPlotAreaFormat.set({ ... })`. */ interface ChartPlotAreaFormatUpdateData { /** * @@ -43752,19 +43743,19 @@ declare namespace Excel { */ border?: Excel.Interfaces.ChartBorderUpdateData; } - /** An interface for updating data on the CustomXmlPartScopedCollection object, for use in "customXmlPartScopedCollection.set({ ... })". */ + /** An interface for updating data on the CustomXmlPartScopedCollection object, for use in `customXmlPartScopedCollection.set({ ... })`. */ interface CustomXmlPartScopedCollectionUpdateData { items?: Excel.Interfaces.CustomXmlPartData[]; } - /** An interface for updating data on the CustomXmlPartCollection object, for use in "customXmlPartCollection.set({ ... })". */ + /** An interface for updating data on the CustomXmlPartCollection object, for use in `customXmlPartCollection.set({ ... })`. */ interface CustomXmlPartCollectionUpdateData { items?: Excel.Interfaces.CustomXmlPartData[]; } - /** An interface for updating data on the PivotTableCollection object, for use in "pivotTableCollection.set({ ... })". */ + /** An interface for updating data on the PivotTableCollection object, for use in `pivotTableCollection.set({ ... })`. */ interface PivotTableCollectionUpdateData { items?: Excel.Interfaces.PivotTableData[]; } - /** An interface for updating data on the PivotTable object, for use in "pivotTable.set({ ... })". */ + /** An interface for updating data on the PivotTable object, for use in `pivotTable.set({ ... })`. */ interface PivotTableUpdateData { /** * @@ -43788,7 +43779,7 @@ declare namespace Excel { */ useCustomSortLists?: boolean; } - /** An interface for updating data on the PivotLayout object, for use in "pivotLayout.set({ ... })". */ + /** An interface for updating data on the PivotLayout object, for use in `pivotLayout.set({ ... })`. */ interface PivotLayoutUpdateData { /** * @@ -43833,11 +43824,11 @@ declare namespace Excel { */ subtotalLocation?: Excel.SubtotalLocationType | "AtTop" | "AtBottom" | "Off"; } - /** An interface for updating data on the PivotHierarchyCollection object, for use in "pivotHierarchyCollection.set({ ... })". */ + /** An interface for updating data on the PivotHierarchyCollection object, for use in `pivotHierarchyCollection.set({ ... })`. */ interface PivotHierarchyCollectionUpdateData { items?: Excel.Interfaces.PivotHierarchyData[]; } - /** An interface for updating data on the PivotHierarchy object, for use in "pivotHierarchy.set({ ... })". */ + /** An interface for updating data on the PivotHierarchy object, for use in `pivotHierarchy.set({ ... })`. */ interface PivotHierarchyUpdateData { /** * @@ -43847,11 +43838,11 @@ declare namespace Excel { */ name?: string; } - /** An interface for updating data on the RowColumnPivotHierarchyCollection object, for use in "rowColumnPivotHierarchyCollection.set({ ... })". */ + /** An interface for updating data on the RowColumnPivotHierarchyCollection object, for use in `rowColumnPivotHierarchyCollection.set({ ... })`. */ interface RowColumnPivotHierarchyCollectionUpdateData { items?: Excel.Interfaces.RowColumnPivotHierarchyData[]; } - /** An interface for updating data on the RowColumnPivotHierarchy object, for use in "rowColumnPivotHierarchy.set({ ... })". */ + /** An interface for updating data on the RowColumnPivotHierarchy object, for use in `rowColumnPivotHierarchy.set({ ... })`. */ interface RowColumnPivotHierarchyUpdateData { /** * @@ -43868,11 +43859,11 @@ declare namespace Excel { */ position?: number; } - /** An interface for updating data on the FilterPivotHierarchyCollection object, for use in "filterPivotHierarchyCollection.set({ ... })". */ + /** An interface for updating data on the FilterPivotHierarchyCollection object, for use in `filterPivotHierarchyCollection.set({ ... })`. */ interface FilterPivotHierarchyCollectionUpdateData { items?: Excel.Interfaces.FilterPivotHierarchyData[]; } - /** An interface for updating data on the FilterPivotHierarchy object, for use in "filterPivotHierarchy.set({ ... })". */ + /** An interface for updating data on the FilterPivotHierarchy object, for use in `filterPivotHierarchy.set({ ... })`. */ interface FilterPivotHierarchyUpdateData { /** * @@ -43896,11 +43887,11 @@ declare namespace Excel { */ position?: number; } - /** An interface for updating data on the DataPivotHierarchyCollection object, for use in "dataPivotHierarchyCollection.set({ ... })". */ + /** An interface for updating data on the DataPivotHierarchyCollection object, for use in `dataPivotHierarchyCollection.set({ ... })`. */ interface DataPivotHierarchyCollectionUpdateData { items?: Excel.Interfaces.DataPivotHierarchyData[]; } - /** An interface for updating data on the DataPivotHierarchy object, for use in "dataPivotHierarchy.set({ ... })". */ + /** An interface for updating data on the DataPivotHierarchy object, for use in `dataPivotHierarchy.set({ ... })`. */ interface DataPivotHierarchyUpdateData { /** * @@ -43945,11 +43936,11 @@ declare namespace Excel { */ summarizeBy?: Excel.AggregationFunction | "Unknown" | "Automatic" | "Sum" | "Count" | "Average" | "Max" | "Min" | "Product" | "CountNumbers" | "StandardDeviation" | "StandardDeviationP" | "Variance" | "VarianceP"; } - /** An interface for updating data on the PivotFieldCollection object, for use in "pivotFieldCollection.set({ ... })". */ + /** An interface for updating data on the PivotFieldCollection object, for use in `pivotFieldCollection.set({ ... })`. */ interface PivotFieldCollectionUpdateData { items?: Excel.Interfaces.PivotFieldData[]; } - /** An interface for updating data on the PivotField object, for use in "pivotField.set({ ... })". */ + /** An interface for updating data on the PivotField object, for use in `pivotField.set({ ... })`. */ interface PivotFieldUpdateData { /** * @@ -43973,11 +43964,11 @@ declare namespace Excel { */ subtotals?: Excel.Subtotals; } - /** An interface for updating data on the PivotItemCollection object, for use in "pivotItemCollection.set({ ... })". */ + /** An interface for updating data on the PivotItemCollection object, for use in `pivotItemCollection.set({ ... })`. */ interface PivotItemCollectionUpdateData { items?: Excel.Interfaces.PivotItemData[]; } - /** An interface for updating data on the PivotItem object, for use in "pivotItem.set({ ... })". */ + /** An interface for updating data on the PivotItem object, for use in `pivotItem.set({ ... })`. */ interface PivotItemUpdateData { /** * @@ -44001,7 +43992,7 @@ declare namespace Excel { */ visible?: boolean; } - /** An interface for updating data on the DocumentProperties object, for use in "documentProperties.set({ ... })". */ + /** An interface for updating data on the DocumentProperties object, for use in `documentProperties.set({ ... })`. */ interface DocumentPropertiesUpdateData { /** * @@ -44067,7 +44058,7 @@ declare namespace Excel { */ title?: string; } - /** An interface for updating data on the CustomProperty object, for use in "customProperty.set({ ... })". */ + /** An interface for updating data on the CustomProperty object, for use in `customProperty.set({ ... })`. */ interface CustomPropertyUpdateData { /** * @@ -44077,15 +44068,15 @@ declare namespace Excel { */ value?: any; } - /** An interface for updating data on the CustomPropertyCollection object, for use in "customPropertyCollection.set({ ... })". */ + /** An interface for updating data on the CustomPropertyCollection object, for use in `customPropertyCollection.set({ ... })`. */ interface CustomPropertyCollectionUpdateData { items?: Excel.Interfaces.CustomPropertyData[]; } - /** An interface for updating data on the ConditionalFormatCollection object, for use in "conditionalFormatCollection.set({ ... })". */ + /** An interface for updating data on the ConditionalFormatCollection object, for use in `conditionalFormatCollection.set({ ... })`. */ interface ConditionalFormatCollectionUpdateData { items?: Excel.Interfaces.ConditionalFormatData[]; } - /** An interface for updating data on the ConditionalFormat object, for use in "conditionalFormat.set({ ... })". */ + /** An interface for updating data on the ConditionalFormat object, for use in `conditionalFormat.set({ ... })`. */ interface ConditionalFormatUpdateData { /** * @@ -44225,7 +44216,7 @@ declare namespace Excel { */ stopIfTrue?: boolean; } - /** An interface for updating data on the DataBarConditionalFormat object, for use in "dataBarConditionalFormat.set({ ... })". */ + /** An interface for updating data on the DataBarConditionalFormat object, for use in `dataBarConditionalFormat.set({ ... })`. */ interface DataBarConditionalFormatUpdateData { /** * @@ -44287,7 +44278,7 @@ declare namespace Excel { */ upperBoundRule?: Excel.ConditionalDataBarRule; } - /** An interface for updating data on the ConditionalDataBarPositiveFormat object, for use in "conditionalDataBarPositiveFormat.set({ ... })". */ + /** An interface for updating data on the ConditionalDataBarPositiveFormat object, for use in `conditionalDataBarPositiveFormat.set({ ... })`. */ interface ConditionalDataBarPositiveFormatUpdateData { /** * @@ -44312,7 +44303,7 @@ declare namespace Excel { */ gradientFill?: boolean; } - /** An interface for updating data on the ConditionalDataBarNegativeFormat object, for use in "conditionalDataBarNegativeFormat.set({ ... })". */ + /** An interface for updating data on the ConditionalDataBarNegativeFormat object, for use in `conditionalDataBarNegativeFormat.set({ ... })`. */ interface ConditionalDataBarNegativeFormatUpdateData { /** * @@ -44344,7 +44335,7 @@ declare namespace Excel { */ matchPositiveFillColor?: boolean; } - /** An interface for updating data on the CustomConditionalFormat object, for use in "customConditionalFormat.set({ ... })". */ + /** An interface for updating data on the CustomConditionalFormat object, for use in `customConditionalFormat.set({ ... })`. */ interface CustomConditionalFormatUpdateData { /** * @@ -44361,7 +44352,7 @@ declare namespace Excel { */ rule?: Excel.Interfaces.ConditionalFormatRuleUpdateData; } - /** An interface for updating data on the ConditionalFormatRule object, for use in "conditionalFormatRule.set({ ... })". */ + /** An interface for updating data on the ConditionalFormatRule object, for use in `conditionalFormatRule.set({ ... })`. */ interface ConditionalFormatRuleUpdateData { /** * @@ -44385,7 +44376,7 @@ declare namespace Excel { */ formulaR1C1?: string; } - /** An interface for updating data on the IconSetConditionalFormat object, for use in "iconSetConditionalFormat.set({ ... })". */ + /** An interface for updating data on the IconSetConditionalFormat object, for use in `iconSetConditionalFormat.set({ ... })`. */ interface IconSetConditionalFormatUpdateData { /** * @@ -44416,7 +44407,7 @@ declare namespace Excel { */ style?: Excel.IconSet | "Invalid" | "ThreeArrows" | "ThreeArrowsGray" | "ThreeFlags" | "ThreeTrafficLights1" | "ThreeTrafficLights2" | "ThreeSigns" | "ThreeSymbols" | "ThreeSymbols2" | "FourArrows" | "FourArrowsGray" | "FourRedToBlack" | "FourRating" | "FourTrafficLights" | "FiveArrows" | "FiveArrowsGray" | "FiveRating" | "FiveQuarters" | "ThreeStars" | "ThreeTriangles" | "FiveBoxes" | "LinkedEntityFinanceIcon" | "LinkedEntityMapIcon"; } - /** An interface for updating data on the ColorScaleConditionalFormat object, for use in "colorScaleConditionalFormat.set({ ... })". */ + /** An interface for updating data on the ColorScaleConditionalFormat object, for use in `colorScaleConditionalFormat.set({ ... })`. */ interface ColorScaleConditionalFormatUpdateData { /** * @@ -44426,7 +44417,7 @@ declare namespace Excel { */ criteria?: Excel.ConditionalColorScaleCriteria; } - /** An interface for updating data on the TopBottomConditionalFormat object, for use in "topBottomConditionalFormat.set({ ... })". */ + /** An interface for updating data on the TopBottomConditionalFormat object, for use in `topBottomConditionalFormat.set({ ... })`. */ interface TopBottomConditionalFormatUpdateData { /** * @@ -44443,7 +44434,7 @@ declare namespace Excel { */ rule?: Excel.ConditionalTopBottomRule; } - /** An interface for updating data on the PresetCriteriaConditionalFormat object, for use in "presetCriteriaConditionalFormat.set({ ... })". */ + /** An interface for updating data on the PresetCriteriaConditionalFormat object, for use in `presetCriteriaConditionalFormat.set({ ... })`. */ interface PresetCriteriaConditionalFormatUpdateData { /** * @@ -44460,7 +44451,7 @@ declare namespace Excel { */ rule?: Excel.ConditionalPresetCriteriaRule; } - /** An interface for updating data on the TextConditionalFormat object, for use in "textConditionalFormat.set({ ... })". */ + /** An interface for updating data on the TextConditionalFormat object, for use in `textConditionalFormat.set({ ... })`. */ interface TextConditionalFormatUpdateData { /** * @@ -44477,7 +44468,7 @@ declare namespace Excel { */ rule?: Excel.ConditionalTextComparisonRule; } - /** An interface for updating data on the CellValueConditionalFormat object, for use in "cellValueConditionalFormat.set({ ... })". */ + /** An interface for updating data on the CellValueConditionalFormat object, for use in `cellValueConditionalFormat.set({ ... })`. */ interface CellValueConditionalFormatUpdateData { /** * @@ -44494,7 +44485,7 @@ declare namespace Excel { */ rule?: Excel.ConditionalCellValueRule; } - /** An interface for updating data on the ConditionalRangeFormat object, for use in "conditionalRangeFormat.set({ ... })". */ + /** An interface for updating data on the ConditionalRangeFormat object, for use in `conditionalRangeFormat.set({ ... })`. */ interface ConditionalRangeFormatUpdateData { /** * @@ -44525,7 +44516,7 @@ declare namespace Excel { */ numberFormat?: any; } - /** An interface for updating data on the ConditionalRangeFont object, for use in "conditionalRangeFont.set({ ... })". */ + /** An interface for updating data on the ConditionalRangeFont object, for use in `conditionalRangeFont.set({ ... })`. */ interface ConditionalRangeFontUpdateData { /** * @@ -44563,7 +44554,7 @@ declare namespace Excel { */ underline?: Excel.ConditionalRangeFontUnderlineStyle | "None" | "Single" | "Double"; } - /** An interface for updating data on the ConditionalRangeFill object, for use in "conditionalRangeFill.set({ ... })". */ + /** An interface for updating data on the ConditionalRangeFill object, for use in `conditionalRangeFill.set({ ... })`. */ interface ConditionalRangeFillUpdateData { /** * @@ -44573,7 +44564,7 @@ declare namespace Excel { */ color?: string; } - /** An interface for updating data on the ConditionalRangeBorder object, for use in "conditionalRangeBorder.set({ ... })". */ + /** An interface for updating data on the ConditionalRangeBorder object, for use in `conditionalRangeBorder.set({ ... })`. */ interface ConditionalRangeBorderUpdateData { /** * @@ -44590,7 +44581,7 @@ declare namespace Excel { */ style?: Excel.ConditionalRangeBorderLineStyle | "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot"; } - /** An interface for updating data on the ConditionalRangeBorderCollection object, for use in "conditionalRangeBorderCollection.set({ ... })". */ + /** An interface for updating data on the ConditionalRangeBorderCollection object, for use in `conditionalRangeBorderCollection.set({ ... })`. */ interface ConditionalRangeBorderCollectionUpdateData { /** * @@ -44622,7 +44613,7 @@ declare namespace Excel { top?: Excel.Interfaces.ConditionalRangeBorderUpdateData; items?: Excel.Interfaces.ConditionalRangeBorderData[]; } - /** An interface for updating data on the Style object, for use in "style.set({ ... })". */ + /** An interface for updating data on the Style object, for use in `style.set({ ... })`. */ interface StyleUpdateData { /** * @@ -44772,11 +44763,11 @@ declare namespace Excel { */ wrapText?: boolean; } - /** An interface for updating data on the StyleCollection object, for use in "styleCollection.set({ ... })". */ + /** An interface for updating data on the StyleCollection object, for use in `styleCollection.set({ ... })`. */ interface StyleCollectionUpdateData { items?: Excel.Interfaces.StyleData[]; } - /** An interface for updating data on the PageLayout object, for use in "pageLayout.set({ ... })". */ + /** An interface for updating data on the PageLayout object, for use in `pageLayout.set({ ... })`. */ interface PageLayoutUpdateData { /** * @@ -44920,7 +44911,7 @@ declare namespace Excel { */ zoom?: Excel.PageLayoutZoomOptions; } - /** An interface for updating data on the HeaderFooter object, for use in "headerFooter.set({ ... })". */ + /** An interface for updating data on the HeaderFooter object, for use in `headerFooter.set({ ... })`. */ interface HeaderFooterUpdateData { /** * @@ -44971,7 +44962,7 @@ declare namespace Excel { */ rightHeader?: string; } - /** An interface for updating data on the HeaderFooterGroup object, for use in "headerFooterGroup.set({ ... })". */ + /** An interface for updating data on the HeaderFooterGroup object, for use in `headerFooterGroup.set({ ... })`. */ interface HeaderFooterGroupUpdateData { /** * @@ -45023,19 +45014,19 @@ declare namespace Excel { */ useSheetScale?: boolean; } - /** An interface for updating data on the PageBreakCollection object, for use in "pageBreakCollection.set({ ... })". */ + /** An interface for updating data on the PageBreakCollection object, for use in `pageBreakCollection.set({ ... })`. */ interface PageBreakCollectionUpdateData { items?: Excel.Interfaces.PageBreakData[]; } - /** An interface for updating data on the RangeCollection object, for use in "rangeCollection.set({ ... })". */ + /** An interface for updating data on the RangeCollection object, for use in `rangeCollection.set({ ... })`. */ interface RangeCollectionUpdateData { items?: Excel.Interfaces.RangeData[]; } - /** An interface for updating data on the ShapeCollection object, for use in "shapeCollection.set({ ... })". */ + /** An interface for updating data on the ShapeCollection object, for use in `shapeCollection.set({ ... })`. */ interface ShapeCollectionUpdateData { items?: Excel.Interfaces.ShapeData[]; } - /** An interface for updating data on the Shape object, for use in "shape.set({ ... })". */ + /** An interface for updating data on the Shape object, for use in `shape.set({ ... })`. */ interface ShapeUpdateData { /** * @@ -45133,11 +45124,11 @@ declare namespace Excel { */ width?: number; } - /** An interface for updating data on the GroupShapeCollection object, for use in "groupShapeCollection.set({ ... })". */ + /** An interface for updating data on the GroupShapeCollection object, for use in `groupShapeCollection.set({ ... })`. */ interface GroupShapeCollectionUpdateData { items?: Excel.Interfaces.ShapeData[]; } - /** An interface for updating data on the Line object, for use in "line.set({ ... })". */ + /** An interface for updating data on the Line object, for use in `line.set({ ... })`. */ interface LineUpdateData { /** * @@ -45189,7 +45180,7 @@ declare namespace Excel { */ connectorType?: Excel.ConnectorType | "Straight" | "Elbow" | "Curve"; } - /** An interface for updating data on the ShapeFill object, for use in "shapeFill.set({ ... })". */ + /** An interface for updating data on the ShapeFill object, for use in `shapeFill.set({ ... })`. */ interface ShapeFillUpdateData { /** * @@ -45206,7 +45197,7 @@ declare namespace Excel { */ transparency?: number; } - /** An interface for updating data on the ShapeLineFormat object, for use in "shapeLineFormat.set({ ... })". */ + /** An interface for updating data on the ShapeLineFormat object, for use in `shapeLineFormat.set({ ... })`. */ interface ShapeLineFormatUpdateData { /** * @@ -45251,7 +45242,7 @@ declare namespace Excel { */ weight?: number; } - /** An interface for updating data on the TextFrame object, for use in "textFrame.set({ ... })". */ + /** An interface for updating data on the TextFrame object, for use in `textFrame.set({ ... })`. */ interface TextFrameUpdateData { /** * @@ -45331,7 +45322,7 @@ declare namespace Excel { */ verticalOverflow?: Excel.ShapeTextVerticalOverflow | "Overflow" | "Ellipsis" | "Clip"; } - /** An interface for updating data on the TextRange object, for use in "textRange.set({ ... })". */ + /** An interface for updating data on the TextRange object, for use in `textRange.set({ ... })`. */ interface TextRangeUpdateData { /** * @@ -45348,7 +45339,7 @@ declare namespace Excel { */ text?: string; } - /** An interface for updating data on the ShapeFont object, for use in "shapeFont.set({ ... })". */ + /** An interface for updating data on the ShapeFont object, for use in `shapeFont.set({ ... })`. */ interface ShapeFontUpdateData { /** * @@ -45393,7 +45384,7 @@ declare namespace Excel { */ underline?: Excel.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble"; } - /** An interface describing the data returned by calling "runtime.toJSON()". */ + /** An interface describing the data returned by calling `runtime.toJSON()`. */ interface RuntimeData { /** * @@ -45403,7 +45394,7 @@ declare namespace Excel { */ enableEvents?: boolean; } - /** An interface describing the data returned by calling "application.toJSON()". */ + /** An interface describing the data returned by calling `application.toJSON()`. */ interface ApplicationData { /** * @@ -45436,7 +45427,7 @@ declare namespace Excel { */ calculationState?: Excel.CalculationState | "Done" | "Calculating" | "Pending"; } - /** An interface describing the data returned by calling "iterativeCalculation.toJSON()". */ + /** An interface describing the data returned by calling `iterativeCalculation.toJSON()`. */ interface IterativeCalculationData { /** * @@ -45460,7 +45451,7 @@ declare namespace Excel { */ maxIteration?: number; } - /** An interface describing the data returned by calling "workbook.toJSON()". */ + /** An interface describing the data returned by calling `workbook.toJSON()`. */ interface WorkbookData { /** * @@ -45592,7 +45583,7 @@ declare namespace Excel { */ usePrecisionAsDisplayed?: boolean; } - /** An interface describing the data returned by calling "workbookProtection.toJSON()". */ + /** An interface describing the data returned by calling `workbookProtection.toJSON()`. */ interface WorkbookProtectionData { /** * @@ -45602,10 +45593,10 @@ declare namespace Excel { */ protected?: boolean; } - /** An interface describing the data returned by calling "workbookCreated.toJSON()". */ + /** An interface describing the data returned by calling `workbookCreated.toJSON()`. */ interface WorkbookCreatedData { } - /** An interface describing the data returned by calling "worksheet.toJSON()". */ + /** An interface describing the data returned by calling `worksheet.toJSON()`. */ interface WorksheetData { /** * @@ -45754,11 +45745,11 @@ declare namespace Excel { */ visibility?: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden"; } - /** An interface describing the data returned by calling "worksheetCollection.toJSON()". */ + /** An interface describing the data returned by calling `worksheetCollection.toJSON()`. */ interface WorksheetCollectionData { items?: Excel.Interfaces.WorksheetData[]; } - /** An interface describing the data returned by calling "worksheetProtection.toJSON()". */ + /** An interface describing the data returned by calling `worksheetProtection.toJSON()`. */ interface WorksheetProtectionData { /** * @@ -45775,7 +45766,7 @@ declare namespace Excel { */ protected?: boolean; } - /** An interface describing the data returned by calling "range.toJSON()". */ + /** An interface describing the data returned by calling `range.toJSON()`. */ interface RangeData { /** * @@ -45971,7 +45962,7 @@ declare namespace Excel { */ values?: any[][]; } - /** An interface describing the data returned by calling "rangeAreas.toJSON()". */ + /** An interface describing the data returned by calling `rangeAreas.toJSON()`. */ interface RangeAreasData { /** * @@ -46053,7 +46044,7 @@ declare namespace Excel { */ style?: string; } - /** An interface describing the data returned by calling "rangeView.toJSON()". */ + /** An interface describing the data returned by calling `rangeView.toJSON()`. */ interface RangeViewData { /** * @@ -46140,15 +46131,15 @@ declare namespace Excel { */ values?: any[][]; } - /** An interface describing the data returned by calling "rangeViewCollection.toJSON()". */ + /** An interface describing the data returned by calling `rangeViewCollection.toJSON()`. */ interface RangeViewCollectionData { items?: Excel.Interfaces.RangeViewData[]; } - /** An interface describing the data returned by calling "settingCollection.toJSON()". */ + /** An interface describing the data returned by calling `settingCollection.toJSON()`. */ interface SettingCollectionData { items?: Excel.Interfaces.SettingData[]; } - /** An interface describing the data returned by calling "setting.toJSON()". */ + /** An interface describing the data returned by calling `setting.toJSON()`. */ interface SettingData { /** * @@ -46165,11 +46156,11 @@ declare namespace Excel { */ value?: any; } - /** An interface describing the data returned by calling "namedItemCollection.toJSON()". */ + /** An interface describing the data returned by calling `namedItemCollection.toJSON()`. */ interface NamedItemCollectionData { items?: Excel.Interfaces.NamedItemData[]; } - /** An interface describing the data returned by calling "namedItem.toJSON()". */ + /** An interface describing the data returned by calling `namedItem.toJSON()`. */ interface NamedItemData { /** * @@ -46228,7 +46219,7 @@ declare namespace Excel { */ visible?: boolean; } - /** An interface describing the data returned by calling "namedItemArrayValues.toJSON()". */ + /** An interface describing the data returned by calling `namedItemArrayValues.toJSON()`. */ interface NamedItemArrayValuesData { /** * @@ -46245,7 +46236,7 @@ declare namespace Excel { */ values?: any[][]; } - /** An interface describing the data returned by calling "binding.toJSON()". */ + /** An interface describing the data returned by calling `binding.toJSON()`. */ interface BindingData { /** * @@ -46262,19 +46253,19 @@ declare namespace Excel { */ type?: Excel.BindingType | "Range" | "Table" | "Text"; } - /** An interface describing the data returned by calling "bindingCollection.toJSON()". */ + /** An interface describing the data returned by calling `bindingCollection.toJSON()`. */ interface BindingCollectionData { items?: Excel.Interfaces.BindingData[]; } - /** An interface describing the data returned by calling "tableCollection.toJSON()". */ + /** An interface describing the data returned by calling `tableCollection.toJSON()`. */ interface TableCollectionData { items?: Excel.Interfaces.TableData[]; } - /** An interface describing the data returned by calling "tableScopedCollection.toJSON()". */ + /** An interface describing the data returned by calling `tableScopedCollection.toJSON()`. */ interface TableScopedCollectionData { items?: Excel.Interfaces.TableData[]; } - /** An interface describing the data returned by calling "table.toJSON()". */ + /** An interface describing the data returned by calling `table.toJSON()`. */ interface TableData { /** * @@ -46382,11 +46373,11 @@ declare namespace Excel { */ style?: string; } - /** An interface describing the data returned by calling "tableColumnCollection.toJSON()". */ + /** An interface describing the data returned by calling `tableColumnCollection.toJSON()`. */ interface TableColumnCollectionData { items?: Excel.Interfaces.TableColumnData[]; } - /** An interface describing the data returned by calling "tableColumn.toJSON()". */ + /** An interface describing the data returned by calling `tableColumn.toJSON()`. */ interface TableColumnData { /** * @@ -46424,11 +46415,11 @@ declare namespace Excel { */ values?: any[][]; } - /** An interface describing the data returned by calling "tableRowCollection.toJSON()". */ + /** An interface describing the data returned by calling `tableRowCollection.toJSON()`. */ interface TableRowCollectionData { items?: Excel.Interfaces.TableRowData[]; } - /** An interface describing the data returned by calling "tableRow.toJSON()". */ + /** An interface describing the data returned by calling `tableRow.toJSON()`. */ interface TableRowData { /** * @@ -46445,7 +46436,7 @@ declare namespace Excel { */ values?: any[][]; } - /** An interface describing the data returned by calling "dataValidation.toJSON()". */ + /** An interface describing the data returned by calling `dataValidation.toJSON()`. */ interface DataValidationData { /** * @@ -46492,7 +46483,7 @@ declare namespace Excel { */ valid?: boolean; } - /** An interface describing the data returned by calling "removeDuplicatesResult.toJSON()". */ + /** An interface describing the data returned by calling `removeDuplicatesResult.toJSON()`. */ interface RemoveDuplicatesResultData { /** * @@ -46509,7 +46500,7 @@ declare namespace Excel { */ uniqueRemaining?: number; } - /** An interface describing the data returned by calling "rangeFormat.toJSON()". */ + /** An interface describing the data returned by calling `rangeFormat.toJSON()`. */ interface RangeFormatData { /** * @@ -46632,7 +46623,7 @@ declare namespace Excel { */ wrapText?: boolean; } - /** An interface describing the data returned by calling "formatProtection.toJSON()". */ + /** An interface describing the data returned by calling `formatProtection.toJSON()`. */ interface FormatProtectionData { /** * @@ -46649,11 +46640,11 @@ declare namespace Excel { */ locked?: boolean; } - /** An interface describing the data returned by calling "rangeFill.toJSON()". */ + /** An interface describing the data returned by calling `rangeFill.toJSON()`. */ interface RangeFillData { /** * - * HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange") + * HTML color code representing the color of the background, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange") * * [Api set: ExcelApi 1.1] */ @@ -46691,7 +46682,7 @@ declare namespace Excel { */ tintAndShade?: number; } - /** An interface describing the data returned by calling "rangeBorder.toJSON()". */ + /** An interface describing the data returned by calling `rangeBorder.toJSON()`. */ interface RangeBorderData { /** * @@ -46730,11 +46721,11 @@ declare namespace Excel { */ weight?: Excel.BorderWeight | "Hairline" | "Thin" | "Medium" | "Thick"; } - /** An interface describing the data returned by calling "rangeBorderCollection.toJSON()". */ + /** An interface describing the data returned by calling `rangeBorderCollection.toJSON()`. */ interface RangeBorderCollectionData { items?: Excel.Interfaces.RangeBorderData[]; } - /** An interface describing the data returned by calling "rangeFont.toJSON()". */ + /** An interface describing the data returned by calling `rangeFont.toJSON()`. */ interface RangeFontData { /** * @@ -46814,11 +46805,11 @@ declare namespace Excel { */ underline?: Excel.RangeUnderlineStyle | "None" | "Single" | "Double" | "SingleAccountant" | "DoubleAccountant"; } - /** An interface describing the data returned by calling "chartCollection.toJSON()". */ + /** An interface describing the data returned by calling `chartCollection.toJSON()`. */ interface ChartCollectionData { items?: Excel.Interfaces.ChartData[]; } - /** An interface describing the data returned by calling "chart.toJSON()". */ + /** An interface describing the data returned by calling `chart.toJSON()`. */ interface ChartData { /** * @@ -46986,7 +46977,7 @@ declare namespace Excel { */ width?: number; } - /** An interface describing the data returned by calling "chartPivotOptions.toJSON()". */ + /** An interface describing the data returned by calling `chartPivotOptions.toJSON()`. */ interface ChartPivotOptionsData { /** * @@ -47017,7 +47008,7 @@ declare namespace Excel { */ showValueFieldButtons?: boolean; } - /** An interface describing the data returned by calling "chartAreaFormat.toJSON()". */ + /** An interface describing the data returned by calling `chartAreaFormat.toJSON()`. */ interface ChartAreaFormatData { /** * @@ -47048,11 +47039,11 @@ declare namespace Excel { */ roundedCorners?: boolean; } - /** An interface describing the data returned by calling "chartSeriesCollection.toJSON()". */ + /** An interface describing the data returned by calling `chartSeriesCollection.toJSON()`. */ interface ChartSeriesCollectionData { items?: Excel.Interfaces.ChartSeriesData[]; } - /** An interface describing the data returned by calling "chartSeries.toJSON()". */ + /** An interface describing the data returned by calling `chartSeries.toJSON()`. */ interface ChartSeriesData { /** * @@ -47379,7 +47370,7 @@ declare namespace Excel { */ varyByCategories?: boolean; } - /** An interface describing the data returned by calling "chartSeriesFormat.toJSON()". */ + /** An interface describing the data returned by calling `chartSeriesFormat.toJSON()`. */ interface ChartSeriesFormatData { /** * @@ -47389,11 +47380,11 @@ declare namespace Excel { */ line?: Excel.Interfaces.ChartLineFormatData; } - /** An interface describing the data returned by calling "chartPointsCollection.toJSON()". */ + /** An interface describing the data returned by calling `chartPointsCollection.toJSON()`. */ interface ChartPointsCollectionData { items?: Excel.Interfaces.ChartPointData[]; } - /** An interface describing the data returned by calling "chartPoint.toJSON()". */ + /** An interface describing the data returned by calling `chartPoint.toJSON()`. */ interface ChartPointData { /** * @@ -47452,7 +47443,7 @@ declare namespace Excel { */ value?: any; } - /** An interface describing the data returned by calling "chartPointFormat.toJSON()". */ + /** An interface describing the data returned by calling `chartPointFormat.toJSON()`. */ interface ChartPointFormatData { /** * @@ -47462,7 +47453,7 @@ declare namespace Excel { */ border?: Excel.Interfaces.ChartBorderData; } - /** An interface describing the data returned by calling "chartAxes.toJSON()". */ + /** An interface describing the data returned by calling `chartAxes.toJSON()`. */ interface ChartAxesData { /** * @@ -47486,7 +47477,7 @@ declare namespace Excel { */ valueAxis?: Excel.Interfaces.ChartAxisData; } - /** An interface describing the data returned by calling "chartAxis.toJSON()". */ + /** An interface describing the data returned by calling `chartAxis.toJSON()`. */ interface ChartAxisData { /** * @@ -47762,7 +47753,7 @@ declare namespace Excel { */ width?: number; } - /** An interface describing the data returned by calling "chartAxisFormat.toJSON()". */ + /** An interface describing the data returned by calling `chartAxisFormat.toJSON()`. */ interface ChartAxisFormatData { /** * @@ -47779,7 +47770,7 @@ declare namespace Excel { */ line?: Excel.Interfaces.ChartLineFormatData; } - /** An interface describing the data returned by calling "chartAxisTitle.toJSON()". */ + /** An interface describing the data returned by calling `chartAxisTitle.toJSON()`. */ interface ChartAxisTitleData { /** * @@ -47803,7 +47794,7 @@ declare namespace Excel { */ visible?: boolean; } - /** An interface describing the data returned by calling "chartAxisTitleFormat.toJSON()". */ + /** An interface describing the data returned by calling `chartAxisTitleFormat.toJSON()`. */ interface ChartAxisTitleFormatData { /** * @@ -47820,7 +47811,7 @@ declare namespace Excel { */ font?: Excel.Interfaces.ChartFontData; } - /** An interface describing the data returned by calling "chartDataLabels.toJSON()". */ + /** An interface describing the data returned by calling `chartDataLabels.toJSON()`. */ interface ChartDataLabelsData { /** * @@ -47930,7 +47921,7 @@ declare namespace Excel { */ verticalAlignment?: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"; } - /** An interface describing the data returned by calling "chartDataLabel.toJSON()". */ + /** An interface describing the data returned by calling `chartDataLabel.toJSON()`. */ interface ChartDataLabelData { /** * @@ -48082,7 +48073,7 @@ declare namespace Excel { */ width?: number; } - /** An interface describing the data returned by calling "chartDataLabelFormat.toJSON()". */ + /** An interface describing the data returned by calling `chartDataLabelFormat.toJSON()`. */ interface ChartDataLabelFormatData { /** * @@ -48099,7 +48090,7 @@ declare namespace Excel { */ font?: Excel.Interfaces.ChartFontData; } - /** An interface describing the data returned by calling "chartErrorBars.toJSON()". */ + /** An interface describing the data returned by calling `chartErrorBars.toJSON()`. */ interface ChartErrorBarsData { /** * @@ -48137,7 +48128,7 @@ declare namespace Excel { */ visible?: boolean; } - /** An interface describing the data returned by calling "chartErrorBarsFormat.toJSON()". */ + /** An interface describing the data returned by calling `chartErrorBarsFormat.toJSON()`. */ interface ChartErrorBarsFormatData { /** * @@ -48147,7 +48138,7 @@ declare namespace Excel { */ line?: Excel.Interfaces.ChartLineFormatData; } - /** An interface describing the data returned by calling "chartGridlines.toJSON()". */ + /** An interface describing the data returned by calling `chartGridlines.toJSON()`. */ interface ChartGridlinesData { /** * @@ -48164,7 +48155,7 @@ declare namespace Excel { */ visible?: boolean; } - /** An interface describing the data returned by calling "chartGridlinesFormat.toJSON()". */ + /** An interface describing the data returned by calling `chartGridlinesFormat.toJSON()`. */ interface ChartGridlinesFormatData { /** * @@ -48174,7 +48165,7 @@ declare namespace Excel { */ line?: Excel.Interfaces.ChartLineFormatData; } - /** An interface describing the data returned by calling "chartLegend.toJSON()". */ + /** An interface describing the data returned by calling `chartLegend.toJSON()`. */ interface ChartLegendData { /** * @@ -48247,7 +48238,7 @@ declare namespace Excel { */ width?: number; } - /** An interface describing the data returned by calling "chartLegendEntry.toJSON()". */ + /** An interface describing the data returned by calling `chartLegendEntry.toJSON()`. */ interface ChartLegendEntryData { /** * @@ -48292,11 +48283,11 @@ declare namespace Excel { */ width?: number; } - /** An interface describing the data returned by calling "chartLegendEntryCollection.toJSON()". */ + /** An interface describing the data returned by calling `chartLegendEntryCollection.toJSON()`. */ interface ChartLegendEntryCollectionData { items?: Excel.Interfaces.ChartLegendEntryData[]; } - /** An interface describing the data returned by calling "chartLegendFormat.toJSON()". */ + /** An interface describing the data returned by calling `chartLegendFormat.toJSON()`. */ interface ChartLegendFormatData { /** * @@ -48313,7 +48304,7 @@ declare namespace Excel { */ font?: Excel.Interfaces.ChartFontData; } - /** An interface describing the data returned by calling "chartMapOptions.toJSON()". */ + /** An interface describing the data returned by calling `chartMapOptions.toJSON()`. */ interface ChartMapOptionsData { /** * @@ -48337,7 +48328,7 @@ declare namespace Excel { */ projectionType?: Excel.ChartMapProjectionType | "Automatic" | "Mercator" | "Miller" | "Robinson" | "Albers"; } - /** An interface describing the data returned by calling "chartTitle.toJSON()". */ + /** An interface describing the data returned by calling `chartTitle.toJSON()`. */ interface ChartTitleData { /** * @@ -48431,7 +48422,7 @@ declare namespace Excel { */ width?: number; } - /** An interface describing the data returned by calling "chartFormatString.toJSON()". */ + /** An interface describing the data returned by calling `chartFormatString.toJSON()`. */ interface ChartFormatStringData { /** * @@ -48441,7 +48432,7 @@ declare namespace Excel { */ font?: Excel.Interfaces.ChartFontData; } - /** An interface describing the data returned by calling "chartTitleFormat.toJSON()". */ + /** An interface describing the data returned by calling `chartTitleFormat.toJSON()`. */ interface ChartTitleFormatData { /** * @@ -48458,7 +48449,7 @@ declare namespace Excel { */ font?: Excel.Interfaces.ChartFontData; } - /** An interface describing the data returned by calling "chartBorder.toJSON()". */ + /** An interface describing the data returned by calling `chartBorder.toJSON()`. */ interface ChartBorderData { /** * @@ -48482,7 +48473,7 @@ declare namespace Excel { */ weight?: number; } - /** An interface describing the data returned by calling "chartBinOptions.toJSON()". */ + /** An interface describing the data returned by calling `chartBinOptions.toJSON()`. */ interface ChartBinOptionsData { /** * @@ -48534,7 +48525,7 @@ declare namespace Excel { */ width?: number; } - /** An interface describing the data returned by calling "chartBoxwhiskerOptions.toJSON()". */ + /** An interface describing the data returned by calling `chartBoxwhiskerOptions.toJSON()`. */ interface ChartBoxwhiskerOptionsData { /** * @@ -48572,7 +48563,7 @@ declare namespace Excel { */ showOutlierPoints?: boolean; } - /** An interface describing the data returned by calling "chartLineFormat.toJSON()". */ + /** An interface describing the data returned by calling `chartLineFormat.toJSON()`. */ interface ChartLineFormatData { /** * @@ -48596,7 +48587,7 @@ declare namespace Excel { */ weight?: number; } - /** An interface describing the data returned by calling "chartFont.toJSON()". */ + /** An interface describing the data returned by calling `chartFont.toJSON()`. */ interface ChartFontData { /** * @@ -48641,7 +48632,7 @@ declare namespace Excel { */ underline?: Excel.ChartUnderlineStyle | "None" | "Single"; } - /** An interface describing the data returned by calling "chartTrendline.toJSON()". */ + /** An interface describing the data returned by calling `chartTrendline.toJSON()`. */ interface ChartTrendlineData { /** * @@ -48721,11 +48712,11 @@ declare namespace Excel { */ type?: Excel.ChartTrendlineType | "Linear" | "Exponential" | "Logarithmic" | "MovingAverage" | "Polynomial" | "Power"; } - /** An interface describing the data returned by calling "chartTrendlineCollection.toJSON()". */ + /** An interface describing the data returned by calling `chartTrendlineCollection.toJSON()`. */ interface ChartTrendlineCollectionData { items?: Excel.Interfaces.ChartTrendlineData[]; } - /** An interface describing the data returned by calling "chartTrendlineFormat.toJSON()". */ + /** An interface describing the data returned by calling `chartTrendlineFormat.toJSON()`. */ interface ChartTrendlineFormatData { /** * @@ -48735,7 +48726,7 @@ declare namespace Excel { */ line?: Excel.Interfaces.ChartLineFormatData; } - /** An interface describing the data returned by calling "chartTrendlineLabel.toJSON()". */ + /** An interface describing the data returned by calling `chartTrendlineLabel.toJSON()`. */ interface ChartTrendlineLabelData { /** * @@ -48831,7 +48822,7 @@ declare namespace Excel { */ width?: number; } - /** An interface describing the data returned by calling "chartTrendlineLabelFormat.toJSON()". */ + /** An interface describing the data returned by calling `chartTrendlineLabelFormat.toJSON()`. */ interface ChartTrendlineLabelFormatData { /** * @@ -48848,7 +48839,7 @@ declare namespace Excel { */ font?: Excel.Interfaces.ChartFontData; } - /** An interface describing the data returned by calling "chartPlotArea.toJSON()". */ + /** An interface describing the data returned by calling `chartPlotArea.toJSON()`. */ interface ChartPlotAreaData { /** * @@ -48921,7 +48912,7 @@ declare namespace Excel { */ width?: number; } - /** An interface describing the data returned by calling "chartPlotAreaFormat.toJSON()". */ + /** An interface describing the data returned by calling `chartPlotAreaFormat.toJSON()`. */ interface ChartPlotAreaFormatData { /** * @@ -48931,7 +48922,7 @@ declare namespace Excel { */ border?: Excel.Interfaces.ChartBorderData; } - /** An interface describing the data returned by calling "tableSort.toJSON()". */ + /** An interface describing the data returned by calling `tableSort.toJSON()`. */ interface TableSortData { /** * @@ -48955,7 +48946,7 @@ declare namespace Excel { */ method?: Excel.SortMethod | "PinYin" | "StrokeCount"; } - /** An interface describing the data returned by calling "filter.toJSON()". */ + /** An interface describing the data returned by calling `filter.toJSON()`. */ interface FilterData { /** * @@ -48965,7 +48956,7 @@ declare namespace Excel { */ criteria?: Excel.FilterCriteria; } - /** An interface describing the data returned by calling "autoFilter.toJSON()". */ + /** An interface describing the data returned by calling `autoFilter.toJSON()`. */ interface AutoFilterData { /** * @@ -48989,15 +48980,15 @@ declare namespace Excel { */ isDataFiltered?: boolean; } - /** An interface describing the data returned by calling "customXmlPartScopedCollection.toJSON()". */ + /** An interface describing the data returned by calling `customXmlPartScopedCollection.toJSON()`. */ interface CustomXmlPartScopedCollectionData { items?: Excel.Interfaces.CustomXmlPartData[]; } - /** An interface describing the data returned by calling "customXmlPartCollection.toJSON()". */ + /** An interface describing the data returned by calling `customXmlPartCollection.toJSON()`. */ interface CustomXmlPartCollectionData { items?: Excel.Interfaces.CustomXmlPartData[]; } - /** An interface describing the data returned by calling "customXmlPart.toJSON()". */ + /** An interface describing the data returned by calling `customXmlPart.toJSON()`. */ interface CustomXmlPartData { /** * @@ -49014,11 +49005,11 @@ declare namespace Excel { */ namespaceUri?: string; } - /** An interface describing the data returned by calling "pivotTableCollection.toJSON()". */ + /** An interface describing the data returned by calling `pivotTableCollection.toJSON()`. */ interface PivotTableCollectionData { items?: Excel.Interfaces.PivotTableData[]; } - /** An interface describing the data returned by calling "pivotTable.toJSON()". */ + /** An interface describing the data returned by calling `pivotTable.toJSON()`. */ interface PivotTableData { /** * @@ -49084,7 +49075,7 @@ declare namespace Excel { */ useCustomSortLists?: boolean; } - /** An interface describing the data returned by calling "pivotLayout.toJSON()". */ + /** An interface describing the data returned by calling `pivotLayout.toJSON()`. */ interface PivotLayoutData { /** * @@ -49129,11 +49120,11 @@ declare namespace Excel { */ subtotalLocation?: Excel.SubtotalLocationType | "AtTop" | "AtBottom" | "Off"; } - /** An interface describing the data returned by calling "pivotHierarchyCollection.toJSON()". */ + /** An interface describing the data returned by calling `pivotHierarchyCollection.toJSON()`. */ interface PivotHierarchyCollectionData { items?: Excel.Interfaces.PivotHierarchyData[]; } - /** An interface describing the data returned by calling "pivotHierarchy.toJSON()". */ + /** An interface describing the data returned by calling `pivotHierarchy.toJSON()`. */ interface PivotHierarchyData { /** * @@ -49157,11 +49148,11 @@ declare namespace Excel { */ name?: string; } - /** An interface describing the data returned by calling "rowColumnPivotHierarchyCollection.toJSON()". */ + /** An interface describing the data returned by calling `rowColumnPivotHierarchyCollection.toJSON()`. */ interface RowColumnPivotHierarchyCollectionData { items?: Excel.Interfaces.RowColumnPivotHierarchyData[]; } - /** An interface describing the data returned by calling "rowColumnPivotHierarchy.toJSON()". */ + /** An interface describing the data returned by calling `rowColumnPivotHierarchy.toJSON()`. */ interface RowColumnPivotHierarchyData { /** * @@ -49192,11 +49183,11 @@ declare namespace Excel { */ position?: number; } - /** An interface describing the data returned by calling "filterPivotHierarchyCollection.toJSON()". */ + /** An interface describing the data returned by calling `filterPivotHierarchyCollection.toJSON()`. */ interface FilterPivotHierarchyCollectionData { items?: Excel.Interfaces.FilterPivotHierarchyData[]; } - /** An interface describing the data returned by calling "filterPivotHierarchy.toJSON()". */ + /** An interface describing the data returned by calling `filterPivotHierarchy.toJSON()`. */ interface FilterPivotHierarchyData { /** * @@ -49234,11 +49225,11 @@ declare namespace Excel { */ position?: number; } - /** An interface describing the data returned by calling "dataPivotHierarchyCollection.toJSON()". */ + /** An interface describing the data returned by calling `dataPivotHierarchyCollection.toJSON()`. */ interface DataPivotHierarchyCollectionData { items?: Excel.Interfaces.DataPivotHierarchyData[]; } - /** An interface describing the data returned by calling "dataPivotHierarchy.toJSON()". */ + /** An interface describing the data returned by calling `dataPivotHierarchy.toJSON()`. */ interface DataPivotHierarchyData { /** * @@ -49290,11 +49281,11 @@ declare namespace Excel { */ summarizeBy?: Excel.AggregationFunction | "Unknown" | "Automatic" | "Sum" | "Count" | "Average" | "Max" | "Min" | "Product" | "CountNumbers" | "StandardDeviation" | "StandardDeviationP" | "Variance" | "VarianceP"; } - /** An interface describing the data returned by calling "pivotFieldCollection.toJSON()". */ + /** An interface describing the data returned by calling `pivotFieldCollection.toJSON()`. */ interface PivotFieldCollectionData { items?: Excel.Interfaces.PivotFieldData[]; } - /** An interface describing the data returned by calling "pivotField.toJSON()". */ + /** An interface describing the data returned by calling `pivotField.toJSON()`. */ interface PivotFieldData { /** * @@ -49332,11 +49323,11 @@ declare namespace Excel { */ subtotals?: Excel.Subtotals; } - /** An interface describing the data returned by calling "pivotItemCollection.toJSON()". */ + /** An interface describing the data returned by calling `pivotItemCollection.toJSON()`. */ interface PivotItemCollectionData { items?: Excel.Interfaces.PivotItemData[]; } - /** An interface describing the data returned by calling "pivotItem.toJSON()". */ + /** An interface describing the data returned by calling `pivotItem.toJSON()`. */ interface PivotItemData { /** * @@ -49367,7 +49358,7 @@ declare namespace Excel { */ visible?: boolean; } - /** An interface describing the data returned by calling "documentProperties.toJSON()". */ + /** An interface describing the data returned by calling `documentProperties.toJSON()`. */ interface DocumentPropertiesData { /** * @@ -49454,7 +49445,7 @@ declare namespace Excel { */ title?: string; } - /** An interface describing the data returned by calling "customProperty.toJSON()". */ + /** An interface describing the data returned by calling `customProperty.toJSON()`. */ interface CustomPropertyData { /** * @@ -49478,15 +49469,15 @@ declare namespace Excel { */ value?: any; } - /** An interface describing the data returned by calling "customPropertyCollection.toJSON()". */ + /** An interface describing the data returned by calling `customPropertyCollection.toJSON()`. */ interface CustomPropertyCollectionData { items?: Excel.Interfaces.CustomPropertyData[]; } - /** An interface describing the data returned by calling "conditionalFormatCollection.toJSON()". */ + /** An interface describing the data returned by calling `conditionalFormatCollection.toJSON()`. */ interface ConditionalFormatCollectionData { items?: Excel.Interfaces.ConditionalFormatData[]; } - /** An interface describing the data returned by calling "conditionalFormat.toJSON()". */ + /** An interface describing the data returned by calling `conditionalFormat.toJSON()`. */ interface ConditionalFormatData { /** * @@ -49640,7 +49631,7 @@ declare namespace Excel { */ type?: Excel.ConditionalFormatType | "Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" | "ContainsText" | "CellValue"; } - /** An interface describing the data returned by calling "dataBarConditionalFormat.toJSON()". */ + /** An interface describing the data returned by calling `dataBarConditionalFormat.toJSON()`. */ interface DataBarConditionalFormatData { /** * @@ -49702,7 +49693,7 @@ declare namespace Excel { */ upperBoundRule?: Excel.ConditionalDataBarRule; } - /** An interface describing the data returned by calling "conditionalDataBarPositiveFormat.toJSON()". */ + /** An interface describing the data returned by calling `conditionalDataBarPositiveFormat.toJSON()`. */ interface ConditionalDataBarPositiveFormatData { /** * @@ -49727,7 +49718,7 @@ declare namespace Excel { */ gradientFill?: boolean; } - /** An interface describing the data returned by calling "conditionalDataBarNegativeFormat.toJSON()". */ + /** An interface describing the data returned by calling `conditionalDataBarNegativeFormat.toJSON()`. */ interface ConditionalDataBarNegativeFormatData { /** * @@ -49759,7 +49750,7 @@ declare namespace Excel { */ matchPositiveFillColor?: boolean; } - /** An interface describing the data returned by calling "customConditionalFormat.toJSON()". */ + /** An interface describing the data returned by calling `customConditionalFormat.toJSON()`. */ interface CustomConditionalFormatData { /** * @@ -49776,7 +49767,7 @@ declare namespace Excel { */ rule?: Excel.Interfaces.ConditionalFormatRuleData; } - /** An interface describing the data returned by calling "conditionalFormatRule.toJSON()". */ + /** An interface describing the data returned by calling `conditionalFormatRule.toJSON()`. */ interface ConditionalFormatRuleData { /** * @@ -49800,7 +49791,7 @@ declare namespace Excel { */ formulaR1C1?: string; } - /** An interface describing the data returned by calling "iconSetConditionalFormat.toJSON()". */ + /** An interface describing the data returned by calling `iconSetConditionalFormat.toJSON()`. */ interface IconSetConditionalFormatData { /** * @@ -49831,7 +49822,7 @@ declare namespace Excel { */ style?: Excel.IconSet | "Invalid" | "ThreeArrows" | "ThreeArrowsGray" | "ThreeFlags" | "ThreeTrafficLights1" | "ThreeTrafficLights2" | "ThreeSigns" | "ThreeSymbols" | "ThreeSymbols2" | "FourArrows" | "FourArrowsGray" | "FourRedToBlack" | "FourRating" | "FourTrafficLights" | "FiveArrows" | "FiveArrowsGray" | "FiveRating" | "FiveQuarters" | "ThreeStars" | "ThreeTriangles" | "FiveBoxes" | "LinkedEntityFinanceIcon" | "LinkedEntityMapIcon"; } - /** An interface describing the data returned by calling "colorScaleConditionalFormat.toJSON()". */ + /** An interface describing the data returned by calling `colorScaleConditionalFormat.toJSON()`. */ interface ColorScaleConditionalFormatData { /** * @@ -49848,7 +49839,7 @@ declare namespace Excel { */ threeColorScale?: boolean; } - /** An interface describing the data returned by calling "topBottomConditionalFormat.toJSON()". */ + /** An interface describing the data returned by calling `topBottomConditionalFormat.toJSON()`. */ interface TopBottomConditionalFormatData { /** * @@ -49865,7 +49856,7 @@ declare namespace Excel { */ rule?: Excel.ConditionalTopBottomRule; } - /** An interface describing the data returned by calling "presetCriteriaConditionalFormat.toJSON()". */ + /** An interface describing the data returned by calling `presetCriteriaConditionalFormat.toJSON()`. */ interface PresetCriteriaConditionalFormatData { /** * @@ -49882,7 +49873,7 @@ declare namespace Excel { */ rule?: Excel.ConditionalPresetCriteriaRule; } - /** An interface describing the data returned by calling "textConditionalFormat.toJSON()". */ + /** An interface describing the data returned by calling `textConditionalFormat.toJSON()`. */ interface TextConditionalFormatData { /** * @@ -49899,7 +49890,7 @@ declare namespace Excel { */ rule?: Excel.ConditionalTextComparisonRule; } - /** An interface describing the data returned by calling "cellValueConditionalFormat.toJSON()". */ + /** An interface describing the data returned by calling `cellValueConditionalFormat.toJSON()`. */ interface CellValueConditionalFormatData { /** * @@ -49916,7 +49907,7 @@ declare namespace Excel { */ rule?: Excel.ConditionalCellValueRule; } - /** An interface describing the data returned by calling "conditionalRangeFormat.toJSON()". */ + /** An interface describing the data returned by calling `conditionalRangeFormat.toJSON()`. */ interface ConditionalRangeFormatData { /** * @@ -49947,7 +49938,7 @@ declare namespace Excel { */ numberFormat?: any; } - /** An interface describing the data returned by calling "conditionalRangeFont.toJSON()". */ + /** An interface describing the data returned by calling `conditionalRangeFont.toJSON()`. */ interface ConditionalRangeFontData { /** * @@ -49985,7 +49976,7 @@ declare namespace Excel { */ underline?: Excel.ConditionalRangeFontUnderlineStyle | "None" | "Single" | "Double"; } - /** An interface describing the data returned by calling "conditionalRangeFill.toJSON()". */ + /** An interface describing the data returned by calling `conditionalRangeFill.toJSON()`. */ interface ConditionalRangeFillData { /** * @@ -49995,7 +49986,7 @@ declare namespace Excel { */ color?: string; } - /** An interface describing the data returned by calling "conditionalRangeBorder.toJSON()". */ + /** An interface describing the data returned by calling `conditionalRangeBorder.toJSON()`. */ interface ConditionalRangeBorderData { /** * @@ -50019,11 +50010,11 @@ declare namespace Excel { */ style?: Excel.ConditionalRangeBorderLineStyle | "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot"; } - /** An interface describing the data returned by calling "conditionalRangeBorderCollection.toJSON()". */ + /** An interface describing the data returned by calling `conditionalRangeBorderCollection.toJSON()`. */ interface ConditionalRangeBorderCollectionData { items?: Excel.Interfaces.ConditionalRangeBorderData[]; } - /** An interface describing the data returned by calling "style.toJSON()". */ + /** An interface describing the data returned by calling `style.toJSON()`. */ interface StyleData { /** * @@ -50187,11 +50178,11 @@ declare namespace Excel { */ wrapText?: boolean; } - /** An interface describing the data returned by calling "styleCollection.toJSON()". */ + /** An interface describing the data returned by calling `styleCollection.toJSON()`. */ interface StyleCollectionData { items?: Excel.Interfaces.StyleData[]; } - /** An interface describing the data returned by calling "pageLayout.toJSON()". */ + /** An interface describing the data returned by calling `pageLayout.toJSON()`. */ interface PageLayoutData { /** * @@ -50335,7 +50326,7 @@ declare namespace Excel { */ zoom?: Excel.PageLayoutZoomOptions; } - /** An interface describing the data returned by calling "headerFooter.toJSON()". */ + /** An interface describing the data returned by calling `headerFooter.toJSON()`. */ interface HeaderFooterData { /** * @@ -50386,7 +50377,7 @@ declare namespace Excel { */ rightHeader?: string; } - /** An interface describing the data returned by calling "headerFooterGroup.toJSON()". */ + /** An interface describing the data returned by calling `headerFooterGroup.toJSON()`. */ interface HeaderFooterGroupData { /** * @@ -50438,7 +50429,7 @@ declare namespace Excel { */ useSheetScale?: boolean; } - /** An interface describing the data returned by calling "pageBreak.toJSON()". */ + /** An interface describing the data returned by calling `pageBreak.toJSON()`. */ interface PageBreakData { /** * @@ -50455,19 +50446,19 @@ declare namespace Excel { */ rowIndex?: number; } - /** An interface describing the data returned by calling "pageBreakCollection.toJSON()". */ + /** An interface describing the data returned by calling `pageBreakCollection.toJSON()`. */ interface PageBreakCollectionData { items?: Excel.Interfaces.PageBreakData[]; } - /** An interface describing the data returned by calling "rangeCollection.toJSON()". */ + /** An interface describing the data returned by calling `rangeCollection.toJSON()`. */ interface RangeCollectionData { items?: Excel.Interfaces.RangeData[]; } - /** An interface describing the data returned by calling "shapeCollection.toJSON()". */ + /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */ interface ShapeCollectionData { items?: Excel.Interfaces.ShapeData[]; } - /** An interface describing the data returned by calling "shape.toJSON()". */ + /** An interface describing the data returned by calling `shape.toJSON()`. */ interface ShapeData { /** * @@ -50600,7 +50591,7 @@ declare namespace Excel { */ zOrderPosition?: number; } - /** An interface describing the data returned by calling "geometricShape.toJSON()". */ + /** An interface describing the data returned by calling `geometricShape.toJSON()`. */ interface GeometricShapeData { /** * @@ -50610,7 +50601,7 @@ declare namespace Excel { */ id?: string; } - /** An interface describing the data returned by calling "image.toJSON()". */ + /** An interface describing the data returned by calling `image.toJSON()`. */ interface ImageData { /** * @@ -50627,7 +50618,7 @@ declare namespace Excel { */ format?: Excel.PictureFormat | "UNKNOWN" | "BMP" | "JPEG" | "GIF" | "PNG" | "SVG"; } - /** An interface describing the data returned by calling "shapeGroup.toJSON()". */ + /** An interface describing the data returned by calling `shapeGroup.toJSON()`. */ interface ShapeGroupData { /** * @@ -50644,11 +50635,11 @@ declare namespace Excel { */ id?: string; } - /** An interface describing the data returned by calling "groupShapeCollection.toJSON()". */ + /** An interface describing the data returned by calling `groupShapeCollection.toJSON()`. */ interface GroupShapeCollectionData { items?: Excel.Interfaces.ShapeData[]; } - /** An interface describing the data returned by calling "line.toJSON()". */ + /** An interface describing the data returned by calling `line.toJSON()`. */ interface LineData { /** * @@ -50735,7 +50726,7 @@ declare namespace Excel { */ connectorType?: Excel.ConnectorType | "Straight" | "Elbow" | "Curve"; } - /** An interface describing the data returned by calling "shapeFill.toJSON()". */ + /** An interface describing the data returned by calling `shapeFill.toJSON()`. */ interface ShapeFillData { /** * @@ -50759,7 +50750,7 @@ declare namespace Excel { */ type?: Excel.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "Mixed"; } - /** An interface describing the data returned by calling "shapeLineFormat.toJSON()". */ + /** An interface describing the data returned by calling `shapeLineFormat.toJSON()`. */ interface ShapeLineFormatData { /** * @@ -50804,7 +50795,7 @@ declare namespace Excel { */ weight?: number; } - /** An interface describing the data returned by calling "textFrame.toJSON()". */ + /** An interface describing the data returned by calling `textFrame.toJSON()`. */ interface TextFrameData { /** * @@ -50891,7 +50882,7 @@ declare namespace Excel { */ verticalOverflow?: Excel.ShapeTextVerticalOverflow | "Overflow" | "Ellipsis" | "Clip"; } - /** An interface describing the data returned by calling "textRange.toJSON()". */ + /** An interface describing the data returned by calling `textRange.toJSON()`. */ interface TextRangeData { /** * @@ -50908,7 +50899,7 @@ declare namespace Excel { */ text?: string; } - /** An interface describing the data returned by calling "shapeFont.toJSON()". */ + /** An interface describing the data returned by calling `shapeFont.toJSON()`. */ interface ShapeFontData { /** * @@ -50953,7 +50944,7 @@ declare namespace Excel { */ underline?: Excel.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble"; } - /** An interface describing the data returned by calling "functionResult.toJSON()". */ + /** An interface describing the data returned by calling `functionResult.toJSON()`. */ interface FunctionResultData { /** * @@ -50977,6 +50968,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.5] */ interface RuntimeLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -50993,6 +50987,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ApplicationLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -51032,6 +51029,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface IterativeCalculationLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -51063,6 +51063,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface WorkbookLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -51166,6 +51169,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.7] */ interface WorkbookProtectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -51183,6 +51189,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface WorksheetLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -51303,6 +51312,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface WorksheetCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -51423,6 +51435,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.2] */ interface WorksheetProtectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -51448,6 +51463,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface RangeLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -51651,6 +51669,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface RangeAreasLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -51732,6 +51753,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.3] */ interface RangeViewLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -51818,6 +51842,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.3] */ interface RangeViewCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -51904,6 +51931,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.4] */ interface SettingCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -51927,6 +51957,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.4] */ interface SettingLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -51950,6 +51983,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface NamedItemCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -52029,6 +52065,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface NamedItemLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -52108,6 +52147,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.7] */ interface NamedItemArrayValuesLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -52131,6 +52173,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface BindingLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -52154,6 +52199,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface BindingCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -52177,6 +52225,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface TableCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -52298,6 +52349,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface TableScopedCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -52420,6 +52474,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface TableLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -52541,6 +52598,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface TableColumnCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -52585,6 +52645,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface TableColumnLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -52634,6 +52697,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface TableRowCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -52662,6 +52728,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface TableRowLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -52686,6 +52755,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.8] */ interface DataValidationLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -52739,6 +52811,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface RemoveDuplicatesResultLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -52762,6 +52837,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface RangeFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -52891,6 +52969,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.2] */ interface FormatProtectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -52914,10 +52995,13 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface RangeFillLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * - * HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange") + * HTML color code representing the color of the background, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange") * * [Api set: ExcelApi 1.1] */ @@ -52962,6 +53046,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface RangeBorderLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -53007,6 +53094,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface RangeBorderCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -53052,6 +53142,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface RangeFontLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -53138,6 +53231,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -53320,6 +53416,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -53501,6 +53600,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface ChartPivotOptionsLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -53538,6 +53640,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartAreaFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -53575,6 +53680,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartSeriesCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -53901,6 +54009,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartSeriesLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -54227,6 +54338,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartSeriesFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -54243,6 +54357,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartPointsCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -54308,6 +54425,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartPointLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -54373,6 +54493,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartPointFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -54389,6 +54512,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartAxesLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -54419,6 +54545,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartAxisLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -54715,6 +54844,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartAxisFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -54738,6 +54870,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartAxisTitleLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -54768,6 +54903,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartAxisTitleFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -54791,6 +54929,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartDataLabelsLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -54907,6 +55048,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.7] */ interface ChartDataLabelLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -55065,6 +55209,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartDataLabelFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -55088,6 +55235,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface ChartErrorBarsLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -55132,6 +55282,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface ChartErrorBarsFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -55148,6 +55301,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartGridlinesLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -55171,6 +55327,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartGridlinesFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -55187,6 +55346,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartLegendLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -55259,6 +55421,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.7] */ interface ChartLegendEntryLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -55310,6 +55475,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.7] */ interface ChartLegendEntryCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -55361,6 +55529,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartLegendFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -55384,6 +55555,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface ChartMapOptionsLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -55414,6 +55588,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartTitleLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -55514,6 +55691,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.7] */ interface ChartFormatStringLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -55530,6 +55710,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartTitleFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -55553,6 +55736,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.7] */ interface ChartBorderLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -55583,6 +55769,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface ChartBinOptionsLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -55641,6 +55830,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface ChartBoxwhiskerOptionsLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -55685,6 +55877,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartLineFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -55715,6 +55910,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ interface ChartFontLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -55766,6 +55964,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.7] */ interface ChartTrendlineLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -55852,6 +56053,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.7] */ interface ChartTrendlineCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -55938,6 +56142,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.7] */ interface ChartTrendlineFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -55954,6 +56161,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.8] */ interface ChartTrendlineLabelLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -56056,6 +56266,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.8] */ interface ChartTrendlineLabelFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -56079,6 +56292,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.8] */ interface ChartPlotAreaLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -56158,6 +56374,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.8] */ interface ChartPlotAreaFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -56174,6 +56393,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.2] */ interface TableSortLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -56204,6 +56426,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.2] */ interface FilterLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -56221,6 +56446,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface AutoFilterLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -56253,6 +56481,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.5] */ interface CustomXmlPartScopedCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -56276,6 +56507,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.5] */ interface CustomXmlPartCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -56299,6 +56533,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.5] */ interface CustomXmlPartLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -56322,6 +56559,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.3] */ interface PivotTableCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -56374,6 +56614,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.3] */ interface PivotTableLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -56425,6 +56668,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.8] */ interface PivotLayoutLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -56476,6 +56722,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.8] */ interface PivotHierarchyCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -56499,6 +56748,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.8] */ interface PivotHierarchyLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -56522,6 +56774,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.8] */ interface RowColumnPivotHierarchyCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -56552,6 +56807,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.8] */ interface RowColumnPivotHierarchyLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -56582,6 +56840,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.8] */ interface FilterPivotHierarchyCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -56619,6 +56880,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.8] */ interface FilterPivotHierarchyLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -56656,6 +56920,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.8] */ interface DataPivotHierarchyCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -56714,6 +56981,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.8] */ interface DataPivotHierarchyLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -56772,6 +57042,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.8] */ interface PivotFieldCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -56809,6 +57082,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.8] */ interface PivotFieldLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -56846,6 +57122,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.8] */ interface PivotItemCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -56883,6 +57162,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.8] */ interface PivotItemLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -56920,6 +57202,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.7] */ interface DocumentPropertiesLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -57006,6 +57291,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.7] */ interface CustomPropertyLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -57036,6 +57324,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.7] */ interface CustomPropertyCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -57066,6 +57357,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.6] */ interface ConditionalFormatCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -57227,6 +57521,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.6] */ interface ConditionalFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -57387,6 +57684,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.6] */ interface DataBarConditionalFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -57455,6 +57755,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.6] */ interface ConditionalDataBarPositiveFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -57486,6 +57789,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.6] */ interface ConditionalDataBarNegativeFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -57524,6 +57830,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.6] */ interface CustomConditionalFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -57547,6 +57856,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.6] */ interface ConditionalFormatRuleLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -57577,6 +57889,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.6] */ interface IconSetConditionalFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -57614,6 +57929,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.6] */ interface ColorScaleConditionalFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -57637,6 +57955,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.6] */ interface TopBottomConditionalFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -57660,6 +57981,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.6] */ interface PresetCriteriaConditionalFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -57683,6 +58007,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.6] */ interface TextConditionalFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -57706,6 +58033,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.6] */ interface CellValueConditionalFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -57729,6 +58059,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.6] */ interface ConditionalRangeFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -57766,6 +58099,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.6] */ interface ConditionalRangeFontLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -57810,6 +58146,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.6] */ interface ConditionalRangeFillLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -57826,6 +58165,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.6] */ interface ConditionalRangeBorderLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -57856,6 +58198,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.6] */ interface ConditionalRangeBorderCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -57886,6 +58231,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.7] */ interface StyleLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -58056,6 +58404,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.7] */ interface StyleCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -58226,6 +58577,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface PageLayoutLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -58373,6 +58727,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface HeaderFooterLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -58427,6 +58784,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface HeaderFooterGroupLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -58482,6 +58842,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface PageBreakLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -58502,6 +58865,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface PageBreakCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -58522,6 +58888,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface RangeCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -58724,6 +59093,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface ShapeCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -58906,6 +59278,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface ShapeLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -59087,6 +59462,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface GeometricShapeLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -59110,6 +59488,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface ImageLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -59140,6 +59521,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface ShapeGroupLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -59163,6 +59547,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface GroupShapeCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -59344,6 +59731,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface LineLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -59458,6 +59848,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface ShapeFillLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -59488,6 +59881,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface ShapeLineFormatLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -59539,6 +59935,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface TextFrameLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -59639,6 +60038,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface TextRangeLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -59662,6 +60064,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ interface ShapeFontLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -59713,6 +60118,9 @@ declare namespace Excel { * [Api set: ExcelApi 1.2] */ interface FunctionResultLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ $all?: boolean; /** * @@ -59827,7 +60235,7 @@ declare namespace Word { readonly paragraphs: Word.ParagraphCollection; /** * - * Gets the parent body of the body. For example, a table cell body's parent body could be a header. Throws if there isn't a parent body. Read-only. + * Gets the parent body of the body. For example, a table cell body's parent body could be a header. Throws an error if there isn't a parent body. Read-only. * * [Api set: WordApi 1.3] */ @@ -59841,7 +60249,7 @@ declare namespace Word { readonly parentBodyOrNullObject: Word.Body; /** * - * Gets the content control that contains the body. Throws if there isn't a parent content control. Read-only. + * Gets the content control that contains the body. Throws an error if there isn't a parent content control. Read-only. * * [Api set: WordApi 1.1] */ @@ -59855,7 +60263,7 @@ declare namespace Word { readonly parentContentControlOrNullObject: Word.ContentControl; /** * - * Gets the parent section of the body. Throws if there isn't a parent section. Read-only. + * Gets the parent section of the body. Throws an error if there isn't a parent section. Read-only. * * [Api set: WordApi 1.3] */ @@ -59925,7 +60333,7 @@ declare namespace Word { clear(): void; /** * - * Gets an HTML representation of the body object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match to the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, etc.). If you need exact fidelity, or consistency across platforms, use `Body.getOoxml()` and convert the returned XML to HTML. + * Gets an HTML representation of the body object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, Word for the web, etc.). If you need exact fidelity, or consistency across platforms, use `Body.getOoxml()` and convert the returned XML to HTML. * * [Api set: WordApi 1.1] */ @@ -59957,7 +60365,7 @@ declare namespace Word { getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range; /** * - * Inserts a break at the specified location in the main document. The insertLocation value can be 'Start' or 'End'. + * Inserts a break at the specified location in the main document. * * [Api set: WordApi 1.1] * @@ -59967,7 +60375,7 @@ declare namespace Word { insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void; /** * - * Inserts a break at the specified location in the main document. The insertLocation value can be 'Start' or 'End'. + * Inserts a break at the specified location in the main document. * * [Api set: WordApi 1.1] * @@ -59984,7 +60392,7 @@ declare namespace Word { insertContentControl(): Word.ContentControl; /** * - * Inserts a document into the body at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts a document into the body at the specified location. * * [Api set: WordApi 1.1] * @@ -59994,7 +60402,7 @@ declare namespace Word { insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts a document into the body at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts a document into the body at the specified location. * * [Api set: WordApi 1.1] * @@ -60004,7 +60412,7 @@ declare namespace Word { insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range; /** * - * Inserts HTML at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts HTML at the specified location. * * [Api set: WordApi 1.1] * @@ -60014,7 +60422,7 @@ declare namespace Word { insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts HTML at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts HTML at the specified location. * * [Api set: WordApi 1.1] * @@ -60024,7 +60432,7 @@ declare namespace Word { insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range; /** * - * Inserts a picture into the body at the specified location. The insertLocation value can be 'Start' or 'End'. + * Inserts a picture into the body at the specified location. * * [Api set: WordApi 1.2] * @@ -60034,7 +60442,7 @@ declare namespace Word { insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture; /** * - * Inserts a picture into the body at the specified location. The insertLocation value can be 'Start' or 'End'. + * Inserts a picture into the body at the specified location. * * [Api set: WordApi 1.2] * @@ -60044,7 +60452,7 @@ declare namespace Word { insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.InlinePicture; /** * - * Inserts OOXML at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts OOXML at the specified location. * * [Api set: WordApi 1.1] * @@ -60054,7 +60462,7 @@ declare namespace Word { insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts OOXML at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts OOXML at the specified location. * * [Api set: WordApi 1.1] * @@ -60064,7 +60472,7 @@ declare namespace Word { insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range; /** * - * Inserts a paragraph at the specified location. The insertLocation value can be 'Start' or 'End'. + * Inserts a paragraph at the specified location. * * [Api set: WordApi 1.1] * @@ -60074,7 +60482,7 @@ declare namespace Word { insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph; /** * - * Inserts a paragraph at the specified location. The insertLocation value can be 'Start' or 'End'. + * Inserts a paragraph at the specified location. * * [Api set: WordApi 1.1] * @@ -60084,7 +60492,7 @@ declare namespace Word { insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph; /** * - * Inserts a table with the specified number of rows and columns. The insertLocation value can be 'Start' or 'End'. + * Inserts a table with the specified number of rows and columns. * * [Api set: WordApi 1.3] * @@ -60096,7 +60504,7 @@ declare namespace Word { insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table; /** * - * Inserts a table with the specified number of rows and columns. The insertLocation value can be 'Start' or 'End'. + * Inserts a table with the specified number of rows and columns. * * [Api set: WordApi 1.3] * @@ -60108,7 +60516,7 @@ declare namespace Word { insertTable(rowCount: number, columnCount: number, insertLocation: "Before" | "After" | "Start" | "End" | "Replace", values?: string[][]): Word.Table; /** * - * Inserts text into the body at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts text into the body at the specified location. * * [Api set: WordApi 1.1] * @@ -60118,7 +60526,7 @@ declare namespace Word { insertText(text: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts text into the body at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts text into the body at the specified location. * * [Api set: WordApi 1.1] * @@ -60250,7 +60658,7 @@ declare namespace Word { readonly parentBody: Word.Body; /** * - * Gets the content control that contains the content control. Throws if there isn't a parent content control. Read-only. + * Gets the content control that contains the content control. Throws an error if there isn't a parent content control. Read-only. * * [Api set: WordApi 1.1] */ @@ -60264,14 +60672,14 @@ declare namespace Word { readonly parentContentControlOrNullObject: Word.ContentControl; /** * - * Gets the table that contains the content control. Throws if it is not contained in a table. Read-only. + * Gets the table that contains the content control. Throws an error if it is not contained in a table. Read-only. * * [Api set: WordApi 1.3] */ readonly parentTable: Word.Table; /** * - * Gets the table cell that contains the content control. Throws if it is not contained in a table cell. Read-only. + * Gets the table cell that contains the content control. Throws an error if it is not contained in a table cell. Read-only. * * [Api set: WordApi 1.3] */ @@ -60427,7 +60835,7 @@ declare namespace Word { delete(keepContent: boolean): void; /** * - * Gets an HTML representation of the content control object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match to the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, etc.). If you need exact fidelity, or consistency across platforms, use `ContentControl.getOoxml()` and convert the returned XML to HTML. + * Gets an HTML representation of the content control object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, Word for the web, etc.). If you need exact fidelity, or consistency across platforms, use `ContentControl.getOoxml()` and convert the returned XML to HTML. * * [Api set: WordApi 1.1] */ @@ -60469,7 +60877,7 @@ declare namespace Word { getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection; /** * - * Inserts a break at the specified location in the main document. The insertLocation value can be 'Start', 'End', 'Before', or 'After'. This method cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls. + * Inserts a break at the specified location in the main document. This method cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls. * * [Api set: WordApi 1.1] * @@ -60479,7 +60887,7 @@ declare namespace Word { insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void; /** * - * Inserts a break at the specified location in the main document. The insertLocation value can be 'Start', 'End', 'Before', or 'After'. This method cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls. + * Inserts a break at the specified location in the main document. This method cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls. * * [Api set: WordApi 1.1] * @@ -60489,7 +60897,7 @@ declare namespace Word { insertBreak(breakType: "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): void; /** * - * Inserts a document into the content control at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts a document into the content control at the specified location. * * [Api set: WordApi 1.1] * @@ -60499,7 +60907,7 @@ declare namespace Word { insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts a document into the content control at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts a document into the content control at the specified location. * * [Api set: WordApi 1.1] * @@ -60509,7 +60917,7 @@ declare namespace Word { insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range; /** * - * Inserts HTML into the content control at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts HTML into the content control at the specified location. * * [Api set: WordApi 1.1] * @@ -60519,7 +60927,7 @@ declare namespace Word { insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts HTML into the content control at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts HTML into the content control at the specified location. * * [Api set: WordApi 1.1] * @@ -60529,7 +60937,7 @@ declare namespace Word { insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range; /** * - * Inserts an inline picture into the content control at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts an inline picture into the content control at the specified location. * * [Api set: WordApi 1.2] * @@ -60539,7 +60947,7 @@ declare namespace Word { insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture; /** * - * Inserts an inline picture into the content control at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts an inline picture into the content control at the specified location. * * [Api set: WordApi 1.2] * @@ -60549,7 +60957,7 @@ declare namespace Word { insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.InlinePicture; /** * - * Inserts OOXML into the content control at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts OOXML into the content control at the specified location. * * [Api set: WordApi 1.1] * @@ -60559,7 +60967,7 @@ declare namespace Word { insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts OOXML into the content control at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts OOXML into the content control at the specified location. * * [Api set: WordApi 1.1] * @@ -60569,7 +60977,7 @@ declare namespace Word { insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range; /** * - * Inserts a paragraph at the specified location. The insertLocation value can be 'Start', 'End', 'Before', or 'After'. + * Inserts a paragraph at the specified location. * * [Api set: WordApi 1.1] * @@ -60579,7 +60987,7 @@ declare namespace Word { insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph; /** * - * Inserts a paragraph at the specified location. The insertLocation value can be 'Start', 'End', 'Before', or 'After'. + * Inserts a paragraph at the specified location. * * [Api set: WordApi 1.1] * @@ -60589,7 +60997,7 @@ declare namespace Word { insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph; /** * - * Inserts a table with the specified number of rows and columns into, or next to, a content control. The insertLocation value can be 'Start', 'End', 'Before', or 'After'. + * Inserts a table with the specified number of rows and columns into, or next to, a content control. * * [Api set: WordApi 1.3] * @@ -60601,7 +61009,7 @@ declare namespace Word { insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table; /** * - * Inserts a table with the specified number of rows and columns into, or next to, a content control. The insertLocation value can be 'Start', 'End', 'Before', or 'After'. + * Inserts a table with the specified number of rows and columns into, or next to, a content control. * * [Api set: WordApi 1.3] * @@ -60613,7 +61021,7 @@ declare namespace Word { insertTable(rowCount: number, columnCount: number, insertLocation: "Before" | "After" | "Start" | "End" | "Replace", values?: string[][]): Word.Table; /** * - * Inserts text into the content control at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts text into the content control at the specified location. * * [Api set: WordApi 1.1] * @@ -60623,7 +61031,7 @@ declare namespace Word { insertText(text: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts text into the content control at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts text into the content control at the specified location. * * [Api set: WordApi 1.1] * @@ -60727,7 +61135,7 @@ declare namespace Word { readonly items: Word.ContentControl[]; /** * - * Gets a content control by its identifier. Throws if there isn't a content control with the identifier in this collection. + * Gets a content control by its identifier. Throws an error if there isn't a content control with the identifier in this collection. * * [Api set: WordApi 1.1] * @@ -60772,7 +61180,7 @@ declare namespace Word { getByTypes(types: Word.ContentControlType[]): Word.ContentControlCollection; /** * - * Gets the first content control in this collection. Throws if this collection is empty. + * Gets the first content control in this collection. Throws an error if this collection is empty. * * [Api set: WordApi 1.3] */ @@ -60850,7 +61258,7 @@ declare namespace Word { readonly type: Word.DocumentPropertyType | "String" | "Number" | "Date" | "Boolean"; /** * - * Gets or sets the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * Gets or sets the value of the custom property. Note that even though Word for the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). * * [Api set: WordApi 1.3] */ @@ -60948,7 +61356,7 @@ declare namespace Word { getCount(): OfficeExtension.ClientResult; /** * - * Gets a custom property object by its key, which is case-insensitive. Throws if the custom property does not exist. + * Gets a custom property object by its key, which is case-insensitive. Throws an error if the custom property does not exist. * * [Api set: WordApi 1.3] * @@ -61063,7 +61471,7 @@ declare namespace Word { getSelection(): Word.Range; /** * - * Saves the document. This will use the Word default file naming convention if the document has not been saved before. + * Saves the document. This uses the Word default file naming convention if the document has not been saved before. * * [Api set: WordApi 1.1] */ @@ -61170,7 +61578,7 @@ declare namespace Word { open(): void; /** * - * Saves the document. This will use the Word default file naming convention if the document has not been saved before. + * Saves the document. This uses the Word default file naming convention if the document has not been saved before. * * [Api set: WordApiHiddenDocument 1.3] */ @@ -61427,11 +61835,8 @@ declare namespace Word { /** * * Gets or sets the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or null for no highlight color. + **Note**: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. * - * **Note**: Only the default highlight colors are available in Office on Windows Desktop. - * These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". - * When the add-in runs in Office on Windows Desktop, any other color is converted to the closest color when applied to the font. - * * [Api set: WordApi 1.1] */ highlightColor: string; @@ -61551,7 +61956,7 @@ declare namespace Word { readonly paragraph: Word.Paragraph; /** * - * Gets the content control that contains the inline image. Throws if there isn't a parent content control. Read-only. + * Gets the content control that contains the inline image. Throws an error if there isn't a parent content control. Read-only. * * [Api set: WordApi 1.1] */ @@ -61565,14 +61970,14 @@ declare namespace Word { readonly parentContentControlOrNullObject: Word.ContentControl; /** * - * Gets the table that contains the inline image. Throws if it is not contained in a table. Read-only. + * Gets the table that contains the inline image. Throws an error if it is not contained in a table. Read-only. * * [Api set: WordApi 1.3] */ readonly parentTable: Word.Table; /** * - * Gets the table cell that contains the inline image. Throws if it is not contained in a table cell. Read-only. + * Gets the table cell that contains the inline image. Throws an error if it is not contained in a table cell. Read-only. * * [Api set: WordApi 1.3] */ @@ -61663,7 +62068,7 @@ declare namespace Word { getBase64ImageSrc(): OfficeExtension.ClientResult; /** * - * Gets the next inline image. Throws if this inline image is the last one. + * Gets the next inline image. Throws an error if this inline image is the last one. * * [Api set: WordApi 1.3] */ @@ -61695,7 +62100,7 @@ declare namespace Word { getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range; /** * - * Inserts a break at the specified location in the main document. The insertLocation value can be 'Before' or 'After'. + * Inserts a break at the specified location in the main document. * * [Api set: WordApi 1.2] * @@ -61705,7 +62110,7 @@ declare namespace Word { insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void; /** * - * Inserts a break at the specified location in the main document. The insertLocation value can be 'Before' or 'After'. + * Inserts a break at the specified location in the main document. * * [Api set: WordApi 1.2] * @@ -61722,7 +62127,7 @@ declare namespace Word { insertContentControl(): Word.ContentControl; /** * - * Inserts a document at the specified location. The insertLocation value can be 'Before' or 'After'. + * Inserts a document at the specified location. * * [Api set: WordApi 1.2] * @@ -61732,7 +62137,7 @@ declare namespace Word { insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts a document at the specified location. The insertLocation value can be 'Before' or 'After'. + * Inserts a document at the specified location. * * [Api set: WordApi 1.2] * @@ -61742,7 +62147,7 @@ declare namespace Word { insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range; /** * - * Inserts HTML at the specified location. The insertLocation value can be 'Before' or 'After'. + * Inserts HTML at the specified location. * * [Api set: WordApi 1.2] * @@ -61752,7 +62157,7 @@ declare namespace Word { insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts HTML at the specified location. The insertLocation value can be 'Before' or 'After'. + * Inserts HTML at the specified location. * * [Api set: WordApi 1.2] * @@ -61762,7 +62167,7 @@ declare namespace Word { insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range; /** * - * Inserts an inline picture at the specified location. The insertLocation value can be 'Replace', 'Before', or 'After'. + * Inserts an inline picture at the specified location. * * [Api set: WordApi 1.2] * @@ -61772,7 +62177,7 @@ declare namespace Word { insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture; /** * - * Inserts an inline picture at the specified location. The insertLocation value can be 'Replace', 'Before', or 'After'. + * Inserts an inline picture at the specified location. * * [Api set: WordApi 1.2] * @@ -61782,7 +62187,7 @@ declare namespace Word { insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.InlinePicture; /** * - * Inserts OOXML at the specified location. The insertLocation value can be 'Before' or 'After'. + * Inserts OOXML at the specified location. * * [Api set: WordApi 1.2] * @@ -61792,7 +62197,7 @@ declare namespace Word { insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts OOXML at the specified location. The insertLocation value can be 'Before' or 'After'. + * Inserts OOXML at the specified location. * * [Api set: WordApi 1.2] * @@ -61802,7 +62207,7 @@ declare namespace Word { insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range; /** * - * Inserts a paragraph at the specified location. The insertLocation value can be 'Before' or 'After'. + * Inserts a paragraph at the specified location. * * [Api set: WordApi 1.2] * @@ -61812,7 +62217,7 @@ declare namespace Word { insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph; /** * - * Inserts a paragraph at the specified location. The insertLocation value can be 'Before' or 'After'. + * Inserts a paragraph at the specified location. * * [Api set: WordApi 1.2] * @@ -61822,7 +62227,7 @@ declare namespace Word { insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph; /** * - * Inserts text at the specified location. The insertLocation value can be 'Before' or 'After'. + * Inserts text at the specified location. * * [Api set: WordApi 1.2] * @@ -61832,7 +62237,7 @@ declare namespace Word { insertText(text: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts text at the specified location. The insertLocation value can be 'Before' or 'After'. + * Inserts text at the specified location. * * [Api set: WordApi 1.2] * @@ -61906,7 +62311,7 @@ declare namespace Word { readonly items: Word.InlinePicture[]; /** * - * Gets the first inline image in this collection. Throws if this collection is empty. + * Gets the first inline image in this collection. Throws an error if this collection is empty. * * [Api set: WordApi 1.3] */ @@ -61998,7 +62403,7 @@ declare namespace Word { getLevelParagraphs(level: number): Word.ParagraphCollection; /** * - * Gets the bullet, number or picture at the specified level as a string. + * Gets the bullet, number, or picture at the specified level as a string. * * [Api set: WordApi 1.3] * @@ -62007,7 +62412,7 @@ declare namespace Word { getLevelString(level: number): OfficeExtension.ClientResult; /** * - * Inserts a paragraph at the specified location. The insertLocation value can be 'Start', 'End', 'Before', or 'After'. + * Inserts a paragraph at the specified location. * * [Api set: WordApi 1.3] * @@ -62017,7 +62422,7 @@ declare namespace Word { insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph; /** * - * Inserts a paragraph at the specified location. The insertLocation value can be 'Start', 'End', 'Before', or 'After'. + * Inserts a paragraph at the specified location. * * [Api set: WordApi 1.3] * @@ -62027,7 +62432,7 @@ declare namespace Word { insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph; /** * - * Sets the alignment of the bullet, number or picture at the specified level in the list. + * Sets the alignment of the bullet, number, or picture at the specified level in the list. * * [Api set: WordApi 1.3] * @@ -62037,7 +62442,7 @@ declare namespace Word { setLevelAlignment(level: number, alignment: Word.Alignment): void; /** * - * Sets the alignment of the bullet, number or picture at the specified level in the list. + * Sets the alignment of the bullet, number, or picture at the specified level in the list. * * [Api set: WordApi 1.3] * @@ -62077,7 +62482,7 @@ declare namespace Word { * * @param level Required. The level in the list. * @param textIndent Required. The text indent in points. It is the same as paragraph left indent. - * @param bulletNumberPictureIndent Required. The relative indent, in points, of the bullet, number or picture. It is the same as paragraph first line indent. + * @param bulletNumberPictureIndent Required. The relative indent, in points, of the bullet, number, or picture. It is the same as paragraph first line indent. */ setLevelIndents(level: number, textIndent: number, bulletNumberPictureIndent: number): void; /** @@ -62160,7 +62565,7 @@ declare namespace Word { readonly items: Word.List[]; /** * - * Gets a list by its identifier. Throws if there isn't a list with the identifier in this collection. + * Gets a list by its identifier. Throws an error if there isn't a list with the identifier in this collection. * * [Api set: WordApi 1.3] * @@ -62178,7 +62583,7 @@ declare namespace Word { getByIdOrNullObject(id: number): Word.List; /** * - * Gets the first list in this collection. Throws if this collection is empty. + * Gets the first list in this collection. Throws an error if this collection is empty. * * [Api set: WordApi 1.3] */ @@ -62277,7 +62682,7 @@ declare namespace Word { set(properties: Word.ListItem): void; /** * - * Gets the list item parent, or the closest ancestor if the parent does not exist. Throws if the list item has no ancestor. + * Gets the list item parent, or the closest ancestor if the parent does not exist. Throws an error if the list item has no ancestor. * * [Api set: WordApi 1.3] * @@ -62369,14 +62774,14 @@ declare namespace Word { readonly inlinePictures: Word.InlinePictureCollection; /** * - * Gets the List to which this paragraph belongs. Throws if the paragraph is not in a list. Read-only. + * Gets the List to which this paragraph belongs. Throws an error if the paragraph is not in a list. Read-only. * * [Api set: WordApi 1.3] */ readonly list: Word.List; /** * - * Gets the ListItem for the paragraph. Throws if the paragraph is not part of a list. Read-only. + * Gets the ListItem for the paragraph. Throws an error if the paragraph is not part of a list. Read-only. * * [Api set: WordApi 1.3] */ @@ -62404,7 +62809,7 @@ declare namespace Word { readonly parentBody: Word.Body; /** * - * Gets the content control that contains the paragraph. Throws if there isn't a parent content control. Read-only. + * Gets the content control that contains the paragraph. Throws an error if there isn't a parent content control. Read-only. * * [Api set: WordApi 1.1] */ @@ -62418,14 +62823,14 @@ declare namespace Word { readonly parentContentControlOrNullObject: Word.ContentControl; /** * - * Gets the table that contains the paragraph. Throws if it is not contained in a table. Read-only. + * Gets the table that contains the paragraph. Throws an error if it is not contained in a table. Read-only. * * [Api set: WordApi 1.3] */ readonly parentTable: Word.Table; /** * - * Gets the table cell that contains the paragraph. Throws if it is not contained in a table cell. Read-only. + * Gets the table cell that contains the paragraph. Throws an error if it is not contained in a table cell. Read-only. * * [Api set: WordApi 1.3] */ @@ -62603,14 +63008,14 @@ declare namespace Word { detachFromList(): void; /** * - * Gets an HTML representation of the paragraph object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match to the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, etc.). If you need exact fidelity, or consistency across platforms, use `Paragraph.getOoxml()` and convert the returned XML to HTML. + * Gets an HTML representation of the paragraph object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, Word for the web, etc.). If you need exact fidelity, or consistency across platforms, use `Paragraph.getOoxml()` and convert the returned XML to HTML. * * [Api set: WordApi 1.1] */ getHtml(): OfficeExtension.ClientResult; /** * - * Gets the next paragraph. Throws if the paragraph is the last one. + * Gets the next paragraph. Throws an error if the paragraph is the last one. * * [Api set: WordApi 1.3] */ @@ -62631,7 +63036,7 @@ declare namespace Word { getOoxml(): OfficeExtension.ClientResult; /** * - * Gets the previous paragraph. Throws if the paragraph is the first one. + * Gets the previous paragraph. Throws an error if the paragraph is the first one. * * [Api set: WordApi 1.3] */ @@ -62673,7 +63078,7 @@ declare namespace Word { getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection; /** * - * Inserts a break at the specified location in the main document. The insertLocation value can be 'Before' or 'After'. + * Inserts a break at the specified location in the main document. * * [Api set: WordApi 1.1] * @@ -62683,7 +63088,7 @@ declare namespace Word { insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void; /** * - * Inserts a break at the specified location in the main document. The insertLocation value can be 'Before' or 'After'. + * Inserts a break at the specified location in the main document. * * [Api set: WordApi 1.1] * @@ -62700,7 +63105,7 @@ declare namespace Word { insertContentControl(): Word.ContentControl; /** * - * Inserts a document into the paragraph at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts a document into the paragraph at the specified location. * * [Api set: WordApi 1.1] * @@ -62710,7 +63115,7 @@ declare namespace Word { insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts a document into the paragraph at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts a document into the paragraph at the specified location. * * [Api set: WordApi 1.1] * @@ -62720,7 +63125,7 @@ declare namespace Word { insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range; /** * - * Inserts HTML into the paragraph at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts HTML into the paragraph at the specified location. * * [Api set: WordApi 1.1] * @@ -62730,7 +63135,7 @@ declare namespace Word { insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts HTML into the paragraph at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts HTML into the paragraph at the specified location. * * [Api set: WordApi 1.1] * @@ -62740,7 +63145,7 @@ declare namespace Word { insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range; /** * - * Inserts a picture into the paragraph at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts a picture into the paragraph at the specified location. * * [Api set: WordApi 1.1] * @@ -62750,7 +63155,7 @@ declare namespace Word { insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture; /** * - * Inserts a picture into the paragraph at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts a picture into the paragraph at the specified location. * * [Api set: WordApi 1.1] * @@ -62760,7 +63165,7 @@ declare namespace Word { insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.InlinePicture; /** * - * Inserts OOXML into the paragraph at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts OOXML into the paragraph at the specified location. * * [Api set: WordApi 1.1] * @@ -62770,7 +63175,7 @@ declare namespace Word { insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts OOXML into the paragraph at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts OOXML into the paragraph at the specified location. * * [Api set: WordApi 1.1] * @@ -62780,7 +63185,7 @@ declare namespace Word { insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range; /** * - * Inserts a paragraph at the specified location. The insertLocation value can be 'Before' or 'After'. + * Inserts a paragraph at the specified location. * * [Api set: WordApi 1.1] * @@ -62790,7 +63195,7 @@ declare namespace Word { insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph; /** * - * Inserts a paragraph at the specified location. The insertLocation value can be 'Before' or 'After'. + * Inserts a paragraph at the specified location. * * [Api set: WordApi 1.1] * @@ -62800,7 +63205,7 @@ declare namespace Word { insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph; /** * - * Inserts a table with the specified number of rows and columns. The insertLocation value can be 'Before' or 'After'. + * Inserts a table with the specified number of rows and columns. * * [Api set: WordApi 1.3] * @@ -62812,7 +63217,7 @@ declare namespace Word { insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table; /** * - * Inserts a table with the specified number of rows and columns. The insertLocation value can be 'Before' or 'After'. + * Inserts a table with the specified number of rows and columns. * * [Api set: WordApi 1.3] * @@ -62824,7 +63229,7 @@ declare namespace Word { insertTable(rowCount: number, columnCount: number, insertLocation: "Before" | "After" | "Start" | "End" | "Replace", values?: string[][]): Word.Table; /** * - * Inserts text into the paragraph at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts text into the paragraph at the specified location. * * [Api set: WordApi 1.1] * @@ -62834,7 +63239,7 @@ declare namespace Word { insertText(text: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts text into the paragraph at the specified location. The insertLocation value can be 'Replace', 'Start', or 'End'. + * Inserts text into the paragraph at the specified location. * * [Api set: WordApi 1.1] * @@ -62944,7 +63349,7 @@ declare namespace Word { readonly items: Word.Paragraph[]; /** * - * Gets the first paragraph in this collection. Throws if the collection is empty. + * Gets the first paragraph in this collection. Throws an error if the collection is empty. * * [Api set: WordApi 1.3] */ @@ -62958,7 +63363,7 @@ declare namespace Word { getFirstOrNullObject(): Word.Paragraph; /** * - * Gets the last paragraph in this collection. Throws if the collection is empty. + * Gets the last paragraph in this collection. Throws an error if the collection is empty. * * [Api set: WordApi 1.3] */ @@ -63055,7 +63460,7 @@ declare namespace Word { readonly parentBody: Word.Body; /** * - * Gets the content control that contains the range. Throws if there isn't a parent content control. Read-only. + * Gets the content control that contains the range. Throws an error if there isn't a parent content control. Read-only. * * [Api set: WordApi 1.1] */ @@ -63069,14 +63474,14 @@ declare namespace Word { readonly parentContentControlOrNullObject: Word.ContentControl; /** * - * Gets the table that contains the range. Throws if it is not contained in a table. Read-only. + * Gets the table that contains the range. Throws an error if it is not contained in a table. Read-only. * * [Api set: WordApi 1.3] */ readonly parentTable: Word.Table; /** * - * Gets the table cell that contains the range. Throws if it is not contained in a table cell. Read-only. + * Gets the table cell that contains the range. Throws an error if it is not contained in a table cell. Read-only. * * [Api set: WordApi 1.3] */ @@ -63176,7 +63581,7 @@ declare namespace Word { delete(): void; /** * - * Returns a new range that extends from this range in either direction to cover another range. This range is not changed. Throws if the two ranges do not have a union. + * Returns a new range that extends from this range in either direction to cover another range. This range is not changed. Throws an error if the two ranges do not have a union. * * [Api set: WordApi 1.3] * @@ -63194,7 +63599,7 @@ declare namespace Word { expandToOrNullObject(range: Word.Range): Word.Range; /** * - * Gets an HTML representation of the range object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match to the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, etc.). If you need exact fidelity, or consistency across platforms, use `Range.getOoxml()` and convert the returned XML to HTML. + * Gets an HTML representation of the range object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, Word for the web, etc.). If you need exact fidelity, or consistency across platforms, use `Range.getOoxml()` and convert the returned XML to HTML. * * [Api set: WordApi 1.1] */ @@ -63208,7 +63613,7 @@ declare namespace Word { getHyperlinkRanges(): Word.RangeCollection; /** * - * Gets the next text range by using punctuation marks and/or other ending marks. Throws if this text range is the last one. + * Gets the next text range by using punctuation marks and/or other ending marks. Throws an error if this text range is the last one. * * [Api set: WordApi 1.3] * @@ -63263,7 +63668,7 @@ declare namespace Word { getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection; /** * - * Inserts a break at the specified location in the main document. The insertLocation value can be 'Before' or 'After'. + * Inserts a break at the specified location in the main document. * * [Api set: WordApi 1.1] * @@ -63273,7 +63678,7 @@ declare namespace Word { insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void; /** * - * Inserts a break at the specified location in the main document. The insertLocation value can be 'Before' or 'After'. + * Inserts a break at the specified location in the main document. * * [Api set: WordApi 1.1] * @@ -63290,7 +63695,7 @@ declare namespace Word { insertContentControl(): Word.ContentControl; /** * - * Inserts a document at the specified location. The insertLocation value can be 'Replace', 'Start', 'End', 'Before', or 'After'. + * Inserts a document at the specified location. * * [Api set: WordApi 1.1] * @@ -63300,7 +63705,7 @@ declare namespace Word { insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts a document at the specified location. The insertLocation value can be 'Replace', 'Start', 'End', 'Before', or 'After'. + * Inserts a document at the specified location. * * [Api set: WordApi 1.1] * @@ -63310,7 +63715,7 @@ declare namespace Word { insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range; /** * - * Inserts HTML at the specified location. The insertLocation value can be 'Replace', 'Start', 'End', 'Before', or 'After'. + * Inserts HTML at the specified location. * * [Api set: WordApi 1.1] * @@ -63320,7 +63725,7 @@ declare namespace Word { insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts HTML at the specified location. The insertLocation value can be 'Replace', 'Start', 'End', 'Before', or 'After'. + * Inserts HTML at the specified location. * * [Api set: WordApi 1.1] * @@ -63330,7 +63735,7 @@ declare namespace Word { insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range; /** * - * Inserts a picture at the specified location. The insertLocation value can be 'Replace', 'Start', 'End', 'Before', or 'After'. + * Inserts a picture at the specified location. * * [Api set: WordApi 1.2] * @@ -63340,7 +63745,7 @@ declare namespace Word { insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture; /** * - * Inserts a picture at the specified location. The insertLocation value can be 'Replace', 'Start', 'End', 'Before', or 'After'. + * Inserts a picture at the specified location. * * [Api set: WordApi 1.2] * @@ -63350,7 +63755,7 @@ declare namespace Word { insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.InlinePicture; /** * - * Inserts OOXML at the specified location. The insertLocation value can be 'Replace', 'Start', 'End', 'Before', or 'After'. + * Inserts OOXML at the specified location. * * [Api set: WordApi 1.1] * @@ -63360,7 +63765,7 @@ declare namespace Word { insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts OOXML at the specified location. The insertLocation value can be 'Replace', 'Start', 'End', 'Before', or 'After'. + * Inserts OOXML at the specified location. * * [Api set: WordApi 1.1] * @@ -63370,7 +63775,7 @@ declare namespace Word { insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range; /** * - * Inserts a paragraph at the specified location. The insertLocation value can be 'Before' or 'After'. + * Inserts a paragraph at the specified location. * * [Api set: WordApi 1.1] * @@ -63380,7 +63785,7 @@ declare namespace Word { insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph; /** * - * Inserts a paragraph at the specified location. The insertLocation value can be 'Before' or 'After'. + * Inserts a paragraph at the specified location. * * [Api set: WordApi 1.1] * @@ -63390,7 +63795,7 @@ declare namespace Word { insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph; /** * - * Inserts a table with the specified number of rows and columns. The insertLocation value can be 'Before' or 'After'. + * Inserts a table with the specified number of rows and columns. * * [Api set: WordApi 1.3] * @@ -63402,7 +63807,7 @@ declare namespace Word { insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table; /** * - * Inserts a table with the specified number of rows and columns. The insertLocation value can be 'Before' or 'After'. + * Inserts a table with the specified number of rows and columns. * * [Api set: WordApi 1.3] * @@ -63414,7 +63819,7 @@ declare namespace Word { insertTable(rowCount: number, columnCount: number, insertLocation: "Before" | "After" | "Start" | "End" | "Replace", values?: string[][]): Word.Table; /** * - * Inserts text at the specified location. The insertLocation value can be 'Replace', 'Start', 'End', 'Before', or 'After'. + * Inserts text at the specified location. * * [Api set: WordApi 1.1] * @@ -63424,7 +63829,7 @@ declare namespace Word { insertText(text: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts text at the specified location. The insertLocation value can be 'Replace', 'Start', 'End', 'Before', or 'After'. + * Inserts text at the specified location. * * [Api set: WordApi 1.1] * @@ -63434,7 +63839,7 @@ declare namespace Word { insertText(text: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range; /** * - * Returns a new range as the intersection of this range with another range. This range is not changed. Throws if the two ranges are not overlapped or adjacent. + * Returns a new range as the intersection of this range with another range. This range is not changed. Throws an error if the two ranges are not overlapped or adjacent. * * [Api set: WordApi 1.3] * @@ -63546,7 +63951,7 @@ declare namespace Word { readonly items: Word.Range[]; /** * - * Gets the first range in this collection. Throws if this collection is empty. + * Gets the first range in this collection. Throws an error if this collection is empty. * * [Api set: WordApi 1.3] */ @@ -63762,7 +64167,7 @@ declare namespace Word { getHeader(type: "Primary" | "FirstPage" | "EvenPages"): Word.Body; /** * - * Gets the next section. Throws if this section is the last one. + * Gets the next section. Throws an error if this section is the last one. * * [Api set: WordApi 1.3] */ @@ -63822,7 +64227,7 @@ declare namespace Word { readonly items: Word.Section[]; /** * - * Gets the first section in this collection. Throws if this collection is empty. + * Gets the first section in this collection. Throws an error if this collection is empty. * * [Api set: WordApi 1.3] */ @@ -63891,7 +64296,7 @@ declare namespace Word { readonly parentBody: Word.Body; /** * - * Gets the content control that contains the table. Throws if there isn't a parent content control. Read-only. + * Gets the content control that contains the table. Throws an error if there isn't a parent content control. Read-only. * * [Api set: WordApi 1.3] */ @@ -63905,14 +64310,14 @@ declare namespace Word { readonly parentContentControlOrNullObject: Word.ContentControl; /** * - * Gets the table that contains this table. Throws if it is not contained in a table. Read-only. + * Gets the table that contains this table. Throws an error if it is not contained in a table. Read-only. * * [Api set: WordApi 1.3] */ readonly parentTable: Word.Table; /** * - * Gets the table cell that contains this table. Throws if it is not contained in a table cell. Read-only. + * Gets the table cell that contains this table. Throws an error if it is not contained in a table cell. Read-only. * * [Api set: WordApi 1.3] */ @@ -64190,7 +64595,7 @@ declare namespace Word { getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder; /** * - * Gets the table cell at a specified row and column. Throws if the specified table cell does not exist. + * Gets the table cell at a specified row and column. Throws an error if the specified table cell does not exist. * * [Api set: WordApi 1.3] * @@ -64228,7 +64633,7 @@ declare namespace Word { getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; /** * - * Gets the next table. Throws if this table is the last one. + * Gets the next table. Throws an error if this table is the last one. * * [Api set: WordApi 1.3] */ @@ -64242,7 +64647,7 @@ declare namespace Word { getNextOrNullObject(): Word.Table; /** * - * Gets the paragraph after the table. Throws if there isn't a paragraph after the table. + * Gets the paragraph after the table. Throws an error if there isn't a paragraph after the table. * * [Api set: WordApi 1.3] */ @@ -64256,7 +64661,7 @@ declare namespace Word { getParagraphAfterOrNullObject(): Word.Paragraph; /** * - * Gets the paragraph before the table. Throws if there isn't a paragraph before the table. + * Gets the paragraph before the table. Throws an error if there isn't a paragraph before the table. * * [Api set: WordApi 1.3] */ @@ -64295,7 +64700,7 @@ declare namespace Word { insertContentControl(): Word.ContentControl; /** * - * Inserts a paragraph at the specified location. The insertLocation value can be 'Before' or 'After'. + * Inserts a paragraph at the specified location. * * [Api set: WordApi 1.3] * @@ -64305,7 +64710,7 @@ declare namespace Word { insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph; /** * - * Inserts a paragraph at the specified location. The insertLocation value can be 'Before' or 'After'. + * Inserts a paragraph at the specified location. * * [Api set: WordApi 1.3] * @@ -64315,7 +64720,7 @@ declare namespace Word { insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph; /** * - * Inserts a table with the specified number of rows and columns. The insertLocation value can be 'Before' or 'After'. + * Inserts a table with the specified number of rows and columns. * * [Api set: WordApi 1.3] * @@ -64327,7 +64732,7 @@ declare namespace Word { insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table; /** * - * Inserts a table with the specified number of rows and columns. The insertLocation value can be 'Before' or 'After'. + * Inserts a table with the specified number of rows and columns. * * [Api set: WordApi 1.3] * @@ -64441,7 +64846,7 @@ declare namespace Word { readonly items: Word.Table[]; /** * - * Gets the first table in this collection. Throws if this collection is empty. + * Gets the first table in this collection. Throws an error if this collection is empty. * * [Api set: WordApi 1.3] */ @@ -64637,7 +65042,7 @@ declare namespace Word { getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; /** * - * Gets the next row. Throws if this row is the last one. + * Gets the next row. Throws an error if this row is the last one. * * [Api set: WordApi 1.3] */ @@ -64775,7 +65180,7 @@ declare namespace Word { readonly items: Word.TableRow[]; /** * - * Gets the first row in this collection. Throws if this collection is empty. + * Gets the first row in this collection. Throws an error if this collection is empty. * * [Api set: WordApi 1.3] */ @@ -64971,7 +65376,7 @@ declare namespace Word { getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; /** * - * Gets the next cell. Throws if this cell is the last one. + * Gets the next cell. Throws an error if this cell is the last one. * * [Api set: WordApi 1.3] */ @@ -65095,7 +65500,7 @@ declare namespace Word { readonly items: Word.TableCell[]; /** * - * Gets the first table cell in this collection. Throws if this collection is empty. + * Gets the first table cell in this collection. Throws an error if this collection is empty. * * [Api set: WordApi 1.3] */ @@ -65555,7 +65960,7 @@ declare namespace Word { enum HeaderFooterType { /** * - * Returns the header or footer on all pages of a section, with the first page or odd pages excluded if they are different. + * Returns the header or footer on all pages of a section, but excludes the first page or odd pages if they are different. * */ primary = "Primary", @@ -66207,7 +66612,7 @@ declare namespace Word { interface CustomPropertyUpdateData { /** * - * Gets or sets the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * Gets or sets the value of the custom property. Note that even though Word for the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). * * [Api set: WordApi 1.3] */ @@ -66343,11 +66748,8 @@ declare namespace Word { /** * * Gets or sets the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or null for no highlight color. + **Note**: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. * - * **Note**: Only the default highlight colors are available in Office on Windows Desktop. - * These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". - * When the add-in runs in Office on Windows Desktop, any other color is converted to the closest color when applied to the font. - * * [Api set: WordApi 1.1] */ highlightColor?: string; @@ -66475,7 +66877,7 @@ declare namespace Word { font?: Word.Interfaces.FontUpdateData; /** * - * Gets the ListItem for the paragraph. Throws if the paragraph is not part of a list. + * Gets the ListItem for the paragraph. Throws an error if the paragraph is not part of a list. * * [Api set: WordApi 1.3] */ @@ -67149,7 +67551,7 @@ declare namespace Word { type?: Word.DocumentPropertyType | "String" | "Number" | "Date" | "Boolean"; /** * - * Gets or sets the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * Gets or sets the value of the custom property. Note that even though Word for the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). * * [Api set: WordApi 1.3] */ @@ -67390,11 +67792,8 @@ declare namespace Word { /** * * Gets or sets the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or null for no highlight color. + **Note**: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. * - * **Note**: Only the default highlight colors are available in Office on Windows Desktop. - * These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". - * When the add-in runs in Office on Windows Desktop, any other color is converted to the closest color when applied to the font. - * * [Api set: WordApi 1.1] */ highlightColor?: string; @@ -67574,7 +67973,7 @@ declare namespace Word { inlinePictures?: Word.Interfaces.InlinePictureData[]; /** * - * Gets the ListItem for the paragraph. Throws if the paragraph is not part of a list. Read-only. + * Gets the ListItem for the paragraph. Throws an error if the paragraph is not part of a list. Read-only. * * [Api set: WordApi 1.3] */ @@ -68160,7 +68559,7 @@ declare namespace Word { font?: Word.Interfaces.FontLoadOptions; /** * - * Gets the parent body of the body. For example, a table cell body's parent body could be a header. Throws if there isn't a parent body. + * Gets the parent body of the body. For example, a table cell body's parent body could be a header. Throws an error if there isn't a parent body. * * [Api set: WordApi 1.3] */ @@ -68174,7 +68573,7 @@ declare namespace Word { parentBodyOrNullObject?: Word.Interfaces.BodyLoadOptions; /** * - * Gets the content control that contains the body. Throws if there isn't a parent content control. + * Gets the content control that contains the body. Throws an error if there isn't a parent content control. * * [Api set: WordApi 1.1] */ @@ -68188,7 +68587,7 @@ declare namespace Word { parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** * - * Gets the parent section of the body. Throws if there isn't a parent section. + * Gets the parent section of the body. Throws an error if there isn't a parent section. * * [Api set: WordApi 1.3] */ @@ -68253,7 +68652,7 @@ declare namespace Word { parentBody?: Word.Interfaces.BodyLoadOptions; /** * - * Gets the content control that contains the content control. Throws if there isn't a parent content control. + * Gets the content control that contains the content control. Throws an error if there isn't a parent content control. * * [Api set: WordApi 1.1] */ @@ -68267,14 +68666,14 @@ declare namespace Word { parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** * - * Gets the table that contains the content control. Throws if it is not contained in a table. + * Gets the table that contains the content control. Throws an error if it is not contained in a table. * * [Api set: WordApi 1.3] */ parentTable?: Word.Interfaces.TableLoadOptions; /** * - * Gets the table cell that contains the content control. Throws if it is not contained in a table cell. + * Gets the table cell that contains the content control. Throws an error if it is not contained in a table cell. * * [Api set: WordApi 1.3] */ @@ -68416,7 +68815,7 @@ declare namespace Word { parentBody?: Word.Interfaces.BodyLoadOptions; /** * - * For EACH ITEM in the collection: Gets the content control that contains the content control. Throws if there isn't a parent content control. + * For EACH ITEM in the collection: Gets the content control that contains the content control. Throws an error if there isn't a parent content control. * * [Api set: WordApi 1.1] */ @@ -68430,14 +68829,14 @@ declare namespace Word { parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** * - * For EACH ITEM in the collection: Gets the table that contains the content control. Throws if it is not contained in a table. + * For EACH ITEM in the collection: Gets the table that contains the content control. Throws an error if it is not contained in a table. * * [Api set: WordApi 1.3] */ parentTable?: Word.Interfaces.TableLoadOptions; /** * - * For EACH ITEM in the collection: Gets the table cell that contains the content control. Throws if it is not contained in a table cell. + * For EACH ITEM in the collection: Gets the table cell that contains the content control. Throws an error if it is not contained in a table cell. * * [Api set: WordApi 1.3] */ @@ -68579,7 +68978,7 @@ declare namespace Word { type?: boolean; /** * - * Gets or sets the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * Gets or sets the value of the custom property. Note that even though Word for the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). * * [Api set: WordApi 1.3] */ @@ -68609,7 +69008,7 @@ declare namespace Word { type?: boolean; /** * - * For EACH ITEM in the collection: Gets or sets the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * For EACH ITEM in the collection: Gets or sets the value of the custom property. Note that even though Word for the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). * * [Api set: WordApi 1.3] */ @@ -68842,11 +69241,8 @@ declare namespace Word { /** * * Gets or sets the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or null for no highlight color. + **Note**: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. * - * **Note**: Only the default highlight colors are available in Office on Windows Desktop. - * These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". - * When the add-in runs in Office on Windows Desktop, any other color is converted to the closest color when applied to the font. - * * [Api set: WordApi 1.1] */ highlightColor?: boolean; @@ -68917,7 +69313,7 @@ declare namespace Word { paragraph?: Word.Interfaces.ParagraphLoadOptions; /** * - * Gets the content control that contains the inline image. Throws if there isn't a parent content control. + * Gets the content control that contains the inline image. Throws an error if there isn't a parent content control. * * [Api set: WordApi 1.1] */ @@ -68931,14 +69327,14 @@ declare namespace Word { parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** * - * Gets the table that contains the inline image. Throws if it is not contained in a table. + * Gets the table that contains the inline image. Throws an error if it is not contained in a table. * * [Api set: WordApi 1.3] */ parentTable?: Word.Interfaces.TableLoadOptions; /** * - * Gets the table cell that contains the inline image. Throws if it is not contained in a table cell. + * Gets the table cell that contains the inline image. Throws an error if it is not contained in a table cell. * * [Api set: WordApi 1.3] */ @@ -69017,7 +69413,7 @@ declare namespace Word { paragraph?: Word.Interfaces.ParagraphLoadOptions; /** * - * For EACH ITEM in the collection: Gets the content control that contains the inline image. Throws if there isn't a parent content control. + * For EACH ITEM in the collection: Gets the content control that contains the inline image. Throws an error if there isn't a parent content control. * * [Api set: WordApi 1.1] */ @@ -69031,14 +69427,14 @@ declare namespace Word { parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** * - * For EACH ITEM in the collection: Gets the table that contains the inline image. Throws if it is not contained in a table. + * For EACH ITEM in the collection: Gets the table that contains the inline image. Throws an error if it is not contained in a table. * * [Api set: WordApi 1.3] */ parentTable?: Word.Interfaces.TableLoadOptions; /** * - * For EACH ITEM in the collection: Gets the table cell that contains the inline image. Throws if it is not contained in a table cell. + * For EACH ITEM in the collection: Gets the table cell that contains the inline image. Throws an error if it is not contained in a table cell. * * [Api set: WordApi 1.3] */ @@ -69207,14 +69603,14 @@ declare namespace Word { font?: Word.Interfaces.FontLoadOptions; /** * - * Gets the List to which this paragraph belongs. Throws if the paragraph is not in a list. + * Gets the List to which this paragraph belongs. Throws an error if the paragraph is not in a list. * * [Api set: WordApi 1.3] */ list?: Word.Interfaces.ListLoadOptions; /** * - * Gets the ListItem for the paragraph. Throws if the paragraph is not part of a list. + * Gets the ListItem for the paragraph. Throws an error if the paragraph is not part of a list. * * [Api set: WordApi 1.3] */ @@ -69242,7 +69638,7 @@ declare namespace Word { parentBody?: Word.Interfaces.BodyLoadOptions; /** * - * Gets the content control that contains the paragraph. Throws if there isn't a parent content control. + * Gets the content control that contains the paragraph. Throws an error if there isn't a parent content control. * * [Api set: WordApi 1.1] */ @@ -69256,14 +69652,14 @@ declare namespace Word { parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** * - * Gets the table that contains the paragraph. Throws if it is not contained in a table. + * Gets the table that contains the paragraph. Throws an error if it is not contained in a table. * * [Api set: WordApi 1.3] */ parentTable?: Word.Interfaces.TableLoadOptions; /** * - * Gets the table cell that contains the paragraph. Throws if it is not contained in a table cell. + * Gets the table cell that contains the paragraph. Throws an error if it is not contained in a table cell. * * [Api set: WordApi 1.3] */ @@ -69412,14 +69808,14 @@ declare namespace Word { font?: Word.Interfaces.FontLoadOptions; /** * - * For EACH ITEM in the collection: Gets the List to which this paragraph belongs. Throws if the paragraph is not in a list. + * For EACH ITEM in the collection: Gets the List to which this paragraph belongs. Throws an error if the paragraph is not in a list. * * [Api set: WordApi 1.3] */ list?: Word.Interfaces.ListLoadOptions; /** * - * For EACH ITEM in the collection: Gets the ListItem for the paragraph. Throws if the paragraph is not part of a list. + * For EACH ITEM in the collection: Gets the ListItem for the paragraph. Throws an error if the paragraph is not part of a list. * * [Api set: WordApi 1.3] */ @@ -69447,7 +69843,7 @@ declare namespace Word { parentBody?: Word.Interfaces.BodyLoadOptions; /** * - * For EACH ITEM in the collection: Gets the content control that contains the paragraph. Throws if there isn't a parent content control. + * For EACH ITEM in the collection: Gets the content control that contains the paragraph. Throws an error if there isn't a parent content control. * * [Api set: WordApi 1.1] */ @@ -69461,14 +69857,14 @@ declare namespace Word { parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** * - * For EACH ITEM in the collection: Gets the table that contains the paragraph. Throws if it is not contained in a table. + * For EACH ITEM in the collection: Gets the table that contains the paragraph. Throws an error if it is not contained in a table. * * [Api set: WordApi 1.3] */ parentTable?: Word.Interfaces.TableLoadOptions; /** * - * For EACH ITEM in the collection: Gets the table cell that contains the paragraph. Throws if it is not contained in a table cell. + * For EACH ITEM in the collection: Gets the table cell that contains the paragraph. Throws an error if it is not contained in a table cell. * * [Api set: WordApi 1.3] */ @@ -69624,7 +70020,7 @@ declare namespace Word { parentBody?: Word.Interfaces.BodyLoadOptions; /** * - * Gets the content control that contains the range. Throws if there isn't a parent content control. + * Gets the content control that contains the range. Throws an error if there isn't a parent content control. * * [Api set: WordApi 1.1] */ @@ -69638,14 +70034,14 @@ declare namespace Word { parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** * - * Gets the table that contains the range. Throws if it is not contained in a table. + * Gets the table that contains the range. Throws an error if it is not contained in a table. * * [Api set: WordApi 1.3] */ parentTable?: Word.Interfaces.TableLoadOptions; /** * - * Gets the table cell that contains the range. Throws if it is not contained in a table cell. + * Gets the table cell that contains the range. Throws an error if it is not contained in a table cell. * * [Api set: WordApi 1.3] */ @@ -69724,7 +70120,7 @@ declare namespace Word { parentBody?: Word.Interfaces.BodyLoadOptions; /** * - * For EACH ITEM in the collection: Gets the content control that contains the range. Throws if there isn't a parent content control. + * For EACH ITEM in the collection: Gets the content control that contains the range. Throws an error if there isn't a parent content control. * * [Api set: WordApi 1.1] */ @@ -69738,14 +70134,14 @@ declare namespace Word { parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** * - * For EACH ITEM in the collection: Gets the table that contains the range. Throws if it is not contained in a table. + * For EACH ITEM in the collection: Gets the table that contains the range. Throws an error if it is not contained in a table. * * [Api set: WordApi 1.3] */ parentTable?: Word.Interfaces.TableLoadOptions; /** * - * For EACH ITEM in the collection: Gets the table cell that contains the range. Throws if it is not contained in a table cell. + * For EACH ITEM in the collection: Gets the table cell that contains the range. Throws an error if it is not contained in a table cell. * * [Api set: WordApi 1.3] */ @@ -69914,7 +70310,7 @@ declare namespace Word { parentBody?: Word.Interfaces.BodyLoadOptions; /** * - * Gets the content control that contains the table. Throws if there isn't a parent content control. + * Gets the content control that contains the table. Throws an error if there isn't a parent content control. * * [Api set: WordApi 1.3] */ @@ -69928,14 +70324,14 @@ declare namespace Word { parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** * - * Gets the table that contains this table. Throws if it is not contained in a table. + * Gets the table that contains this table. Throws an error if it is not contained in a table. * * [Api set: WordApi 1.3] */ parentTable?: Word.Interfaces.TableLoadOptions; /** * - * Gets the table cell that contains this table. Throws if it is not contained in a table cell. + * Gets the table cell that contains this table. Throws an error if it is not contained in a table cell. * * [Api set: WordApi 1.3] */ @@ -70098,7 +70494,7 @@ declare namespace Word { parentBody?: Word.Interfaces.BodyLoadOptions; /** * - * For EACH ITEM in the collection: Gets the content control that contains the table. Throws if there isn't a parent content control. + * For EACH ITEM in the collection: Gets the content control that contains the table. Throws an error if there isn't a parent content control. * * [Api set: WordApi 1.3] */ @@ -70112,14 +70508,14 @@ declare namespace Word { parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** * - * For EACH ITEM in the collection: Gets the table that contains this table. Throws if it is not contained in a table. + * For EACH ITEM in the collection: Gets the table that contains this table. Throws an error if it is not contained in a table. * * [Api set: WordApi 1.3] */ parentTable?: Word.Interfaces.TableLoadOptions; /** * - * For EACH ITEM in the collection: Gets the table cell that contains this table. Throws if it is not contained in a table cell. + * For EACH ITEM in the collection: Gets the table cell that contains this table. Throws an error if it is not contained in a table cell. * * [Api set: WordApi 1.3] */