diff --git a/types/jasmine/package.json b/types/jasmine/package.json
index b9939904fc0f9b..3f486733af5f96 100644
--- a/types/jasmine/package.json
+++ b/types/jasmine/package.json
@@ -33,10 +33,6 @@
"name": "Giles Roadnight",
"githubUsername": "Roaders"
},
- {
- "name": "Yaroslav Admin",
- "githubUsername": "devoto13"
- },
{
"name": "Domas Trijonis",
"githubUsername": "fdim"
diff --git a/types/office-js-preview/index.d.ts b/types/office-js-preview/index.d.ts
index a7652c2534ec91..53d312798ef4c9 100644
--- a/types/office-js-preview/index.d.ts
+++ b/types/office-js-preview/index.d.ts
@@ -39425,8 +39425,7 @@ declare namespace Excel {
* Returns a `window` object that represents the active window (the window on top). Read-only.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
readonly activeWindow: Excel.Window;
/**
@@ -39446,11 +39445,10 @@ declare namespace Excel {
*/
readonly iterativeCalculation: Excel.IterativeCalculation;
/**
- * Returns all the Excel windows.
+ * Returns all the open Excel windows.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
readonly windows: Excel.WindowCollection;
/**
@@ -39535,8 +39533,7 @@ declare namespace Excel {
* Checks the spelling of a single word. Returns `true` if the word is spelled correctly, otherwise returns `false`.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*
* @param word The word that you want to check.
* @param options Optional. The options for checking spelling.
@@ -39547,8 +39544,7 @@ declare namespace Excel {
This method is equivalent to using "F2" when selecting a cell or range in the Excel UI.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
enterEditingMode(): void;
/**
@@ -39573,8 +39569,7 @@ declare namespace Excel {
The maximum number of parameters is 30, including the first two.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*
* @param firstRange The first `Range` or `RangeAreas` object.
* @param secondRange The second `Range` or `RangeAreas` object.
@@ -39971,30 +39966,11 @@ declare namespace Excel {
*/
close(closeBehavior?: "Save" | "SkipSave"): void;
/**
- * Enters Scratchpad Preview Mode for the workbook, showing changes suggested by Copilot to the user.
- *
- * @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
- */
- enterPreviewMode(): void;
- /**
- * Exits Scratchpad Preview Mode for the workbook. This method should be called once the user decides to apply or discard changes suggested by Copilot.
- *
- * @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
- *
- * @param applyChanges A Boolean value that specifies whether the user wants to apply the changes proposed by Copilot shown in Preview Mode (`true`), or discard the changes shown in Preview Mode (`false`). The default value is `false`, as accepting changes should be an active and explicit choice by the user.
- */
- exitPreviewMode(applyChanges: boolean): void;
- /**
- * Sets focus on the workbook. This causes the Excel grid or the currently active object
+ * Sets focus on the workbook. This will cause the grid or the currently active object
to receive keyboard events.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
focus(): void;
/**
@@ -40507,8 +40483,7 @@ declare namespace Excel {
* Checks the spelling of words in this worksheet. This method opens the Spelling dialog box in the Excel UI.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*
* @param options Optional. The options for checking spelling.
*/
@@ -40517,8 +40492,7 @@ declare namespace Excel {
* Clears the tracer arrows from the worksheet.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
clearArrows(): void;
/**
@@ -40554,8 +40528,7 @@ declare namespace Excel {
* Returns the evaluation result of a formula string. Only formula input is supported. If the formula name is invalid, the `InvalidArgument` error is thrown.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*
* @param name The name of the formula to run.
*/
@@ -40881,24 +40854,21 @@ declare namespace Excel {
* Represents the options for checking spelling.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
interface CheckSpellingOptions {
/**
* Optional. A string that indicates the file name of the custom dictionary to be examined if the word isn't found in the main dictionary. If this argument is omitted, Excel's currently specified dictionary is used.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
customDictionary?: string;
/**
* Optional. Set to `true` to ignore words that are all uppercase. Set to `false` to check words that are all uppercase. If this argument is omitted, Excel's current setting is used.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
ignoreUppercase?: boolean;
}
@@ -41661,8 +41631,7 @@ declare namespace Excel {
* Specifies the array formula of a range. If the specified range doesn't contain an array formula, this property returns `null`.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
formulaArray: string;
/**
@@ -41907,8 +41876,7 @@ declare namespace Excel {
* Checks the spelling of words in this range. This method opens the Spelling dialog box in the Excel UI.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*
* @param options Optional. The options for checking spelling.
*/
@@ -42160,7 +42128,7 @@ declare namespace Excel {
*/
getEntireRow(): Excel.Range;
/**
- * Returns a range object that includes the current range and up to the edge of the range, based on the provided direction. This matches the Ctrl+Shift+Arrow key behavior in the Excel on Windows UI.
+ * Returns a range object that includes the current range and up to the edge of the range, based on the provided direction. This matches the Ctrl+Shift+Arrow key behavior in the Excel on Windows UI.
*
* @remarks
* [Api set: ExcelApi 1.13]
@@ -42170,7 +42138,7 @@ declare namespace Excel {
*/
getExtendedRange(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range;
/**
- * Returns a range object that includes the current range and up to the edge of the range, based on the provided direction. This matches the Ctrl+Shift+Arrow key behavior in the Excel on Windows UI.
+ * Returns a range object that includes the current range and up to the edge of the range, based on the provided direction. This matches the Ctrl+Shift+Arrow key behavior in the Excel on Windows UI.
*
* @remarks
* [Api set: ExcelApi 1.13]
@@ -42265,7 +42233,7 @@ declare namespace Excel {
*/
getPrecedents(): Excel.WorkbookRangeAreas;
/**
- * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI.
+ * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI.
*
* @remarks
* [Api set: ExcelApi 1.13]
@@ -42275,7 +42243,7 @@ declare namespace Excel {
*/
getRangeEdge(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range;
/**
- * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI.
+ * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI.
*
* @remarks
* [Api set: ExcelApi 1.13]
@@ -42606,8 +42574,7 @@ declare namespace Excel {
* Draws tracer arrows to the direct dependents of the range.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*
* @param remove Optional. Set to `true` to remove one level of tracer arrows to direct dependents. Set to `false` to expand one level of tracer arrows. The default value is `false`.
*/
@@ -42634,8 +42601,7 @@ declare namespace Excel {
* Draws tracer arrows to the direct precedents of the range.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*
* @param remove Optional. Set to `true` to remove one level of tracer arrows to direct precedents. Set to `false` to expand one level of tracer arrows. The default value is `false`.
*/
@@ -45132,32 +45098,38 @@ declare namespace Excel {
*/
enum TableSource {
/**
- * An external data source.
+ * External data source (such as Microsoft SharePoint Foundation).
* @remarks
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
*/
external = "External",
/**
* An Excel range object.
* @remarks
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
*/
range = "Range",
/**
- * An XML file.
+ * XML data source.
* @remarks
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
*/
xml = "Xml",
/**
- * A Power Query query.
+ * Query data source.
* @remarks
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
*/
query = "Query",
/**
+ * Power Pivot model.
* @remarks
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
*/
model = "Model"
}
@@ -57644,8 +57616,7 @@ declare namespace Excel {
* Specifies whether Excel aligns the header and the footer with the margins set in the page setup options.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
alignMarginsHeaderFooter: boolean;
/**
@@ -57766,8 +57737,7 @@ declare namespace Excel {
Some printers may not support vertical print quality and the supported values may vary by printer.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
printQuality: number[];
/**
@@ -58012,48 +57982,42 @@ declare namespace Excel {
* Gets a `HeaderFooterPicture` object that represents the picture for the center section of the footer.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
readonly centerFooterPicture: Excel.HeaderFooterPicture;
/**
* Gets a `HeaderFooterPicture` object that represents the picture for the center section of the header.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
readonly centerHeaderPicture: Excel.HeaderFooterPicture;
/**
* Gets a `HeaderFooterPicture` object that represents the picture for the left section of the footer.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
readonly leftFooterPicture: Excel.HeaderFooterPicture;
/**
* Gets a `HeaderFooterPicture` object that represents the picture for the left section of the header.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
readonly leftHeaderPicture: Excel.HeaderFooterPicture;
/**
* Gets a `HeaderFooterPicture` object that represents the picture for the right section of the footer.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
readonly rightFooterPicture: Excel.HeaderFooterPicture;
/**
* Gets a `HeaderFooterPicture` object that represents the picture for the right section of the header.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
readonly rightHeaderPicture: Excel.HeaderFooterPicture;
/**
@@ -58234,8 +58198,7 @@ declare namespace Excel {
* Represents a picture in the header or footer of a worksheet.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
class HeaderFooterPicture extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -58244,88 +58207,77 @@ declare namespace Excel {
* Specifies the brightness of the picture. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest).
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
brightness: number;
/**
* Specifies the type of color transformation of the picture.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
colorType: Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark";
/**
* Specifies the contrast of the picture. The value for this property must be a number from 0.0 (least contrast) to 1.0 (most contrast).
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
contrast: number;
/**
* Specifies the number of points that are cropped off the bottom of the picture.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
cropBottom: number;
/**
* Specifies the number of points that are cropped off the left side of the picture.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
cropLeft: number;
/**
* Specifies the number of points that are cropped off the right side of the picture.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
cropRight: number;
/**
* Specifies the number of points that are cropped off the top of the picture.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
cropTop: number;
/**
* Specifies the URL (on the intranet or the web) or path (local or network) to the location where the source object is saved.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
filename: string;
/**
* Specifies the height of the picture in points.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
height: number;
/**
* Specifies a value that indicates whether the picture retains its original proportions when resized. `true` if it retains its proportions; otherwise, `false`.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
lockAspectRatio: boolean;
/**
* Specifies the width of the picture in points.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
width: number;
/**
@@ -58367,43 +58319,37 @@ declare namespace Excel {
* Specifies the color transformation of a picture in the header or footer of a worksheet.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
enum PictureColorType {
/**
* Mixed transformation.
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
mixed = "Mixed",
/**
* Default color transformation.
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
automatic = "Automatic",
/**
* Grayscale transformation.
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
grayScale = "GrayScale",
/**
* Black-and-white transformation.
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
blackAndWhite = "BlackAndWhite",
/**
* Watermark transformation.
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
watermark = "Watermark"
}
@@ -59878,56 +59824,49 @@ declare namespace Excel {
* Specifies the brightness of the image. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest).
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
brightness: number;
/**
* Specifies the type of color transformation applied to the image.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
colorType: Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark";
/**
* Specifies the contrast of the image. The value for this property must be a number from 0.0 (the least contrast) to 1.0 (the greatest contrast).
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
contrast: number;
/**
* Specifies the number of points that are cropped off the bottom of the image.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
cropBottom: number;
/**
* Specifies the number of points that are cropped off the left side of the image.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
cropLeft: number;
/**
* Specifies the number of points that are cropped off the right side of the image.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
cropRight: number;
/**
* Specifies the number of points that are cropped off the top of the image.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
cropTop: number;
/**
@@ -59956,8 +59895,7 @@ declare namespace Excel {
* Increments the brightness of the image by a specified amount.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*
* @param increment Specifies how much to change the value of the Brightness property for the picture. A positive value makes the picture brighter; a negative value makes the picture darker.
*/
@@ -59966,8 +59904,7 @@ declare namespace Excel {
* Increments the contrast of the image by a specified amount.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*
* @param increment Specifies how much to change the value of the Contrast property for the picture. A positive value increases the contrast; a negative value decreases the contrast.
*/
@@ -69219,8 +69156,7 @@ declare namespace Excel {
* Represents a window in the workbook.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
class Window extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -69229,32 +69165,28 @@ declare namespace Excel {
* Specifies the active cell in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
readonly activeCell: Excel.Range;
/**
* Specifies the active pane in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
readonly activePane: Excel.Pane;
/**
* Specifies the active sheet in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
readonly activeWorksheet: Excel.Worksheet;
/**
- * Gets the panes associated with the window.
+ * Gets a collection of panes associated with the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
readonly panes: Excel.PaneCollection;
/**
@@ -69269,296 +69201,259 @@ declare namespace Excel {
* Gets the visible range of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
readonly visibleRange: Excel.Range;
/**
* Specifies whether AutoFilter date grouping is enabled in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
autoFilterDateGroupingEnabled: boolean;
/**
- * Specifies a value indicating whether resizing is enabled for the window.
+ * Specifies whether resizing is enabled for the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
readonly enableResize: boolean;
/**
- * Specifies a value indicating whether panes are frozen in the window.
+ * Specifies whether panes are frozen in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
freezePanes: boolean;
/**
* Specifies the height of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
height: number;
/**
* Gets the index of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
readonly index: number;
/**
- * Specifies the visibility of the window.
+ * Specifies whether the window is visible.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
isVisible: boolean;
/**
- * Specifies the left position of the window.
+ * Specifies the distance, in points, from the left edge of the computer screen to the left edge of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
left: number;
/**
* Specifies the name of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
name: string;
/**
* Specifies the scroll column of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
scrollColumn: number;
/**
* Specifies the scroll row of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
scrollRow: number;
/**
- * Specifies the display of formulas in the window.
+ * Specifies whether formulas are shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showFormulas: boolean;
/**
- * Specifies the display of gridlines in the window.
+ * Specifies whether gridlines are shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showGridlines: boolean;
/**
- * Specifies the display of headings in the window.
+ * Specifies whether headings are shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showHeadings: boolean;
/**
- * Specifies the display of the horizontal scroll bar in the window.
+ * Specifies whether the horizontal scroll bar is shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showHorizontalScrollBar: boolean;
/**
- * Specifies the display of the outline in the window.
+ * Specifies whether outline is shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showOutline: boolean;
/**
- * Specifies the display of the right-to-left layout in the window.
+ * Gets the right-to-left layout value of the window. True means that the window is using right-to-left layout, false means that the window is using left-to-right layout.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
readonly showRightToLeft: boolean;
/**
- * Specifies the display of the ruler in the window.
+ * Specifies whether the ruler is shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showRuler: boolean;
/**
- * Specifies the display of the vertical scroll bar in the window.
+ * Specifies whether the vertical scroll bar is shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showVerticalScrollBar: boolean;
/**
- * Specifies the display of whitespace in the window.
+ * Specifies whether whitespace is shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showWhitespace: boolean;
/**
- * Specifies the display of workbook tabs in the window.
+ * Specifies whether workbook tabs are shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showWorkbookTabs: boolean;
/**
- * Specifies the display of zeros in the window.
+ * Specifies whether zeroes are shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showZeros: boolean;
/**
* Specifies the split state of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
split: boolean;
/**
* Specifies the split column of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
splitColumn: number;
/**
* Specifies the horizontal split of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
splitHorizontal: number;
/**
* Specifies the split row of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
splitRow: number;
/**
* Specifies the vertical split of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
splitVertical: number;
/**
* Specifies the tab ratio of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
tabRatio: number;
/**
- * Specifies the top position of the window.
+ * Specifies the distance, in points, from the top edge of the window to the top edge of the usable area (below the menus, any toolbars docked at the top, and the formula bar).
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
top: number;
/**
* Specifies the type of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
readonly type: Excel.WindowType | "chartAsWindow" | "chartInPlace" | "clipboard" | "workbook";
/**
* Specifies the usable height of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
readonly usableHeight: number;
/**
* Specifies the usable width of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
readonly usableWidth: number;
/**
* Specifies the view of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
view: Excel.WindowView | "normalView" | "pageBreakPreview" | "pageLayoutView";
/**
- * Returns or sets an integer value that represents the display size of the window. It can be set to a percentage between 10 and 400.
+ * Specifies the display width of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
width: number;
/**
- * Specifies the window number.
+ * Gets the window number.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
readonly windowNumber: number;
/**
- * Returns or sets an integer value that represents the display size of the window. It can be set to a percentage between 10 and 400.
+ * Specifies the window state.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
windowState: Excel.WindowState | "maximized" | "minimized" | "normal";
/**
* Specifies an integer value that represents the display size of the window. It can be set to a percentage between 10 and 400.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
zoom: number;
/**
@@ -69573,96 +69468,84 @@ declare namespace Excel {
* Activates the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
activate(): void;
/**
* Activates the next window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
activateNext(): void;
/**
* Activates the previous window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
activatePrevious(): void;
/**
* Closes the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
close(): OfficeExtension.ClientResult;
/**
- * Scrolls the window by a large amount.
+ * Scrolls the window by multiple pages. The `down`, `up`, `toRight`, and `toLeft` parameters correspond to the action of scrolling with Page Down, Page Up, Alt+Page Down, and Alt+Page Up keys on the keyboard.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
largeScroll(Down: number, Up: number, ToRight: number, ToLeft: number): void;
/**
- * Open a new window
+ * Opens a new Excel window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
newWindow(): Excel.Window;
/**
* Converts horizontal points to screen pixels.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
pointsToScreenPixelsX(Points: number): OfficeExtension.ClientResult;
/**
* Converts vertical points to screen pixels.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
pointsToScreenPixelsY(Points: number): OfficeExtension.ClientResult;
/**
* Scrolls the window to bring the specified range into view.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
scrollIntoView(Left: number, Top: number, Width: number, Height: number, Start?: boolean): void;
/**
* Scrolls the workbook tabs.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
scrollWorkbookTabs(Sheets?: number, Position?: Excel.ScrollWorkbookTabPosition): void;
/**
* Scrolls the workbook tabs.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
scrollWorkbookTabs(Sheets?: number, Position?: "First" | "Last"): void;
/**
- * Scrolls the window by a small amount.
+ * Scrolls the window by a number of rows or columns. The `down`, `up`, `toRight`, and `toLeft` parameters correspond to the action of scrolling with arrow keys on the keyboard.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
smallScroll(Down: number, Up: number, ToRight: number, ToLeft: number): void;
/**
@@ -69696,29 +69579,25 @@ declare namespace Excel {
* Specifies the display state of a window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
enum WindowState {
/**
* The window is maximized to fill the entire screen.
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
maximized = "maximized",
/**
* The window is minimized and collapsed to the taskbar.
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
minimized = "minimized",
/**
* The window is displayed in normal size and can be moved or resized.
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
normal = "normal"
}
@@ -69726,29 +69605,25 @@ declare namespace Excel {
* Specifies the view mode of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
enum WindowView {
/**
* The window displays the worksheet in normal view for general data entry and editing.
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
normalView = "normalView",
/**
* The window displays the worksheet in Page Break Preview mode to show where pages will break when printed.
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
pageBreakPreview = "pageBreakPreview",
/**
* The window displays the worksheet in Page Layout view to show how the worksheet will look when printed.
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
pageLayoutView = "pageLayoutView"
}
@@ -69756,36 +69631,31 @@ declare namespace Excel {
* Specifies the type of window being displayed.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
enum WindowType {
/**
* The window displays a chart in its own separate window.
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
chartAsWindow = "chartAsWindow",
/**
* The window displays a chart embedded within a worksheet.
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
chartInPlace = "chartInPlace",
/**
* The window displays the Office clipboard contents.
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
clipboard = "clipboard",
/**
* The window displays a standard Excel workbook.
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
workbook = "workbook"
}
@@ -69793,31 +69663,27 @@ declare namespace Excel {
* Enum representing the scroll position for workbook tab navigation.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
enum ScrollWorkbookTabPosition {
/**
* Scrolls the tab menu to show the first worksheet tab.
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
first = "First",
/**
* Scrolls the tab menu to show the last worksheet tab.
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
last = "Last"
}
/**
- * Represents the collection of all Window objects.
+ * Represents a collection of Window objects.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
class WindowCollection extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -69828,40 +69694,35 @@ declare namespace Excel {
* Breaks the side-by-side view of windows.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
breakSideBySide(): void;
/**
* Compares the current window side by side with the specified window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
compareCurrentSideBySideWith(windowName: string): void;
/**
* Gets the number of windows in the collection.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
getCount(): OfficeExtension.ClientResult;
/**
* Gets the Window in the collection by index.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
getItemAt(index: number): Excel.Window;
/**
* Resets the positions of windows in side-by-side view.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
resetPositionsSideBySide(): void;
/**
@@ -69892,8 +69753,7 @@ declare namespace Excel {
* Represents a pane, such as a frozen or split pane, in an Excel window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
class Pane extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -69902,8 +69762,7 @@ declare namespace Excel {
* Returns index of the pane.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
readonly index: number;
/**
@@ -69934,11 +69793,10 @@ declare namespace Excel {
toJSON(): Excel.Interfaces.PaneData;
}
/**
- * Represents the collection of all Pane objects that are part of the workbook.
+ * Represents a collection of Pane objects.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
class PaneCollection extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -69946,19 +69804,17 @@ declare namespace Excel {
/** Gets the loaded child items in this collection. */
readonly items: Excel.Pane[];
/**
- * Returns the number of bindings in the collection.
+ * Returns the number of panes in the collection.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
getCount(): OfficeExtension.ClientResult;
/**
- * Gets the Pane in the collection by index.
+ * Gets the pane in the collection by index.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
getItemAt(index: number): Excel.Pane;
/**
@@ -73940,8 +73796,7 @@ declare namespace Excel {
* Returns a `window` object that represents the active window (the window on top).
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
activeWindow?: Excel.Interfaces.WindowUpdateData;
/**
@@ -74169,8 +74024,7 @@ declare namespace Excel {
* Specifies the array formula of a range. If the specified range doesn't contain an array formula, this property returns `null`.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
formulaArray?: string;
/**
@@ -78190,8 +78044,7 @@ declare namespace Excel {
* Specifies whether Excel aligns the header and the footer with the margins set in the page setup options.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
alignMarginsHeaderFooter?: boolean;
/**
@@ -78312,8 +78165,7 @@ declare namespace Excel {
Some printers may not support vertical print quality and the supported values may vary by printer.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
printQuality?: number[];
/**
@@ -78345,48 +78197,42 @@ declare namespace Excel {
* Gets a `HeaderFooterPicture` object that represents the picture for the center section of the footer.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
centerFooterPicture?: Excel.Interfaces.HeaderFooterPictureUpdateData;
/**
* Gets a `HeaderFooterPicture` object that represents the picture for the center section of the header.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
centerHeaderPicture?: Excel.Interfaces.HeaderFooterPictureUpdateData;
/**
* Gets a `HeaderFooterPicture` object that represents the picture for the left section of the footer.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
leftFooterPicture?: Excel.Interfaces.HeaderFooterPictureUpdateData;
/**
* Gets a `HeaderFooterPicture` object that represents the picture for the left section of the header.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
leftHeaderPicture?: Excel.Interfaces.HeaderFooterPictureUpdateData;
/**
* Gets a `HeaderFooterPicture` object that represents the picture for the right section of the footer.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
rightFooterPicture?: Excel.Interfaces.HeaderFooterPictureUpdateData;
/**
* Gets a `HeaderFooterPicture` object that represents the picture for the right section of the header.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
rightHeaderPicture?: Excel.Interfaces.HeaderFooterPictureUpdateData;
/**
@@ -78496,88 +78342,77 @@ declare namespace Excel {
* Specifies the brightness of the picture. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest).
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
brightness?: number;
/**
* Specifies the type of color transformation of the picture.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
colorType?: Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark";
/**
* Specifies the contrast of the picture. The value for this property must be a number from 0.0 (least contrast) to 1.0 (most contrast).
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
contrast?: number;
/**
* Specifies the number of points that are cropped off the bottom of the picture.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
cropBottom?: number;
/**
* Specifies the number of points that are cropped off the left side of the picture.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
cropLeft?: number;
/**
* Specifies the number of points that are cropped off the right side of the picture.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
cropRight?: number;
/**
* Specifies the number of points that are cropped off the top of the picture.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
cropTop?: number;
/**
* Specifies the URL (on the intranet or the web) or path (local or network) to the location where the source object is saved.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
filename?: string;
/**
* Specifies the height of the picture in points.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
height?: number;
/**
* Specifies a value that indicates whether the picture retains its original proportions when resized. `true` if it retains its proportions; otherwise, `false`.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
lockAspectRatio?: boolean;
/**
* Specifies the width of the picture in points.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
width?: number;
}
@@ -78743,56 +78578,49 @@ declare namespace Excel {
* Specifies the brightness of the image. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest).
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
brightness?: number;
/**
* Specifies the type of color transformation applied to the image.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
colorType?: Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark";
/**
* Specifies the contrast of the image. The value for this property must be a number from 0.0 (the least contrast) to 1.0 (the greatest contrast).
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
contrast?: number;
/**
* Specifies the number of points that are cropped off the bottom of the image.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
cropBottom?: number;
/**
* Specifies the number of points that are cropped off the left side of the image.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
cropLeft?: number;
/**
* Specifies the number of points that are cropped off the right side of the image.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
cropRight?: number;
/**
* Specifies the number of points that are cropped off the top of the image.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
cropTop?: number;
}
@@ -79277,16 +79105,14 @@ declare namespace Excel {
* Specifies the active cell in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
activeCell?: Excel.Interfaces.RangeUpdateData;
/**
* Specifies the active sheet in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
activeWorksheet?: Excel.Interfaces.WorksheetUpdateData;
/**
@@ -79301,240 +79127,210 @@ declare namespace Excel {
* Gets the visible range of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
visibleRange?: Excel.Interfaces.RangeUpdateData;
/**
* Specifies whether AutoFilter date grouping is enabled in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
autoFilterDateGroupingEnabled?: boolean;
/**
- * Specifies a value indicating whether panes are frozen in the window.
+ * Specifies whether panes are frozen in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
freezePanes?: boolean;
/**
* Specifies the height of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
height?: number;
/**
- * Specifies the visibility of the window.
+ * Specifies whether the window is visible.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
isVisible?: boolean;
/**
- * Specifies the left position of the window.
+ * Specifies the distance, in points, from the left edge of the computer screen to the left edge of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
left?: number;
/**
* Specifies the name of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
name?: string;
/**
* Specifies the scroll column of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
scrollColumn?: number;
/**
* Specifies the scroll row of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
scrollRow?: number;
/**
- * Specifies the display of formulas in the window.
+ * Specifies whether formulas are shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showFormulas?: boolean;
/**
- * Specifies the display of gridlines in the window.
+ * Specifies whether gridlines are shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showGridlines?: boolean;
/**
- * Specifies the display of headings in the window.
+ * Specifies whether headings are shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showHeadings?: boolean;
/**
- * Specifies the display of the horizontal scroll bar in the window.
+ * Specifies whether the horizontal scroll bar is shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showHorizontalScrollBar?: boolean;
/**
- * Specifies the display of the outline in the window.
+ * Specifies whether outline is shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showOutline?: boolean;
/**
- * Specifies the display of the ruler in the window.
+ * Specifies whether the ruler is shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showRuler?: boolean;
/**
- * Specifies the display of the vertical scroll bar in the window.
+ * Specifies whether the vertical scroll bar is shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showVerticalScrollBar?: boolean;
/**
- * Specifies the display of whitespace in the window.
+ * Specifies whether whitespace is shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showWhitespace?: boolean;
/**
- * Specifies the display of workbook tabs in the window.
+ * Specifies whether workbook tabs are shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showWorkbookTabs?: boolean;
/**
- * Specifies the display of zeros in the window.
+ * Specifies whether zeroes are shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showZeros?: boolean;
/**
* Specifies the split state of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
split?: boolean;
/**
* Specifies the split column of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
splitColumn?: number;
/**
* Specifies the horizontal split of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
splitHorizontal?: number;
/**
* Specifies the split row of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
splitRow?: number;
/**
* Specifies the vertical split of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
splitVertical?: number;
/**
* Specifies the tab ratio of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
tabRatio?: number;
/**
- * Specifies the top position of the window.
+ * Specifies the distance, in points, from the top edge of the window to the top edge of the usable area (below the menus, any toolbars docked at the top, and the formula bar).
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
top?: number;
/**
* Specifies the view of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
view?: Excel.WindowView | "normalView" | "pageBreakPreview" | "pageLayoutView";
/**
- * Returns or sets an integer value that represents the display size of the window. It can be set to a percentage between 10 and 400.
+ * Specifies the display width of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
width?: number;
/**
- * Returns or sets an integer value that represents the display size of the window. It can be set to a percentage between 10 and 400.
+ * Specifies the window state.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
windowState?: Excel.WindowState | "maximized" | "minimized" | "normal";
/**
* Specifies an integer value that represents the display size of the window. It can be set to a percentage between 10 and 400.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
zoom?: number;
}
@@ -79854,8 +79650,7 @@ declare namespace Excel {
* Returns a `window` object that represents the active window (the window on top). Read-only.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
activeWindow?: Excel.Interfaces.WindowData;
/**
@@ -79875,11 +79670,10 @@ declare namespace Excel {
*/
iterativeCalculation?: Excel.Interfaces.IterativeCalculationData;
/**
- * Returns the all windows of Excel application.
+ * Returns all the open Excel windows.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
windows?: Excel.Interfaces.WindowData[];
/**
@@ -80502,8 +80296,7 @@ declare namespace Excel {
* Specifies the array formula of a range. If the specified range doesn't contain an array formula, this property returns `null`.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
formulaArray?: string;
/**
@@ -85555,8 +85348,7 @@ declare namespace Excel {
* Specifies whether Excel aligns the header and the footer with the margins set in the page setup options.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
alignMarginsHeaderFooter?: boolean;
/**
@@ -85677,8 +85469,7 @@ declare namespace Excel {
Some printers may not support vertical print quality and the supported values may vary by printer.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
printQuality?: number[];
/**
@@ -85710,48 +85501,42 @@ declare namespace Excel {
* Gets a `HeaderFooterPicture` object that represents the picture for the center section of the footer.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
centerFooterPicture?: Excel.Interfaces.HeaderFooterPictureData;
/**
* Gets a `HeaderFooterPicture` object that represents the picture for the center section of the header.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
centerHeaderPicture?: Excel.Interfaces.HeaderFooterPictureData;
/**
* Gets a `HeaderFooterPicture` object that represents the picture for the left section of the footer.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
leftFooterPicture?: Excel.Interfaces.HeaderFooterPictureData;
/**
* Gets a `HeaderFooterPicture` object that represents the picture for the left section of the header.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
leftHeaderPicture?: Excel.Interfaces.HeaderFooterPictureData;
/**
* Gets a `HeaderFooterPicture` object that represents the picture for the right section of the footer.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
rightFooterPicture?: Excel.Interfaces.HeaderFooterPictureData;
/**
* Gets a `HeaderFooterPicture` object that represents the picture for the right section of the header.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
rightHeaderPicture?: Excel.Interfaces.HeaderFooterPictureData;
/**
@@ -85861,88 +85646,77 @@ declare namespace Excel {
* Specifies the brightness of the picture. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest).
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
brightness?: number;
/**
* Specifies the type of color transformation of the picture.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
colorType?: Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark";
/**
* Specifies the contrast of the picture. The value for this property must be a number from 0.0 (least contrast) to 1.0 (most contrast).
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
contrast?: number;
/**
* Specifies the number of points that are cropped off the bottom of the picture.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
cropBottom?: number;
/**
* Specifies the number of points that are cropped off the left side of the picture.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
cropLeft?: number;
/**
* Specifies the number of points that are cropped off the right side of the picture.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
cropRight?: number;
/**
* Specifies the number of points that are cropped off the top of the picture.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
cropTop?: number;
/**
* Specifies the URL (on the intranet or the web) or path (local or network) to the location where the source object is saved.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
filename?: string;
/**
* Specifies the height of the picture in points.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
height?: number;
/**
* Specifies a value that indicates whether the picture retains its original proportions when resized. `true` if it retains its proportions; otherwise, `false`.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
lockAspectRatio?: boolean;
/**
* Specifies the width of the picture in points.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
width?: number;
}
@@ -86291,56 +86065,49 @@ declare namespace Excel {
* Specifies the brightness of the image. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest).
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
brightness?: number;
/**
* Specifies the type of color transformation applied to the image.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
colorType?: Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark";
/**
* Specifies the contrast of the image. The value for this property must be a number from 0.0 (the least contrast) to 1.0 (the greatest contrast).
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
contrast?: number;
/**
* Specifies the number of points that are cropped off the bottom of the image.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
cropBottom?: number;
/**
* Specifies the number of points that are cropped off the left side of the image.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
cropLeft?: number;
/**
* Specifies the number of points that are cropped off the right side of the image.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
cropRight?: number;
/**
* Specifies the number of points that are cropped off the top of the image.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
cropTop?: number;
/**
@@ -87036,32 +86803,28 @@ declare namespace Excel {
* Specifies the active cell in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
activeCell?: Excel.Interfaces.RangeData;
/**
* Specifies the active pane in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
activePane?: Excel.Interfaces.PaneData;
/**
* Specifies the active sheet in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
activeWorksheet?: Excel.Interfaces.WorksheetData;
/**
- * Gets the panes associated with the window.
+ * Gets a collection of panes associated with the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
panes?: Excel.Interfaces.PaneData[];
/**
@@ -87076,296 +86839,259 @@ declare namespace Excel {
* Gets the visible range of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
visibleRange?: Excel.Interfaces.RangeData;
/**
* Specifies whether AutoFilter date grouping is enabled in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
autoFilterDateGroupingEnabled?: boolean;
/**
- * Specifies a value indicating whether resizing is enabled for the window.
+ * Specifies whether resizing is enabled for the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
enableResize?: boolean;
/**
- * Specifies a value indicating whether panes are frozen in the window.
+ * Specifies whether panes are frozen in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
freezePanes?: boolean;
/**
* Specifies the height of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
height?: number;
/**
* Gets the index of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
index?: number;
/**
- * Specifies the visibility of the window.
+ * Specifies whether the window is visible.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
isVisible?: boolean;
/**
- * Specifies the left position of the window.
+ * Specifies the distance, in points, from the left edge of the computer screen to the left edge of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
left?: number;
/**
* Specifies the name of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
name?: string;
/**
* Specifies the scroll column of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
scrollColumn?: number;
/**
* Specifies the scroll row of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
scrollRow?: number;
/**
- * Specifies the display of formulas in the window.
+ * Specifies whether formulas are shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showFormulas?: boolean;
/**
- * Specifies the display of gridlines in the window.
+ * Specifies whether gridlines are shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showGridlines?: boolean;
/**
- * Specifies the display of headings in the window.
+ * Specifies whether headings are shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showHeadings?: boolean;
/**
- * Specifies the display of the horizontal scroll bar in the window.
+ * Specifies whether the horizontal scroll bar is shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showHorizontalScrollBar?: boolean;
/**
- * Specifies the display of the outline in the window.
+ * Specifies whether outline is shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showOutline?: boolean;
/**
- * Specifies the display of the right-to-left layout in the window.
+ * Gets the right-to-left layout value of the window. True means that the window is using right-to-left layout, false means that the window is using left-to-right layout.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showRightToLeft?: boolean;
/**
- * Specifies the display of the ruler in the window.
+ * Specifies whether the ruler is shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showRuler?: boolean;
/**
- * Specifies the display of the vertical scroll bar in the window.
+ * Specifies whether the vertical scroll bar is shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showVerticalScrollBar?: boolean;
/**
- * Specifies the display of whitespace in the window.
+ * Specifies whether whitespace is shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showWhitespace?: boolean;
/**
- * Specifies the display of workbook tabs in the window.
+ * Specifies whether workbook tabs are shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showWorkbookTabs?: boolean;
/**
- * Specifies the display of zeros in the window.
+ * Specifies whether zeroes are shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showZeros?: boolean;
/**
* Specifies the split state of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
split?: boolean;
/**
* Specifies the split column of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
splitColumn?: number;
/**
* Specifies the horizontal split of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
splitHorizontal?: number;
/**
* Specifies the split row of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
splitRow?: number;
/**
* Specifies the vertical split of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
splitVertical?: number;
/**
* Specifies the tab ratio of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
tabRatio?: number;
/**
- * Specifies the top position of the window.
+ * Specifies the distance, in points, from the top edge of the window to the top edge of the usable area (below the menus, any toolbars docked at the top, and the formula bar).
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
top?: number;
/**
* Specifies the type of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
type?: Excel.WindowType | "chartAsWindow" | "chartInPlace" | "clipboard" | "workbook";
/**
* Specifies the usable height of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
usableHeight?: number;
/**
* Specifies the usable width of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
usableWidth?: number;
/**
* Specifies the view of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
view?: Excel.WindowView | "normalView" | "pageBreakPreview" | "pageLayoutView";
/**
- * Returns or sets an integer value that represents the display size of the window. It can be set to a percentage between 10 and 400.
+ * Specifies the display width of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
width?: number;
/**
* Specifies the window number.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
windowNumber?: number;
/**
- * Returns or sets an integer value that represents the display size of the window. It can be set to a percentage between 10 and 400.
+ * Specifies the window state.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
windowState?: Excel.WindowState | "maximized" | "minimized" | "normal";
/**
* Specifies an integer value that represents the display size of the window. It can be set to a percentage between 10 and 400.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
zoom?: number;
}
@@ -87379,8 +87105,7 @@ declare namespace Excel {
* Returns index of the pane.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
index?: number;
}
@@ -88097,8 +87822,7 @@ declare namespace Excel {
* Returns a `window` object that represents the active window (the window on top).
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
activeWindow?: Excel.Interfaces.WindowLoadOptions;
/**
@@ -88774,8 +88498,7 @@ declare namespace Excel {
* Specifies the array formula of a range. If the specified range doesn't contain an array formula, this property returns `null`.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
formulaArray?: boolean;
/**
@@ -97001,8 +96724,7 @@ declare namespace Excel {
* Specifies whether Excel aligns the header and the footer with the margins set in the page setup options.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
alignMarginsHeaderFooter?: boolean;
/**
@@ -97123,8 +96845,7 @@ declare namespace Excel {
Some printers may not support vertical print quality and the supported values may vary by printer.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
printQuality?: boolean;
/**
@@ -97163,48 +96884,42 @@ declare namespace Excel {
* Gets a `HeaderFooterPicture` object that represents the picture for the center section of the footer.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
centerFooterPicture?: Excel.Interfaces.HeaderFooterPictureLoadOptions;
/**
* Gets a `HeaderFooterPicture` object that represents the picture for the center section of the header.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
centerHeaderPicture?: Excel.Interfaces.HeaderFooterPictureLoadOptions;
/**
* Gets a `HeaderFooterPicture` object that represents the picture for the left section of the footer.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
leftFooterPicture?: Excel.Interfaces.HeaderFooterPictureLoadOptions;
/**
* Gets a `HeaderFooterPicture` object that represents the picture for the left section of the header.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
leftHeaderPicture?: Excel.Interfaces.HeaderFooterPictureLoadOptions;
/**
* Gets a `HeaderFooterPicture` object that represents the picture for the right section of the footer.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
rightFooterPicture?: Excel.Interfaces.HeaderFooterPictureLoadOptions;
/**
* Gets a `HeaderFooterPicture` object that represents the picture for the right section of the header.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
rightHeaderPicture?: Excel.Interfaces.HeaderFooterPictureLoadOptions;
/**
@@ -97319,8 +97034,7 @@ declare namespace Excel {
* Represents a picture in the header or footer of a worksheet.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
interface HeaderFooterPictureLoadOptions {
/**
@@ -97331,88 +97045,77 @@ declare namespace Excel {
* Specifies the brightness of the picture. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest).
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
brightness?: boolean;
/**
* Specifies the type of color transformation of the picture.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
colorType?: boolean;
/**
* Specifies the contrast of the picture. The value for this property must be a number from 0.0 (least contrast) to 1.0 (most contrast).
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
contrast?: boolean;
/**
* Specifies the number of points that are cropped off the bottom of the picture.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
cropBottom?: boolean;
/**
* Specifies the number of points that are cropped off the left side of the picture.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
cropLeft?: boolean;
/**
* Specifies the number of points that are cropped off the right side of the picture.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
cropRight?: boolean;
/**
* Specifies the number of points that are cropped off the top of the picture.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
cropTop?: boolean;
/**
* Specifies the URL (on the intranet or the web) or path (local or network) to the location where the source object is saved.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
filename?: boolean;
/**
* Specifies the height of the picture in points.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
height?: boolean;
/**
* Specifies a value that indicates whether the picture retains its original proportions when resized. `true` if it retains its proportions; otherwise, `false`.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
lockAspectRatio?: boolean;
/**
* Specifies the width of the picture in points.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
width?: boolean;
}
@@ -97548,8 +97251,7 @@ declare namespace Excel {
* For EACH ITEM in the collection: Specifies the array formula of a range. If the specified range doesn't contain an array formula, this property returns `null`.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
formulaArray?: boolean;
/**
@@ -98581,56 +98283,49 @@ declare namespace Excel {
* Specifies the brightness of the image. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest).
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
brightness?: boolean;
/**
* Specifies the type of color transformation applied to the image.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
colorType?: boolean;
/**
* Specifies the contrast of the image. The value for this property must be a number from 0.0 (the least contrast) to 1.0 (the greatest contrast).
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
contrast?: boolean;
/**
* Specifies the number of points that are cropped off the bottom of the image.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
cropBottom?: boolean;
/**
* Specifies the number of points that are cropped off the left side of the image.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
cropLeft?: boolean;
/**
* Specifies the number of points that are cropped off the right side of the image.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
cropRight?: boolean;
/**
* Specifies the number of points that are cropped off the top of the image.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
cropTop?: boolean;
/**
@@ -99922,8 +99617,7 @@ declare namespace Excel {
* Represents a window in the workbook.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
interface WindowLoadOptions {
/**
@@ -99934,24 +99628,21 @@ declare namespace Excel {
* Specifies the active cell in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
activeCell?: Excel.Interfaces.RangeLoadOptions;
/**
* Specifies the active pane in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
activePane?: Excel.Interfaces.PaneLoadOptions;
/**
* Specifies the active sheet in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
activeWorksheet?: Excel.Interfaces.WorksheetLoadOptions;
/**
@@ -99966,305 +99657,267 @@ declare namespace Excel {
* Gets the visible range of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
visibleRange?: Excel.Interfaces.RangeLoadOptions;
/**
* Specifies whether AutoFilter date grouping is enabled in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
autoFilterDateGroupingEnabled?: boolean;
/**
- * Specifies a value indicating whether resizing is enabled for the window.
+ * Specifies whether resizing is enabled for the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
enableResize?: boolean;
/**
- * Specifies a value indicating whether panes are frozen in the window.
+ * Specifies whether panes are frozen in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
freezePanes?: boolean;
/**
* Specifies the height of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
height?: boolean;
/**
* Gets the index of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
index?: boolean;
/**
- * Specifies the visibility of the window.
+ * Specifies whether the window is visible.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
isVisible?: boolean;
/**
- * Specifies the left position of the window.
+ * Specifies the distance, in points, from the left edge of the computer screen to the left edge of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
left?: boolean;
/**
* Specifies the name of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
name?: boolean;
/**
* Specifies the scroll column of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
scrollColumn?: boolean;
/**
* Specifies the scroll row of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
scrollRow?: boolean;
/**
- * Specifies the display of formulas in the window.
+ * Specifies whether formulas are shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showFormulas?: boolean;
/**
- * Specifies the display of gridlines in the window.
+ * Specifies whether gridlines are shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showGridlines?: boolean;
/**
- * Specifies the display of headings in the window.
+ * Specifies whether headings are shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showHeadings?: boolean;
/**
- * Specifies the display of the horizontal scroll bar in the window.
+ * Specifies whether the horizontal scroll bar is shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showHorizontalScrollBar?: boolean;
/**
- * Specifies the display of the outline in the window.
+ * Specifies whether outline is shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showOutline?: boolean;
/**
- * Specifies the display of the right-to-left layout in the window.
+ * Gets the right-to-left layout value of the window. True means that the window is using right-to-left layout, false means that the window is using left-to-right layout.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showRightToLeft?: boolean;
/**
- * Specifies the display of the ruler in the window.
+ * Specifies whether the ruler is shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showRuler?: boolean;
/**
- * Specifies the display of the vertical scroll bar in the window.
+ * Specifies whether the vertical scroll bar is shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showVerticalScrollBar?: boolean;
/**
- * Specifies the display of whitespace in the window.
+ * Specifies whether whitespace is shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showWhitespace?: boolean;
/**
- * Specifies the display of workbook tabs in the window.
+ * Specifies whether workbook tabs are shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showWorkbookTabs?: boolean;
/**
- * Specifies the display of zeros in the window.
+ * Specifies whether zeroes are shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showZeros?: boolean;
/**
* Specifies the split state of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
split?: boolean;
/**
* Specifies the split column of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
splitColumn?: boolean;
/**
* Specifies the horizontal split of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
splitHorizontal?: boolean;
/**
* Specifies the split row of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
splitRow?: boolean;
/**
* Specifies the vertical split of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
splitVertical?: boolean;
/**
* Specifies the tab ratio of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
tabRatio?: boolean;
/**
- * Specifies the top position of the window.
+ * Specifies the distance, in points, from the top edge of the window to the top edge of the usable area (below the menus, any toolbars docked at the top, and the formula bar).
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
top?: boolean;
/**
* Specifies the type of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
type?: boolean;
/**
* Specifies the usable height of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
usableHeight?: boolean;
/**
* Specifies the usable width of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
usableWidth?: boolean;
/**
* Specifies the view of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
view?: boolean;
/**
- * Returns or sets an integer value that represents the display size of the window. It can be set to a percentage between 10 and 400.
+ * Specifies the display width of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
width?: boolean;
/**
* Specifies the window number.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
windowNumber?: boolean;
/**
- * Returns or sets an integer value that represents the display size of the window. It can be set to a percentage between 10 and 400.
+ * Specifies the window state.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
windowState?: boolean;
/**
* Specifies an integer value that represents the display size of the window. It can be set to a percentage between 10 and 400.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
zoom?: boolean;
}
/**
- * Represents the collection of all Window objects.
+ * Represents a collection of Window objects.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
interface WindowCollectionLoadOptions {
/**
@@ -100275,24 +99928,21 @@ declare namespace Excel {
* For EACH ITEM in the collection: Specifies the active cell in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
activeCell?: Excel.Interfaces.RangeLoadOptions;
/**
* For EACH ITEM in the collection: Specifies the active pane in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
activePane?: Excel.Interfaces.PaneLoadOptions;
/**
* For EACH ITEM in the collection: Specifies the active sheet in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
activeWorksheet?: Excel.Interfaces.WorksheetLoadOptions;
/**
@@ -100307,296 +99957,259 @@ declare namespace Excel {
* For EACH ITEM in the collection: Gets the visible range of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
visibleRange?: Excel.Interfaces.RangeLoadOptions;
/**
* For EACH ITEM in the collection: Specifies whether AutoFilter date grouping is enabled in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
autoFilterDateGroupingEnabled?: boolean;
/**
- * For EACH ITEM in the collection: Specifies a value indicating whether resizing is enabled for the window.
+ * For EACH ITEM in the collection: Specifies whether resizing is enabled for the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
enableResize?: boolean;
/**
- * For EACH ITEM in the collection: Specifies a value indicating whether panes are frozen in the window.
+ * For EACH ITEM in the collection: Specifies whether panes are frozen in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
freezePanes?: boolean;
/**
* For EACH ITEM in the collection: Specifies the height of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
height?: boolean;
/**
* For EACH ITEM in the collection: Gets the index of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
index?: boolean;
/**
- * For EACH ITEM in the collection: Specifies the visibility of the window.
+ * For EACH ITEM in the collection: Specifies whether the window is visible.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
isVisible?: boolean;
/**
- * For EACH ITEM in the collection: Specifies the left position of the window.
+ * For EACH ITEM in the collection: Specifies the distance, in points, from the left edge of the computer screen to the left edge of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
left?: boolean;
/**
* For EACH ITEM in the collection: Specifies the name of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
name?: boolean;
/**
* For EACH ITEM in the collection: Specifies the scroll column of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
scrollColumn?: boolean;
/**
* For EACH ITEM in the collection: Specifies the scroll row of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
scrollRow?: boolean;
/**
- * For EACH ITEM in the collection: Specifies the display of formulas in the window.
+ * For EACH ITEM in the collection: Specifies whether formulas are shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showFormulas?: boolean;
/**
- * For EACH ITEM in the collection: Specifies the display of gridlines in the window.
+ * For EACH ITEM in the collection: Specifies whether gridlines are shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showGridlines?: boolean;
/**
- * For EACH ITEM in the collection: Specifies the display of headings in the window.
+ * For EACH ITEM in the collection: Specifies whether headings are shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showHeadings?: boolean;
/**
- * For EACH ITEM in the collection: Specifies the display of the horizontal scroll bar in the window.
+ * For EACH ITEM in the collection: Specifies whether the horizontal scroll bar is shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showHorizontalScrollBar?: boolean;
/**
- * For EACH ITEM in the collection: Specifies the display of the outline in the window.
+ * For EACH ITEM in the collection: Specifies whether outline is shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showOutline?: boolean;
/**
- * For EACH ITEM in the collection: Specifies the display of the right-to-left layout in the window.
+ * For EACH ITEM in the collection: Gets the right-to-left layout value of the window. True means that the window is using right-to-left layout, false means that the window is using left-to-right layout.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showRightToLeft?: boolean;
/**
- * For EACH ITEM in the collection: Specifies the display of the ruler in the window.
+ * For EACH ITEM in the collection: Specifies whether the ruler is shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showRuler?: boolean;
/**
- * For EACH ITEM in the collection: Specifies the display of the vertical scroll bar in the window.
+ * For EACH ITEM in the collection: Specifies whether the vertical scroll bar is shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showVerticalScrollBar?: boolean;
/**
- * For EACH ITEM in the collection: Specifies the display of whitespace in the window.
+ * For EACH ITEM in the collection: Specifies whether whitespace is shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showWhitespace?: boolean;
/**
- * For EACH ITEM in the collection: Specifies the display of workbook tabs in the window.
+ * For EACH ITEM in the collection: Specifies whether workbook tabs are shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showWorkbookTabs?: boolean;
/**
- * For EACH ITEM in the collection: Specifies the display of zeros in the window.
+ * For EACH ITEM in the collection: Specifies whether zeroes are shown in the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
showZeros?: boolean;
/**
* For EACH ITEM in the collection: Specifies the split state of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
split?: boolean;
/**
* For EACH ITEM in the collection: Specifies the split column of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
splitColumn?: boolean;
/**
* For EACH ITEM in the collection: Specifies the horizontal split of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
splitHorizontal?: boolean;
/**
* For EACH ITEM in the collection: Specifies the split row of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
splitRow?: boolean;
/**
* For EACH ITEM in the collection: Specifies the vertical split of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
splitVertical?: boolean;
/**
* For EACH ITEM in the collection: Specifies the tab ratio of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
tabRatio?: boolean;
/**
- * For EACH ITEM in the collection: Specifies the top position of the window.
+ * For EACH ITEM in the collection: Specifies the distance, in points, from the top edge of the window to the top edge of the usable area (below the menus, any toolbars docked at the top, and the formula bar).
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
top?: boolean;
/**
* For EACH ITEM in the collection: Specifies the type of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
type?: boolean;
/**
* For EACH ITEM in the collection: Specifies the usable height of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
usableHeight?: boolean;
/**
* For EACH ITEM in the collection: Specifies the usable width of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
usableWidth?: boolean;
/**
* For EACH ITEM in the collection: Specifies the view of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
view?: boolean;
/**
- * For EACH ITEM in the collection: Returns or sets an integer value that represents the display size of the window. It can be set to a percentage between 10 and 400.
+ * For EACH ITEM in the collection: Specifies the display width of the window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
width?: boolean;
/**
* For EACH ITEM in the collection: Specifies the window number.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
windowNumber?: boolean;
/**
- * For EACH ITEM in the collection: Returns or sets an integer value that represents the display size of the window. It can be set to a percentage between 10 and 400.
+ * For EACH ITEM in the collection: Specifies the window state.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
windowState?: boolean;
/**
* For EACH ITEM in the collection: Specifies an integer value that represents the display size of the window. It can be set to a percentage between 10 and 400.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
zoom?: boolean;
}
@@ -100604,8 +100217,7 @@ declare namespace Excel {
* Represents a pane, such as a frozen or split pane, in an Excel window.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
interface PaneLoadOptions {
/**
@@ -100616,17 +100228,15 @@ declare namespace Excel {
* Returns index of the pane.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
index?: boolean;
}
/**
- * Represents the collection of all Pane objects that are part of the workbook.
+ * Represents a collection of Pane objects.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
interface PaneCollectionLoadOptions {
/**
@@ -100637,8 +100247,7 @@ declare namespace Excel {
* For EACH ITEM in the collection: Returns index of the pane.
*
* @remarks
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: ExcelApiDesktop 1.1]
*/
index?: boolean;
}
diff --git a/types/office-js/index.d.ts b/types/office-js/index.d.ts
index 4312260ba402cb..1526351ee07e1d 100644
--- a/types/office-js/index.d.ts
+++ b/types/office-js/index.d.ts
@@ -35270,6 +35270,13 @@ 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;
+ /**
+ * Returns a `window` object that represents the active window (the window on top). Read-only.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ readonly activeWindow: Excel.Window;
/**
* Provides information based on current system culture settings. This includes the culture names, number formatting, and other culturally dependent settings.
*
@@ -35286,6 +35293,13 @@ declare namespace Excel {
* [Api set: ExcelApi 1.9]
*/
readonly iterativeCalculation: Excel.IterativeCalculation;
+ /**
+ * Returns all the open Excel windows.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ readonly windows: Excel.WindowCollection;
/**
* Returns the Excel calculation engine version used for the last full recalculation.
*
@@ -35355,6 +35369,24 @@ declare namespace Excel {
* @param calculationType Specifies the calculation type to use. See `Excel.CalculationType` for details.
*/
calculate(calculationType: "Recalculate" | "Full" | "FullRebuild"): void;
+ /**
+ * Checks the spelling of a single word. Returns `true` if the word is spelled correctly, otherwise returns `false`.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ *
+ * @param word The word that you want to check.
+ * @param options Optional. The options for checking spelling.
+ */
+ checkSpelling(word: string, options?: Excel.CheckSpellingOptions): OfficeExtension.ClientResult;
+ /**
+ * Enters editing mode for the selected range in the active worksheet.
+ This method is equivalent to using "F2" when selecting a cell or range in the Excel UI.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ enterEditingMode(): void;
/**
* Suspends calculation until the next `context.sync()` is called. Once set, it is the developer's responsibility to re-calc the workbook, to ensure that any dependencies are propagated.
*
@@ -35371,6 +35403,19 @@ declare namespace Excel {
* [Api set: ExcelApi 1.9]
*/
suspendScreenUpdatingUntilNextSync(): void;
+ /**
+ * Returns a `RangeAreas` object that represents the union of two or more `Range` or `RangeAreas` objects.
+ The input `Range` or `RangeAreas` objects must be from the same worksheet.
+ The maximum number of parameters is 30, including the first two.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ *
+ * @param firstRange The first `Range` or `RangeAreas` object.
+ * @param secondRange The second `Range` or `RangeAreas` object.
+ * @param additionalRanges Optional. Additional `Range` or `RangeAreas` objects to include in the union, up to 28 more.
+ */
+ union(firstRange: Range | RangeAreas, secondRange: Range | RangeAreas, ...additionalRanges: (Range | RangeAreas)[]): Excel.RangeAreas;
/**
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
*
@@ -35719,6 +35764,14 @@ declare namespace Excel {
* @param closeBehavior workbook close behavior.
*/
close(closeBehavior?: "Save" | "SkipSave"): void;
+ /**
+ * Sets focus on the workbook. This will cause the grid or the currently active object
+ to receive keyboard events.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ focus(): void;
/**
* Gets the currently active cell from the workbook.
*
@@ -36217,6 +36270,22 @@ declare namespace Excel {
* @param markAllDirty True, to mark all as dirty.
*/
calculate(markAllDirty: boolean): void;
+ /**
+ * Checks the spelling of words in this worksheet. This method opens the Spelling dialog box in the Excel UI.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ *
+ * @param options Optional. The options for checking spelling.
+ */
+ checkSpelling(options?: Excel.CheckSpellingOptions): void;
+ /**
+ * Clears the tracer arrows from the worksheet.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ clearArrows(): void;
/**
* Copies a worksheet and places it at the specified position.
*
@@ -36246,6 +36315,15 @@ declare namespace Excel {
* [Api set: ExcelApi 1.1]
*/
delete(): void;
+ /**
+ * Returns the evaluation result of a formula string. Only formula input is supported. If the formula name is invalid, the `InvalidArgument` error is thrown.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ *
+ * @param name The name of the formula to run.
+ */
+ evaluate(name: string): OfficeExtension.ClientResult;
/**
* Finds all occurrences of the given string based on the criteria specified and returns them as a `RangeAreas` object, comprising one or more rectangular ranges.
*
@@ -36553,6 +36631,28 @@ declare namespace Excel {
*/
toJSON(): Excel.Interfaces.WorksheetData;
}
+ /**
+ * Represents the options for checking spelling.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ interface CheckSpellingOptions {
+ /**
+ * Optional. A string that indicates the file name of the custom dictionary to be examined if the word isn't found in the main dictionary. If this argument is omitted, Excel's currently specified dictionary is used.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ customDictionary?: string;
+ /**
+ * Optional. Set to `true` to ignore words that are all uppercase. Set to `false` to check words that are all uppercase. If this argument is omitted, Excel's current setting is used.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ ignoreUppercase?: boolean;
+ }
/**
* Represents a collection of worksheet objects that are part of the workbook.
*
@@ -37266,6 +37366,13 @@ declare namespace Excel {
* [Api set: ExcelApi 1.18]
*/
control: CellControl;
+ /**
+ * Specifies the array formula of a range. If the specified range doesn't contain an array formula, this property returns `null`.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ formulaArray: string;
/**
* Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead.
*
@@ -37504,6 +37611,15 @@ declare namespace Excel {
* [Api set: ExcelApi 1.6]
*/
calculate(): void;
+ /**
+ * Checks the spelling of words in this range. This method opens the Spelling dialog box in the Excel UI.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ *
+ * @param options Optional. The options for checking spelling.
+ */
+ checkSpelling(options?: Excel.CheckSpellingOptions): void;
/**
* Clear range values and formatting, such as fill and border.
*
@@ -37751,7 +37867,7 @@ declare namespace Excel {
*/
getEntireRow(): Excel.Range;
/**
- * Returns a range object that includes the current range and up to the edge of the range, based on the provided direction. This matches the Ctrl+Shift+Arrow key behavior in the Excel on Windows UI.
+ * Returns a range object that includes the current range and up to the edge of the range, based on the provided direction. This matches the Ctrl+Shift+Arrow key behavior in the Excel on Windows UI.
*
* @remarks
* [Api set: ExcelApi 1.13]
@@ -37761,7 +37877,7 @@ declare namespace Excel {
*/
getExtendedRange(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range;
/**
- * Returns a range object that includes the current range and up to the edge of the range, based on the provided direction. This matches the Ctrl+Shift+Arrow key behavior in the Excel on Windows UI.
+ * Returns a range object that includes the current range and up to the edge of the range, based on the provided direction. This matches the Ctrl+Shift+Arrow key behavior in the Excel on Windows UI.
*
* @remarks
* [Api set: ExcelApi 1.13]
@@ -37856,7 +37972,7 @@ declare namespace Excel {
*/
getPrecedents(): Excel.WorkbookRangeAreas;
/**
- * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI.
+ * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI.
*
* @remarks
* [Api set: ExcelApi 1.13]
@@ -37866,7 +37982,7 @@ declare namespace Excel {
*/
getRangeEdge(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range;
/**
- * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI.
+ * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI.
*
* @remarks
* [Api set: ExcelApi 1.13]
@@ -38193,6 +38309,15 @@ declare namespace Excel {
* [Api set: ExcelApi 1.7]
*/
showCard(): void;
+ /**
+ * Draws tracer arrows to the direct dependents of the range.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ *
+ * @param remove Optional. Set to `true` to remove one level of tracer arrows to direct dependents. Set to `false` to expand one level of tracer arrows. The default value is `false`.
+ */
+ showDependents(remove?: boolean): void;
/**
* Shows the details of the row or column group.
*
@@ -38211,6 +38336,15 @@ declare namespace Excel {
* @param groupOption Specifies whether to show the details of grouped rows or grouped columns.
*/
showGroupDetails(groupOption: "ByRows" | "ByColumns"): void;
+ /**
+ * Draws tracer arrows to the direct precedents of the range.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ *
+ * @param remove Optional. Set to `true` to remove one level of tracer arrows to direct precedents. Set to `false` to expand one level of tracer arrows. The default value is `false`.
+ */
+ showPrecedents(remove?: boolean): void;
/**
* Ungroups columns and rows for an outline.
*
@@ -52951,6 +53085,13 @@ declare namespace Excel {
* [Api set: ExcelApi 1.9]
*/
readonly headersFooters: Excel.HeaderFooterGroup;
+ /**
+ * Specifies whether Excel aligns the header and the footer with the margins set in the page setup options.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ alignMarginsHeaderFooter: boolean;
/**
* The worksheet's black and white print option.
*
@@ -53063,6 +53204,15 @@ declare namespace Excel {
* [Api set: ExcelApi 1.9]
*/
printOrder: Excel.PrintOrder | "DownThenOver" | "OverThenDown";
+ /**
+ * Specifies a two-element array that contains both horizontal and vertical print quality values.
+ The first element is the horizontal print quality, and the second element is the vertical print quality.
+ Some printers may not support vertical print quality and the supported values may vary by printer.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ printQuality: number[];
/**
* The worksheet's right margin, in points, for use when printing.
*
@@ -53301,6 +53451,48 @@ 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;
+ /**
+ * Gets a `HeaderFooterPicture` object that represents the picture for the center section of the footer.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ readonly centerFooterPicture: Excel.HeaderFooterPicture;
+ /**
+ * Gets a `HeaderFooterPicture` object that represents the picture for the center section of the header.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ readonly centerHeaderPicture: Excel.HeaderFooterPicture;
+ /**
+ * Gets a `HeaderFooterPicture` object that represents the picture for the left section of the footer.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ readonly leftFooterPicture: Excel.HeaderFooterPicture;
+ /**
+ * Gets a `HeaderFooterPicture` object that represents the picture for the left section of the header.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ readonly leftHeaderPicture: Excel.HeaderFooterPicture;
+ /**
+ * Gets a `HeaderFooterPicture` object that represents the picture for the right section of the footer.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ readonly rightFooterPicture: Excel.HeaderFooterPicture;
+ /**
+ * Gets a `HeaderFooterPicture` object that represents the picture for the right section of the header.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ readonly rightHeaderPicture: Excel.HeaderFooterPicture;
/**
* The center footer of the worksheet.
To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx.
@@ -53475,6 +53667,165 @@ declare namespace Excel {
*/
toJSON(): Excel.Interfaces.HeaderFooterGroupData;
}
+ /**
+ * Represents a picture in the header or footer of a worksheet.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ class HeaderFooterPicture extends OfficeExtension.ClientObject {
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
+ context: RequestContext;
+ /**
+ * Specifies the brightness of the picture. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest).
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ brightness: number;
+ /**
+ * Specifies the type of color transformation of the picture.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ colorType: Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark";
+ /**
+ * Specifies the contrast of the picture. The value for this property must be a number from 0.0 (least contrast) to 1.0 (most contrast).
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ contrast: number;
+ /**
+ * Specifies the number of points that are cropped off the bottom of the picture.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ cropBottom: number;
+ /**
+ * Specifies the number of points that are cropped off the left side of the picture.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ cropLeft: number;
+ /**
+ * Specifies the number of points that are cropped off the right side of the picture.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ cropRight: number;
+ /**
+ * Specifies the number of points that are cropped off the top of the picture.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ cropTop: number;
+ /**
+ * Specifies the URL (on the intranet or the web) or path (local or network) to the location where the source object is saved.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ filename: string;
+ /**
+ * Specifies the height of the picture in points.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ height: number;
+ /**
+ * Specifies a value that indicates whether the picture retains its original proportions when resized. `true` if it retains its proportions; otherwise, `false`.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ lockAspectRatio: boolean;
+ /**
+ * Specifies the width of the picture in points.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ width: number;
+ /**
+ * 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.
+ * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
+ * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
+ */
+ set(properties: Interfaces.HeaderFooterPictureUpdateData, options?: OfficeExtension.UpdateOptions): void;
+ /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
+ set(properties: Excel.HeaderFooterPicture): 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(options?: Excel.Interfaces.HeaderFooterPictureLoadOptions): Excel.HeaderFooterPicture;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+ *
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
+ */
+ load(propertyNames?: string | string[]): Excel.HeaderFooterPicture;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+ *
+ * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited 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.HeaderFooterPicture;
+ /**
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
+ * Whereas the original `Excel.HeaderFooterPicture` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.HeaderFooterPictureData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): Excel.Interfaces.HeaderFooterPictureData;
+ }
+ /**
+ * Specifies the color transformation of a picture in the header or footer of a worksheet.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ enum PictureColorType {
+ /**
+ * Mixed transformation.
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ mixed = "Mixed",
+ /**
+ * Default color transformation.
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ automatic = "Automatic",
+ /**
+ * Grayscale transformation.
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ grayScale = "GrayScale",
+ /**
+ * Black-and-white transformation.
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ blackAndWhite = "BlackAndWhite",
+ /**
+ * Watermark transformation.
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ watermark = "Watermark"
+ }
/**
* @remarks
* [Api set: ExcelApi 1.9]
@@ -54865,6 +55216,55 @@ declare namespace Excel {
* [Api set: ExcelApi 1.9]
*/
readonly shape: Excel.Shape;
+ /**
+ * Specifies the brightness of the image. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest).
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ brightness: number;
+ /**
+ * Specifies the type of color transformation applied to the image.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ colorType: Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark";
+ /**
+ * Specifies the contrast of the image. The value for this property must be a number from 0.0 (the least contrast) to 1.0 (the greatest contrast).
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ contrast: number;
+ /**
+ * Specifies the number of points that are cropped off the bottom of the image.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ cropBottom: number;
+ /**
+ * Specifies the number of points that are cropped off the left side of the image.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ cropLeft: number;
+ /**
+ * Specifies the number of points that are cropped off the right side of the image.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ cropRight: number;
+ /**
+ * Specifies the number of points that are cropped off the top of the image.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ cropTop: number;
/**
* Specifies the shape identifier for the image object.
*
@@ -54879,6 +55279,32 @@ declare namespace Excel {
* [Api set: ExcelApi 1.9]
*/
readonly format: Excel.PictureFormat | "UNKNOWN" | "BMP" | "JPEG" | "GIF" | "PNG" | "SVG";
+ /**
+ * 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.
+ * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
+ * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
+ */
+ set(properties: Interfaces.ImageUpdateData, options?: OfficeExtension.UpdateOptions): void;
+ /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
+ set(properties: Excel.Image): void;
+ /**
+ * Increments the brightness of the image by a specified amount.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ *
+ * @param increment Specifies how much to change the value of the Brightness property for the picture. A positive value makes the picture brighter; a negative value makes the picture darker.
+ */
+ incrementBrightness(increment: number): void;
+ /**
+ * Increments the contrast of the image by a specified amount.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ *
+ * @param increment Specifies how much to change the value of the Contrast property for the picture. A positive value increases the contrast; a negative value decreases the contrast.
+ */
+ incrementContrast(increment: number): void;
/**
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
*
@@ -56267,6 +56693,8 @@ declare namespace Excel {
*
* @remarks
* [Api set: ExcelApi 1.19]
+ *
+ * This property isn't supported in Excel on the web.
*/
source: Excel.EventSource | "Local" | "Remote";
/**
@@ -63930,6 +64358,687 @@ declare namespace Excel {
*/
toJSON(): Excel.Interfaces.NoteData;
}
+ /**
+ * Represents a window in the workbook.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ class Window extends OfficeExtension.ClientObject {
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
+ context: RequestContext;
+ /**
+ * Gets the active cell in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ readonly activeCell: Excel.Range;
+ /**
+ * Gets the active pane in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ readonly activePane: Excel.Pane;
+ /**
+ * Gets the active worksheet in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ readonly activeWorksheet: Excel.Worksheet;
+ /**
+ * Gets a collection of panes associated with the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ readonly panes: Excel.PaneCollection;
+ /**
+ * Gets the visible range of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ readonly visibleRange: Excel.Range;
+ /**
+ * Specifies whether AutoFilter date grouping is enabled in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ autoFilterDateGroupingEnabled: boolean;
+ /**
+ * Specifies whether resizing is enabled for the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ readonly enableResize: boolean;
+ /**
+ * Specifies whether panes are frozen in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ freezePanes: boolean;
+ /**
+ * Specifies the height of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ height: number;
+ /**
+ * Gets the index of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ readonly index: number;
+ /**
+ * Specifies whether the window is visible.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ isVisible: boolean;
+ /**
+ * Specifies the distance, in points, from the left edge of the computer screen to the left edge of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ left: number;
+ /**
+ * Specifies the name of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ name: string;
+ /**
+ * Specifies the scroll column of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ scrollColumn: number;
+ /**
+ * Specifies the scroll row of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ scrollRow: number;
+ /**
+ * Specifies whether formulas are shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showFormulas: boolean;
+ /**
+ * Specifies whether gridlines are shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showGridlines: boolean;
+ /**
+ * Specifies whether headings are shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showHeadings: boolean;
+ /**
+ * Specifies whether the horizontal scroll bar is shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showHorizontalScrollBar: boolean;
+ /**
+ * Specifies whether outline is shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showOutline: boolean;
+ /**
+ * Gets the right-to-left layout value of the window. True means that the window is using right-to-left layout, false means that the window is using left-to-right layout.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ readonly showRightToLeft: boolean;
+ /**
+ * Specifies whether the ruler is shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showRuler: boolean;
+ /**
+ * Specifies whether the vertical scroll bar is shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showVerticalScrollBar: boolean;
+ /**
+ * Specifies whether whitespace is shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showWhitespace: boolean;
+ /**
+ * Specifies whether workbook tabs are shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showWorkbookTabs: boolean;
+ /**
+ * Specifies whether zeroes are shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showZeros: boolean;
+ /**
+ * Specifies the split state of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ split: boolean;
+ /**
+ * Specifies the split column of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ splitColumn: number;
+ /**
+ * Specifies the horizontal split of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ splitHorizontal: number;
+ /**
+ * Specifies the split row of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ splitRow: number;
+ /**
+ * Specifies the vertical split of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ splitVertical: number;
+ /**
+ * Specifies the tab ratio of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ tabRatio: number;
+ /**
+ * Specifies the distance, in points, from the top edge of the window to the top edge of the usable area (below the menus, any toolbars docked at the top, and the formula bar).
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ top: number;
+ /**
+ * Specifies the type of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ readonly type: Excel.WindowType | "chartAsWindow" | "chartInPlace" | "clipboard" | "workbook";
+ /**
+ * Gets the usable height of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ readonly usableHeight: number;
+ /**
+ * Gets the usable width of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ readonly usableWidth: number;
+ /**
+ * Specifies the view of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ view: Excel.WindowView | "normalView" | "pageBreakPreview" | "pageLayoutView";
+ /**
+ * Specifies the display width of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ width: number;
+ /**
+ * Gets the window number.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ readonly windowNumber: number;
+ /**
+ * Specifies the window state.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ windowState: Excel.WindowState | "maximized" | "minimized" | "normal";
+ /**
+ * Specifies an integer value that represents the display size of the window. It can be set to a percentage between 10 and 400.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ zoom: number;
+ /**
+ * 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.
+ * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
+ * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
+ */
+ set(properties: Interfaces.WindowUpdateData, options?: OfficeExtension.UpdateOptions): void;
+ /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
+ set(properties: Excel.Window): void;
+ /**
+ * Activates the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ activate(): void;
+ /**
+ * Activates the next window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ activateNext(): void;
+ /**
+ * Activates the previous window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ activatePrevious(): void;
+ /**
+ * Closes the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ close(): OfficeExtension.ClientResult;
+ /**
+ * Scrolls the window by multiple pages. The `down`, `up`, `toRight`, and `toLeft` parameters correspond to the action of scrolling with Page Down, Page Up, Alt+Page Down, and Alt+Page Up keys on the keyboard.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ largeScroll(Down: number, Up: number, ToRight: number, ToLeft: number): void;
+ /**
+ * Opens a new Excel window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ newWindow(): Excel.Window;
+ /**
+ * Converts horizontal points to screen pixels.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ pointsToScreenPixelsX(Points: number): OfficeExtension.ClientResult;
+ /**
+ * Converts vertical points to screen pixels.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ pointsToScreenPixelsY(Points: number): OfficeExtension.ClientResult;
+ /**
+ * Scrolls the window to bring the specified range into view.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ scrollIntoView(Left: number, Top: number, Width: number, Height: number, Start?: boolean): void;
+ /**
+ * Scrolls the workbook tabs.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ scrollWorkbookTabs(Sheets?: number, Position?: Excel.ScrollWorkbookTabPosition): void;
+ /**
+ * Scrolls the workbook tabs.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ scrollWorkbookTabs(Sheets?: number, Position?: "First" | "Last"): void;
+ /**
+ * Scrolls the window by a number of rows or columns. The `down`, `up`, `toRight`, and `toLeft` parameters correspond to the action of scrolling with arrow keys on the keyboard.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ smallScroll(Down: number, Up: number, ToRight: number, ToLeft: number): 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(options?: Excel.Interfaces.WindowLoadOptions): Excel.Window;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+ *
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
+ */
+ load(propertyNames?: string | string[]): Excel.Window;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+ *
+ * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited 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.Window;
+ /**
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
+ * Whereas the original `Excel.Window` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.WindowData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): Excel.Interfaces.WindowData;
+ }
+ /**
+ * Specifies the display state of a window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ enum WindowState {
+ /**
+ * The window is maximized to fill the entire screen.
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ maximized = "maximized",
+ /**
+ * The window is minimized and collapsed to the taskbar.
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ minimized = "minimized",
+ /**
+ * The window is displayed in normal size and can be moved or resized.
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ normal = "normal"
+ }
+ /**
+ * Specifies the view mode of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ enum WindowView {
+ /**
+ * The window displays the worksheet in normal view for general data entry and editing.
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ normalView = "normalView",
+ /**
+ * The window displays the worksheet in Page Break Preview mode to show where pages will break when printed.
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ pageBreakPreview = "pageBreakPreview",
+ /**
+ * The window displays the worksheet in Page Layout view to show how the worksheet will look when printed.
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ pageLayoutView = "pageLayoutView"
+ }
+ /**
+ * Specifies the type of window being displayed.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ enum WindowType {
+ /**
+ * The window displays a chart in its own separate window.
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ chartAsWindow = "chartAsWindow",
+ /**
+ * The window displays a chart embedded within a worksheet.
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ chartInPlace = "chartInPlace",
+ /**
+ * The window displays the Office clipboard contents.
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ clipboard = "clipboard",
+ /**
+ * The window displays a standard Excel workbook.
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ workbook = "workbook"
+ }
+ /**
+ * Enum representing the scroll position for workbook tab navigation.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ enum ScrollWorkbookTabPosition {
+ /**
+ * Scrolls the tab menu to show the first worksheet tab.
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ first = "First",
+ /**
+ * Scrolls the tab menu to show the last worksheet tab.
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ last = "Last"
+ }
+ /**
+ * Represents a collection of Window objects.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ class WindowCollection extends OfficeExtension.ClientObject {
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
+ context: RequestContext;
+ /** Gets the loaded child items in this collection. */
+ readonly items: Excel.Window[];
+ /**
+ * Breaks the side-by-side view of windows.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ breakSideBySide(): void;
+ /**
+ * Compares the current window side by side with the specified window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ compareCurrentSideBySideWith(windowName: string): void;
+ /**
+ * Gets the number of windows in the collection.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ getCount(): OfficeExtension.ClientResult;
+ /**
+ * Gets the Window in the collection by index.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ getItemAt(index: number): Excel.Window;
+ /**
+ * Resets the positions of windows in side-by-side view.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ resetPositionsSideBySide(): 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(options?: Excel.Interfaces.WindowCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.WindowCollection;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+ *
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
+ */
+ load(propertyNames?: string | string[]): Excel.WindowCollection;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+ *
+ * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited 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.WindowCollection;
+ /**
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
+ * Whereas the original `Excel.WindowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.WindowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
+ */
+ toJSON(): Excel.Interfaces.WindowCollectionData;
+ }
+ /**
+ * Represents a pane, such as a frozen or split pane, in an Excel window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ class Pane extends OfficeExtension.ClientObject {
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
+ context: RequestContext;
+ /**
+ * Returns index of the pane.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ readonly index: number;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+ *
+ * @param options Provides options for which properties of the object to load.
+ */
+ load(options?: Excel.Interfaces.PaneLoadOptions): Excel.Pane;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+ *
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
+ */
+ load(propertyNames?: string | string[]): Excel.Pane;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+ *
+ * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited 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.Pane;
+ /**
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
+ * Whereas the original `Excel.Pane` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.PaneData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): Excel.Interfaces.PaneData;
+ }
+ /**
+ * Represents a collection of Pane objects.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ class PaneCollection extends OfficeExtension.ClientObject {
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
+ context: RequestContext;
+ /** Gets the loaded child items in this collection. */
+ readonly items: Excel.Pane[];
+ /**
+ * Returns the number of panes in the collection.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ getCount(): OfficeExtension.ClientResult;
+ /**
+ * Gets the pane in the collection by index.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ getItemAt(index: number): Excel.Pane;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+ *
+ * @param options Provides options for which properties of the object to load.
+ */
+ load(options?: Excel.Interfaces.PaneCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PaneCollection;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+ *
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
+ */
+ load(propertyNames?: string | string[]): Excel.PaneCollection;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+ *
+ * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited 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.PaneCollection;
+ /**
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
+ * Whereas the original `Excel.PaneCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.PaneCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
+ */
+ toJSON(): Excel.Interfaces.PaneCollectionData;
+ }
/**
* An object containing the result of a function-evaluation operation
*
@@ -67835,6 +68944,13 @@ declare namespace Excel {
}
/** An interface for updating data on the `Application` object, for use in `application.set({ ... })`. */
interface ApplicationUpdateData {
+ /**
+ * Returns a `window` object that represents the active window (the window on top).
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ activeWindow?: Excel.Interfaces.WindowUpdateData;
/**
* Returns the iterative calculation settings.
In Excel on Windows and Mac, the settings will apply to the Excel Application.
@@ -68022,6 +69138,13 @@ declare namespace Excel {
* [Api set: ExcelApi 1.18]
*/
control?: CellControl;
+ /**
+ * Specifies the array formula of a range. If the specified range doesn't contain an array formula, this property returns `null`.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ formulaArray?: string;
/**
* Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead.
*
@@ -71987,6 +73110,13 @@ declare namespace Excel {
* [Api set: ExcelApi 1.9]
*/
headersFooters?: Excel.Interfaces.HeaderFooterGroupUpdateData;
+ /**
+ * Specifies whether Excel aligns the header and the footer with the margins set in the page setup options.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ alignMarginsHeaderFooter?: boolean;
/**
* The worksheet's black and white print option.
*
@@ -72099,6 +73229,15 @@ declare namespace Excel {
* [Api set: ExcelApi 1.9]
*/
printOrder?: Excel.PrintOrder | "DownThenOver" | "OverThenDown";
+ /**
+ * Specifies a two-element array that contains both horizontal and vertical print quality values.
+ The first element is the horizontal print quality, and the second element is the vertical print quality.
+ Some printers may not support vertical print quality and the supported values may vary by printer.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ printQuality?: number[];
/**
* The worksheet's right margin, in points, for use when printing.
*
@@ -72124,6 +73263,48 @@ declare namespace Excel {
}
/** An interface for updating data on the `HeaderFooter` object, for use in `headerFooter.set({ ... })`. */
interface HeaderFooterUpdateData {
+ /**
+ * Gets a `HeaderFooterPicture` object that represents the picture for the center section of the footer.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ centerFooterPicture?: Excel.Interfaces.HeaderFooterPictureUpdateData;
+ /**
+ * Gets a `HeaderFooterPicture` object that represents the picture for the center section of the header.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ centerHeaderPicture?: Excel.Interfaces.HeaderFooterPictureUpdateData;
+ /**
+ * Gets a `HeaderFooterPicture` object that represents the picture for the left section of the footer.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ leftFooterPicture?: Excel.Interfaces.HeaderFooterPictureUpdateData;
+ /**
+ * Gets a `HeaderFooterPicture` object that represents the picture for the left section of the header.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ leftHeaderPicture?: Excel.Interfaces.HeaderFooterPictureUpdateData;
+ /**
+ * Gets a `HeaderFooterPicture` object that represents the picture for the right section of the footer.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ rightFooterPicture?: Excel.Interfaces.HeaderFooterPictureUpdateData;
+ /**
+ * Gets a `HeaderFooterPicture` object that represents the picture for the right section of the header.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ rightHeaderPicture?: Excel.Interfaces.HeaderFooterPictureUpdateData;
/**
* The center footer of the worksheet.
To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx.
@@ -72225,6 +73406,86 @@ declare namespace Excel {
*/
useSheetScale?: boolean;
}
+ /** An interface for updating data on the `HeaderFooterPicture` object, for use in `headerFooterPicture.set({ ... })`. */
+ interface HeaderFooterPictureUpdateData {
+ /**
+ * Specifies the brightness of the picture. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest).
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ brightness?: number;
+ /**
+ * Specifies the type of color transformation of the picture.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ colorType?: Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark";
+ /**
+ * Specifies the contrast of the picture. The value for this property must be a number from 0.0 (least contrast) to 1.0 (most contrast).
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ contrast?: number;
+ /**
+ * Specifies the number of points that are cropped off the bottom of the picture.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ cropBottom?: number;
+ /**
+ * Specifies the number of points that are cropped off the left side of the picture.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ cropLeft?: number;
+ /**
+ * Specifies the number of points that are cropped off the right side of the picture.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ cropRight?: number;
+ /**
+ * Specifies the number of points that are cropped off the top of the picture.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ cropTop?: number;
+ /**
+ * Specifies the URL (on the intranet or the web) or path (local or network) to the location where the source object is saved.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ filename?: string;
+ /**
+ * Specifies the height of the picture in points.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ height?: number;
+ /**
+ * Specifies a value that indicates whether the picture retains its original proportions when resized. `true` if it retains its proportions; otherwise, `false`.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ lockAspectRatio?: boolean;
+ /**
+ * Specifies the width of the picture in points.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ width?: number;
+ }
/** An interface for updating data on the `PageBreakCollection` object, for use in `pageBreakCollection.set({ ... })`. */
interface PageBreakCollectionUpdateData {
items?: Excel.Interfaces.PageBreakData[];
@@ -72381,6 +73642,58 @@ declare namespace Excel {
*/
width?: number;
}
+ /** An interface for updating data on the `Image` object, for use in `image.set({ ... })`. */
+ interface ImageUpdateData {
+ /**
+ * Specifies the brightness of the image. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest).
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ brightness?: number;
+ /**
+ * Specifies the type of color transformation applied to the image.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ colorType?: Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark";
+ /**
+ * Specifies the contrast of the image. The value for this property must be a number from 0.0 (the least contrast) to 1.0 (the greatest contrast).
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ contrast?: number;
+ /**
+ * Specifies the number of points that are cropped off the bottom of the image.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ cropBottom?: number;
+ /**
+ * Specifies the number of points that are cropped off the left side of the image.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ cropLeft?: number;
+ /**
+ * Specifies the number of points that are cropped off the right side of the image.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ cropRight?: number;
+ /**
+ * Specifies the number of points that are cropped off the top of the image.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ cropTop?: number;
+ }
/** An interface for updating data on the `GroupShapeCollection` object, for use in `groupShapeCollection.set({ ... })`. */
interface GroupShapeCollectionUpdateData {
items?: Excel.Interfaces.ShapeData[];
@@ -72799,6 +74112,241 @@ declare namespace Excel {
*/
width?: number;
}
+ /** An interface for updating data on the `Window` object, for use in `window.set({ ... })`. */
+ interface WindowUpdateData {
+ /**
+ * Gets the active cell in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ activeCell?: Excel.Interfaces.RangeUpdateData;
+ /**
+ * Gets the active worksheet in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ activeWorksheet?: Excel.Interfaces.WorksheetUpdateData;
+ /**
+ * Gets the visible range of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ visibleRange?: Excel.Interfaces.RangeUpdateData;
+ /**
+ * Specifies whether AutoFilter date grouping is enabled in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ autoFilterDateGroupingEnabled?: boolean;
+ /**
+ * Specifies whether panes are frozen in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ freezePanes?: boolean;
+ /**
+ * Specifies the height of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ height?: number;
+ /**
+ * Specifies whether the window is visible.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ isVisible?: boolean;
+ /**
+ * Specifies the distance, in points, from the left edge of the computer screen to the left edge of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ left?: number;
+ /**
+ * Specifies the name of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ name?: string;
+ /**
+ * Specifies the scroll column of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ scrollColumn?: number;
+ /**
+ * Specifies the scroll row of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ scrollRow?: number;
+ /**
+ * Specifies whether formulas are shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showFormulas?: boolean;
+ /**
+ * Specifies whether gridlines are shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showGridlines?: boolean;
+ /**
+ * Specifies whether headings are shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showHeadings?: boolean;
+ /**
+ * Specifies whether the horizontal scroll bar is shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showHorizontalScrollBar?: boolean;
+ /**
+ * Specifies whether outline is shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showOutline?: boolean;
+ /**
+ * Specifies whether the ruler is shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showRuler?: boolean;
+ /**
+ * Specifies whether the vertical scroll bar is shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showVerticalScrollBar?: boolean;
+ /**
+ * Specifies whether whitespace is shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showWhitespace?: boolean;
+ /**
+ * Specifies whether workbook tabs are shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showWorkbookTabs?: boolean;
+ /**
+ * Specifies whether zeroes are shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showZeros?: boolean;
+ /**
+ * Specifies the split state of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ split?: boolean;
+ /**
+ * Specifies the split column of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ splitColumn?: number;
+ /**
+ * Specifies the horizontal split of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ splitHorizontal?: number;
+ /**
+ * Specifies the split row of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ splitRow?: number;
+ /**
+ * Specifies the vertical split of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ splitVertical?: number;
+ /**
+ * Specifies the tab ratio of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ tabRatio?: number;
+ /**
+ * Specifies the distance, in points, from the top edge of the window to the top edge of the usable area (below the menus, any toolbars docked at the top, and the formula bar).
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ top?: number;
+ /**
+ * Specifies the view of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ view?: Excel.WindowView | "normalView" | "pageBreakPreview" | "pageLayoutView";
+ /**
+ * Specifies the display width of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ width?: number;
+ /**
+ * Specifies the window state.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ windowState?: Excel.WindowState | "maximized" | "minimized" | "normal";
+ /**
+ * Specifies an integer value that represents the display size of the window. It can be set to a percentage between 10 and 400.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ zoom?: number;
+ }
+ /** An interface for updating data on the `WindowCollection` object, for use in `windowCollection.set({ ... })`. */
+ interface WindowCollectionUpdateData {
+ items?: Excel.Interfaces.WindowData[];
+ }
+ /** An interface for updating data on the `PaneCollection` object, for use in `paneCollection.set({ ... })`. */
+ interface PaneCollectionUpdateData {
+ items?: Excel.Interfaces.PaneData[];
+ }
/** An interface describing the data returned by calling `allowEditRange.toJSON()`. */
interface AllowEditRangeData {
/**
@@ -72909,6 +74457,13 @@ declare namespace Excel {
}
/** An interface describing the data returned by calling `application.toJSON()`. */
interface ApplicationData {
+ /**
+ * Returns a `window` object that represents the active window (the window on top). Read-only.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ activeWindow?: Excel.Interfaces.WindowData;
/**
* Provides information based on current system culture settings. This includes the culture names, number formatting, and other culturally dependent settings.
*
@@ -72925,6 +74480,13 @@ declare namespace Excel {
* [Api set: ExcelApi 1.9]
*/
iterativeCalculation?: Excel.Interfaces.IterativeCalculationData;
+ /**
+ * Returns all the open Excel windows.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ windows?: Excel.Interfaces.WindowData[];
/**
* Returns the Excel calculation engine version used for the last full recalculation.
*
@@ -73507,6 +75069,13 @@ declare namespace Excel {
* [Api set: ExcelApi 1.18]
*/
control?: CellControl;
+ /**
+ * Specifies the array formula of a range. If the specified range doesn't contain an array formula, this property returns `null`.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ formulaArray?: string;
/**
* Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead.
*
@@ -78480,6 +80049,13 @@ declare namespace Excel {
* [Api set: ExcelApi 1.9]
*/
headersFooters?: Excel.Interfaces.HeaderFooterGroupData;
+ /**
+ * Specifies whether Excel aligns the header and the footer with the margins set in the page setup options.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ alignMarginsHeaderFooter?: boolean;
/**
* The worksheet's black and white print option.
*
@@ -78592,6 +80168,15 @@ declare namespace Excel {
* [Api set: ExcelApi 1.9]
*/
printOrder?: Excel.PrintOrder | "DownThenOver" | "OverThenDown";
+ /**
+ * Specifies a two-element array that contains both horizontal and vertical print quality values.
+ The first element is the horizontal print quality, and the second element is the vertical print quality.
+ Some printers may not support vertical print quality and the supported values may vary by printer.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ printQuality?: number[];
/**
* The worksheet's right margin, in points, for use when printing.
*
@@ -78617,6 +80202,48 @@ declare namespace Excel {
}
/** An interface describing the data returned by calling `headerFooter.toJSON()`. */
interface HeaderFooterData {
+ /**
+ * Gets a `HeaderFooterPicture` object that represents the picture for the center section of the footer.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ centerFooterPicture?: Excel.Interfaces.HeaderFooterPictureData;
+ /**
+ * Gets a `HeaderFooterPicture` object that represents the picture for the center section of the header.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ centerHeaderPicture?: Excel.Interfaces.HeaderFooterPictureData;
+ /**
+ * Gets a `HeaderFooterPicture` object that represents the picture for the left section of the footer.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ leftFooterPicture?: Excel.Interfaces.HeaderFooterPictureData;
+ /**
+ * Gets a `HeaderFooterPicture` object that represents the picture for the left section of the header.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ leftHeaderPicture?: Excel.Interfaces.HeaderFooterPictureData;
+ /**
+ * Gets a `HeaderFooterPicture` object that represents the picture for the right section of the footer.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ rightFooterPicture?: Excel.Interfaces.HeaderFooterPictureData;
+ /**
+ * Gets a `HeaderFooterPicture` object that represents the picture for the right section of the header.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ rightHeaderPicture?: Excel.Interfaces.HeaderFooterPictureData;
/**
* The center footer of the worksheet.
To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx.
@@ -78718,6 +80345,86 @@ declare namespace Excel {
*/
useSheetScale?: boolean;
}
+ /** An interface describing the data returned by calling `headerFooterPicture.toJSON()`. */
+ interface HeaderFooterPictureData {
+ /**
+ * Specifies the brightness of the picture. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest).
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ brightness?: number;
+ /**
+ * Specifies the type of color transformation of the picture.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ colorType?: Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark";
+ /**
+ * Specifies the contrast of the picture. The value for this property must be a number from 0.0 (least contrast) to 1.0 (most contrast).
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ contrast?: number;
+ /**
+ * Specifies the number of points that are cropped off the bottom of the picture.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ cropBottom?: number;
+ /**
+ * Specifies the number of points that are cropped off the left side of the picture.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ cropLeft?: number;
+ /**
+ * Specifies the number of points that are cropped off the right side of the picture.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ cropRight?: number;
+ /**
+ * Specifies the number of points that are cropped off the top of the picture.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ cropTop?: number;
+ /**
+ * Specifies the URL (on the intranet or the web) or path (local or network) to the location where the source object is saved.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ filename?: string;
+ /**
+ * Specifies the height of the picture in points.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ height?: number;
+ /**
+ * Specifies a value that indicates whether the picture retains its original proportions when resized. `true` if it retains its proportions; otherwise, `false`.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ lockAspectRatio?: boolean;
+ /**
+ * Specifies the width of the picture in points.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ width?: number;
+ }
/** An interface describing the data returned by calling `pageBreak.toJSON()`. */
interface PageBreakData {
/**
@@ -79059,6 +80766,55 @@ declare namespace Excel {
}
/** An interface describing the data returned by calling `image.toJSON()`. */
interface ImageData {
+ /**
+ * Specifies the brightness of the image. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest).
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ brightness?: number;
+ /**
+ * Specifies the type of color transformation applied to the image.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ colorType?: Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark";
+ /**
+ * Specifies the contrast of the image. The value for this property must be a number from 0.0 (the least contrast) to 1.0 (the greatest contrast).
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ contrast?: number;
+ /**
+ * Specifies the number of points that are cropped off the bottom of the image.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ cropBottom?: number;
+ /**
+ * Specifies the number of points that are cropped off the left side of the image.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ cropLeft?: number;
+ /**
+ * Specifies the number of points that are cropped off the right side of the image.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ cropRight?: number;
+ /**
+ * Specifies the number of points that are cropped off the top of the image.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ cropTop?: number;
/**
* Specifies the shape identifier for the image object.
*
@@ -79673,6 +81429,314 @@ declare namespace Excel {
*/
width?: number;
}
+ /** An interface describing the data returned by calling `window.toJSON()`. */
+ interface WindowData {
+ /**
+ * Gets the active cell in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ activeCell?: Excel.Interfaces.RangeData;
+ /**
+ * Gets the active pane in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ activePane?: Excel.Interfaces.PaneData;
+ /**
+ * Gets the active worksheet in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ activeWorksheet?: Excel.Interfaces.WorksheetData;
+ /**
+ * Gets a collection of panes associated with the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ panes?: Excel.Interfaces.PaneData[];
+ /**
+ * Gets the visible range of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ visibleRange?: Excel.Interfaces.RangeData;
+ /**
+ * Specifies whether AutoFilter date grouping is enabled in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ autoFilterDateGroupingEnabled?: boolean;
+ /**
+ * Specifies whether resizing is enabled for the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ enableResize?: boolean;
+ /**
+ * Specifies whether panes are frozen in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ freezePanes?: boolean;
+ /**
+ * Specifies the height of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ height?: number;
+ /**
+ * Gets the index of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ index?: number;
+ /**
+ * Specifies whether the window is visible.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ isVisible?: boolean;
+ /**
+ * Specifies the distance, in points, from the left edge of the computer screen to the left edge of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ left?: number;
+ /**
+ * Specifies the name of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ name?: string;
+ /**
+ * Specifies the scroll column of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ scrollColumn?: number;
+ /**
+ * Specifies the scroll row of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ scrollRow?: number;
+ /**
+ * Specifies whether formulas are shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showFormulas?: boolean;
+ /**
+ * Specifies whether gridlines are shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showGridlines?: boolean;
+ /**
+ * Specifies whether headings are shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showHeadings?: boolean;
+ /**
+ * Specifies whether the horizontal scroll bar is shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showHorizontalScrollBar?: boolean;
+ /**
+ * Specifies whether outline is shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showOutline?: boolean;
+ /**
+ * Gets the right-to-left layout value of the window. True means that the window is using right-to-left layout, false means that the window is using left-to-right layout.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showRightToLeft?: boolean;
+ /**
+ * Specifies whether the ruler is shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showRuler?: boolean;
+ /**
+ * Specifies whether the vertical scroll bar is shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showVerticalScrollBar?: boolean;
+ /**
+ * Specifies whether whitespace is shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showWhitespace?: boolean;
+ /**
+ * Specifies whether workbook tabs are shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showWorkbookTabs?: boolean;
+ /**
+ * Specifies whether zeroes are shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showZeros?: boolean;
+ /**
+ * Specifies the split state of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ split?: boolean;
+ /**
+ * Specifies the split column of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ splitColumn?: number;
+ /**
+ * Specifies the horizontal split of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ splitHorizontal?: number;
+ /**
+ * Specifies the split row of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ splitRow?: number;
+ /**
+ * Specifies the vertical split of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ splitVertical?: number;
+ /**
+ * Specifies the tab ratio of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ tabRatio?: number;
+ /**
+ * Specifies the distance, in points, from the top edge of the window to the top edge of the usable area (below the menus, any toolbars docked at the top, and the formula bar).
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ top?: number;
+ /**
+ * Specifies the type of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ type?: Excel.WindowType | "chartAsWindow" | "chartInPlace" | "clipboard" | "workbook";
+ /**
+ * Gets the usable height of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ usableHeight?: number;
+ /**
+ * Gets the usable width of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ usableWidth?: number;
+ /**
+ * Specifies the view of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ view?: Excel.WindowView | "normalView" | "pageBreakPreview" | "pageLayoutView";
+ /**
+ * Specifies the display width of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ width?: number;
+ /**
+ * Gets the window number.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ windowNumber?: number;
+ /**
+ * Specifies the window state.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ windowState?: Excel.WindowState | "maximized" | "minimized" | "normal";
+ /**
+ * Specifies an integer value that represents the display size of the window. It can be set to a percentage between 10 and 400.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ zoom?: number;
+ }
+ /** An interface describing the data returned by calling `windowCollection.toJSON()`. */
+ interface WindowCollectionData {
+ items?: Excel.Interfaces.WindowData[];
+ }
+ /** An interface describing the data returned by calling `pane.toJSON()`. */
+ interface PaneData {
+ /**
+ * Returns index of the pane.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ index?: number;
+ }
+ /** An interface describing the data returned by calling `paneCollection.toJSON()`. */
+ interface PaneCollectionData {
+ items?: Excel.Interfaces.PaneData[];
+ }
/** An interface describing the data returned by calling `functionResult.toJSON()`. */
interface FunctionResultData {
/**
@@ -79951,6 +82015,13 @@ declare namespace Excel {
*/
$all?: boolean;
/**
+ * Returns a `window` object that represents the active window (the window on top).
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ activeWindow?: Excel.Interfaces.WindowLoadOptions;
+ /**
* Provides information based on current system culture settings. This includes the culture names, number formatting, and other culturally dependent settings.
*
* @remarks
@@ -80585,6 +82656,13 @@ declare namespace Excel {
* [Api set: ExcelApi 1.18]
*/
control?: boolean;
+ /**
+ * Specifies the array formula of a range. If the specified range doesn't contain an array formula, this property returns `null`.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ formulaArray?: boolean;
/**
* Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead.
*
@@ -88620,6 +90698,13 @@ declare namespace Excel {
* [Api set: ExcelApi 1.9]
*/
headersFooters?: Excel.Interfaces.HeaderFooterGroupLoadOptions;
+ /**
+ * Specifies whether Excel aligns the header and the footer with the margins set in the page setup options.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ alignMarginsHeaderFooter?: boolean;
/**
* The worksheet's black and white print option.
*
@@ -88732,6 +90817,15 @@ declare namespace Excel {
* [Api set: ExcelApi 1.9]
*/
printOrder?: boolean;
+ /**
+ * Specifies a two-element array that contains both horizontal and vertical print quality values.
+ The first element is the horizontal print quality, and the second element is the vertical print quality.
+ Some printers may not support vertical print quality and the supported values may vary by printer.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ printQuality?: boolean;
/**
* The worksheet's right margin, in points, for use when printing.
*
@@ -88764,6 +90858,48 @@ declare namespace Excel {
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
*/
$all?: boolean;
+ /**
+ * Gets a `HeaderFooterPicture` object that represents the picture for the center section of the footer.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ centerFooterPicture?: Excel.Interfaces.HeaderFooterPictureLoadOptions;
+ /**
+ * Gets a `HeaderFooterPicture` object that represents the picture for the center section of the header.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ centerHeaderPicture?: Excel.Interfaces.HeaderFooterPictureLoadOptions;
+ /**
+ * Gets a `HeaderFooterPicture` object that represents the picture for the left section of the footer.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ leftFooterPicture?: Excel.Interfaces.HeaderFooterPictureLoadOptions;
+ /**
+ * Gets a `HeaderFooterPicture` object that represents the picture for the left section of the header.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ leftHeaderPicture?: Excel.Interfaces.HeaderFooterPictureLoadOptions;
+ /**
+ * Gets a `HeaderFooterPicture` object that represents the picture for the right section of the footer.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ rightFooterPicture?: Excel.Interfaces.HeaderFooterPictureLoadOptions;
+ /**
+ * Gets a `HeaderFooterPicture` object that represents the picture for the right section of the header.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ rightHeaderPicture?: Excel.Interfaces.HeaderFooterPictureLoadOptions;
/**
* The center footer of the worksheet.
To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx.
@@ -88872,6 +91008,95 @@ declare namespace Excel {
*/
useSheetScale?: boolean;
}
+ /**
+ * Represents a picture in the header or footer of a worksheet.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ interface HeaderFooterPictureLoadOptions {
+ /**
+ Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
+ */
+ $all?: boolean;
+ /**
+ * Specifies the brightness of the picture. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest).
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ brightness?: boolean;
+ /**
+ * Specifies the type of color transformation of the picture.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ colorType?: boolean;
+ /**
+ * Specifies the contrast of the picture. The value for this property must be a number from 0.0 (least contrast) to 1.0 (most contrast).
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ contrast?: boolean;
+ /**
+ * Specifies the number of points that are cropped off the bottom of the picture.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ cropBottom?: boolean;
+ /**
+ * Specifies the number of points that are cropped off the left side of the picture.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ cropLeft?: boolean;
+ /**
+ * Specifies the number of points that are cropped off the right side of the picture.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ cropRight?: boolean;
+ /**
+ * Specifies the number of points that are cropped off the top of the picture.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ cropTop?: boolean;
+ /**
+ * Specifies the URL (on the intranet or the web) or path (local or network) to the location where the source object is saved.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ filename?: boolean;
+ /**
+ * Specifies the height of the picture in points.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ height?: boolean;
+ /**
+ * Specifies a value that indicates whether the picture retains its original proportions when resized. `true` if it retains its proportions; otherwise, `false`.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ lockAspectRatio?: boolean;
+ /**
+ * Specifies the width of the picture in points.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ width?: boolean;
+ }
/**
* @remarks
* [Api set: ExcelApi 1.9]
@@ -89000,6 +91225,13 @@ declare namespace Excel {
* [Api set: ExcelApi 1.18]
*/
control?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies the array formula of a range. If the specified range doesn't contain an array formula, this property returns `null`.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ formulaArray?: boolean;
/**
* For EACH ITEM in the collection: Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead.
*
@@ -90025,6 +92257,55 @@ declare namespace Excel {
* [Api set: ExcelApi 1.9]
*/
shape?: Excel.Interfaces.ShapeLoadOptions;
+ /**
+ * Specifies the brightness of the image. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest).
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ brightness?: boolean;
+ /**
+ * Specifies the type of color transformation applied to the image.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ colorType?: boolean;
+ /**
+ * Specifies the contrast of the image. The value for this property must be a number from 0.0 (the least contrast) to 1.0 (the greatest contrast).
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ contrast?: boolean;
+ /**
+ * Specifies the number of points that are cropped off the bottom of the image.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ cropBottom?: boolean;
+ /**
+ * Specifies the number of points that are cropped off the left side of the image.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ cropLeft?: boolean;
+ /**
+ * Specifies the number of points that are cropped off the right side of the image.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ cropRight?: boolean;
+ /**
+ * Specifies the number of points that are cropped off the top of the image.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ cropTop?: boolean;
/**
* Specifies the shape identifier for the image object.
*
@@ -91279,6 +93560,628 @@ declare namespace Excel {
*/
width?: boolean;
}
+ /**
+ * Represents a window in the workbook.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ interface WindowLoadOptions {
+ /**
+ Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
+ */
+ $all?: boolean;
+ /**
+ * Gets the active cell in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ activeCell?: Excel.Interfaces.RangeLoadOptions;
+ /**
+ * Gets the active pane in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ activePane?: Excel.Interfaces.PaneLoadOptions;
+ /**
+ * Gets the active worksheet in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ activeWorksheet?: Excel.Interfaces.WorksheetLoadOptions;
+ /**
+ * Gets the visible range of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ visibleRange?: Excel.Interfaces.RangeLoadOptions;
+ /**
+ * Specifies whether AutoFilter date grouping is enabled in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ autoFilterDateGroupingEnabled?: boolean;
+ /**
+ * Specifies whether resizing is enabled for the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ enableResize?: boolean;
+ /**
+ * Specifies whether panes are frozen in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ freezePanes?: boolean;
+ /**
+ * Specifies the height of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ height?: boolean;
+ /**
+ * Gets the index of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ index?: boolean;
+ /**
+ * Specifies whether the window is visible.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ isVisible?: boolean;
+ /**
+ * Specifies the distance, in points, from the left edge of the computer screen to the left edge of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ left?: boolean;
+ /**
+ * Specifies the name of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ name?: boolean;
+ /**
+ * Specifies the scroll column of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ scrollColumn?: boolean;
+ /**
+ * Specifies the scroll row of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ scrollRow?: boolean;
+ /**
+ * Specifies whether formulas are shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showFormulas?: boolean;
+ /**
+ * Specifies whether gridlines are shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showGridlines?: boolean;
+ /**
+ * Specifies whether headings are shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showHeadings?: boolean;
+ /**
+ * Specifies whether the horizontal scroll bar is shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showHorizontalScrollBar?: boolean;
+ /**
+ * Specifies whether outline is shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showOutline?: boolean;
+ /**
+ * Gets the right-to-left layout value of the window. True means that the window is using right-to-left layout, false means that the window is using left-to-right layout.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showRightToLeft?: boolean;
+ /**
+ * Specifies whether the ruler is shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showRuler?: boolean;
+ /**
+ * Specifies whether the vertical scroll bar is shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showVerticalScrollBar?: boolean;
+ /**
+ * Specifies whether whitespace is shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showWhitespace?: boolean;
+ /**
+ * Specifies whether workbook tabs are shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showWorkbookTabs?: boolean;
+ /**
+ * Specifies whether zeroes are shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showZeros?: boolean;
+ /**
+ * Specifies the split state of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ split?: boolean;
+ /**
+ * Specifies the split column of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ splitColumn?: boolean;
+ /**
+ * Specifies the horizontal split of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ splitHorizontal?: boolean;
+ /**
+ * Specifies the split row of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ splitRow?: boolean;
+ /**
+ * Specifies the vertical split of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ splitVertical?: boolean;
+ /**
+ * Specifies the tab ratio of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ tabRatio?: boolean;
+ /**
+ * Specifies the distance, in points, from the top edge of the window to the top edge of the usable area (below the menus, any toolbars docked at the top, and the formula bar).
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ top?: boolean;
+ /**
+ * Specifies the type of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ type?: boolean;
+ /**
+ * Gets the usable height of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ usableHeight?: boolean;
+ /**
+ * Gets the usable width of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ usableWidth?: boolean;
+ /**
+ * Specifies the view of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ view?: boolean;
+ /**
+ * Specifies the display width of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ width?: boolean;
+ /**
+ * Gets the window number.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ windowNumber?: boolean;
+ /**
+ * Specifies the window state.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ windowState?: boolean;
+ /**
+ * Specifies an integer value that represents the display size of the window. It can be set to a percentage between 10 and 400.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ zoom?: boolean;
+ }
+ /**
+ * Represents a collection of Window objects.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ interface WindowCollectionLoadOptions {
+ /**
+ Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
+ */
+ $all?: boolean;
+ /**
+ * For EACH ITEM in the collection: Gets the active cell in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ activeCell?: Excel.Interfaces.RangeLoadOptions;
+ /**
+ * For EACH ITEM in the collection: Gets the active pane in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ activePane?: Excel.Interfaces.PaneLoadOptions;
+ /**
+ * For EACH ITEM in the collection: Gets the active worksheet in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ activeWorksheet?: Excel.Interfaces.WorksheetLoadOptions;
+ /**
+ * For EACH ITEM in the collection: Gets the visible range of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ visibleRange?: Excel.Interfaces.RangeLoadOptions;
+ /**
+ * For EACH ITEM in the collection: Specifies whether AutoFilter date grouping is enabled in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ autoFilterDateGroupingEnabled?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies whether resizing is enabled for the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ enableResize?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies whether panes are frozen in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ freezePanes?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies the height of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ height?: boolean;
+ /**
+ * For EACH ITEM in the collection: Gets the index of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ index?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies whether the window is visible.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ isVisible?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies the distance, in points, from the left edge of the computer screen to the left edge of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ left?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies the name of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ name?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies the scroll column of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ scrollColumn?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies the scroll row of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ scrollRow?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies whether formulas are shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showFormulas?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies whether gridlines are shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showGridlines?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies whether headings are shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showHeadings?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies whether the horizontal scroll bar is shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showHorizontalScrollBar?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies whether outline is shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showOutline?: boolean;
+ /**
+ * For EACH ITEM in the collection: Gets the right-to-left layout value of the window. True means that the window is using right-to-left layout, false means that the window is using left-to-right layout.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showRightToLeft?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies whether the ruler is shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showRuler?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies whether the vertical scroll bar is shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showVerticalScrollBar?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies whether whitespace is shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showWhitespace?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies whether workbook tabs are shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showWorkbookTabs?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies whether zeroes are shown in the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ showZeros?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies the split state of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ split?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies the split column of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ splitColumn?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies the horizontal split of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ splitHorizontal?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies the split row of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ splitRow?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies the vertical split of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ splitVertical?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies the tab ratio of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ tabRatio?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies the distance, in points, from the top edge of the window to the top edge of the usable area (below the menus, any toolbars docked at the top, and the formula bar).
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ top?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies the type of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ type?: boolean;
+ /**
+ * For EACH ITEM in the collection: Gets the usable height of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ usableHeight?: boolean;
+ /**
+ * For EACH ITEM in the collection: Gets the usable width of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ usableWidth?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies the view of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ view?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies the display width of the window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ width?: boolean;
+ /**
+ * For EACH ITEM in the collection: Gets the window number.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ windowNumber?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies the window state.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ windowState?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies an integer value that represents the display size of the window. It can be set to a percentage between 10 and 400.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ zoom?: boolean;
+ }
+ /**
+ * Represents a pane, such as a frozen or split pane, in an Excel window.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ interface PaneLoadOptions {
+ /**
+ Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
+ */
+ $all?: boolean;
+ /**
+ * Returns index of the pane.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ index?: boolean;
+ }
+ /**
+ * Represents a collection of Pane objects.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ interface PaneCollectionLoadOptions {
+ /**
+ Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
+ */
+ $all?: boolean;
+ /**
+ * For EACH ITEM in the collection: Returns index of the pane.
+ *
+ * @remarks
+ * [Api set: ExcelApiDesktop 1.1]
+ */
+ index?: boolean;
+ }
/**
* An object containing the result of a function-evaluation operation
*