@types/office-js 1.0.548 → 1.0.549

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
office-js/index.d.ts CHANGED
@@ -35270,6 +35270,13 @@ declare namespace Excel {
35270
35270
  class Application extends OfficeExtension.ClientObject {
35271
35271
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
35272
35272
  context: RequestContext;
35273
+ /**
35274
+ * Returns a `window` object that represents the active window (the window on top). Read-only.
35275
+ *
35276
+ * @remarks
35277
+ * [Api set: ExcelApiDesktop 1.1]
35278
+ */
35279
+ readonly activeWindow: Excel.Window;
35273
35280
  /**
35274
35281
  * Provides information based on current system culture settings. This includes the culture names, number formatting, and other culturally dependent settings.
35275
35282
  *
@@ -35286,6 +35293,13 @@ declare namespace Excel {
35286
35293
  * [Api set: ExcelApi 1.9]
35287
35294
  */
35288
35295
  readonly iterativeCalculation: Excel.IterativeCalculation;
35296
+ /**
35297
+ * Returns all the open Excel windows.
35298
+ *
35299
+ * @remarks
35300
+ * [Api set: ExcelApiDesktop 1.1]
35301
+ */
35302
+ readonly windows: Excel.WindowCollection;
35289
35303
  /**
35290
35304
  * Returns the Excel calculation engine version used for the last full recalculation.
35291
35305
  *
@@ -35355,6 +35369,24 @@ declare namespace Excel {
35355
35369
  * @param calculationType Specifies the calculation type to use. See `Excel.CalculationType` for details.
35356
35370
  */
35357
35371
  calculate(calculationType: "Recalculate" | "Full" | "FullRebuild"): void;
35372
+ /**
35373
+ * Checks the spelling of a single word. Returns `true` if the word is spelled correctly, otherwise returns `false`.
35374
+ *
35375
+ * @remarks
35376
+ * [Api set: ExcelApiDesktop 1.1]
35377
+ *
35378
+ * @param word The word that you want to check.
35379
+ * @param options Optional. The options for checking spelling.
35380
+ */
35381
+ checkSpelling(word: string, options?: Excel.CheckSpellingOptions): OfficeExtension.ClientResult<boolean>;
35382
+ /**
35383
+ * Enters editing mode for the selected range in the active worksheet.
35384
+ This method is equivalent to using "F2" when selecting a cell or range in the Excel UI.
35385
+ *
35386
+ * @remarks
35387
+ * [Api set: ExcelApiDesktop 1.1]
35388
+ */
35389
+ enterEditingMode(): void;
35358
35390
  /**
35359
35391
  * 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.
35360
35392
  *
@@ -35371,6 +35403,19 @@ declare namespace Excel {
35371
35403
  * [Api set: ExcelApi 1.9]
35372
35404
  */
35373
35405
  suspendScreenUpdatingUntilNextSync(): void;
35406
+ /**
35407
+ * Returns a `RangeAreas` object that represents the union of two or more `Range` or `RangeAreas` objects.
35408
+ The input `Range` or `RangeAreas` objects must be from the same worksheet.
35409
+ The maximum number of parameters is 30, including the first two.
35410
+ *
35411
+ * @remarks
35412
+ * [Api set: ExcelApiDesktop 1.1]
35413
+ *
35414
+ * @param firstRange The first `Range` or `RangeAreas` object.
35415
+ * @param secondRange The second `Range` or `RangeAreas` object.
35416
+ * @param additionalRanges Optional. Additional `Range` or `RangeAreas` objects to include in the union, up to 28 more.
35417
+ */
35418
+ union(firstRange: Range | RangeAreas, secondRange: Range | RangeAreas, ...additionalRanges: (Range | RangeAreas)[]): Excel.RangeAreas;
35374
35419
  /**
35375
35420
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
35376
35421
  *
@@ -35719,6 +35764,14 @@ declare namespace Excel {
35719
35764
  * @param closeBehavior workbook close behavior.
35720
35765
  */
35721
35766
  close(closeBehavior?: "Save" | "SkipSave"): void;
35767
+ /**
35768
+ * Sets focus on the workbook. This will cause the grid or the currently active object
35769
+ to receive keyboard events.
35770
+ *
35771
+ * @remarks
35772
+ * [Api set: ExcelApiDesktop 1.1]
35773
+ */
35774
+ focus(): void;
35722
35775
  /**
35723
35776
  * Gets the currently active cell from the workbook.
35724
35777
  *
@@ -36217,6 +36270,22 @@ declare namespace Excel {
36217
36270
  * @param markAllDirty True, to mark all as dirty.
36218
36271
  */
36219
36272
  calculate(markAllDirty: boolean): void;
36273
+ /**
36274
+ * Checks the spelling of words in this worksheet. This method opens the Spelling dialog box in the Excel UI.
36275
+ *
36276
+ * @remarks
36277
+ * [Api set: ExcelApiDesktop 1.1]
36278
+ *
36279
+ * @param options Optional. The options for checking spelling.
36280
+ */
36281
+ checkSpelling(options?: Excel.CheckSpellingOptions): void;
36282
+ /**
36283
+ * Clears the tracer arrows from the worksheet.
36284
+ *
36285
+ * @remarks
36286
+ * [Api set: ExcelApiDesktop 1.1]
36287
+ */
36288
+ clearArrows(): void;
36220
36289
  /**
36221
36290
  * Copies a worksheet and places it at the specified position.
36222
36291
  *
@@ -36246,6 +36315,15 @@ declare namespace Excel {
36246
36315
  * [Api set: ExcelApi 1.1]
36247
36316
  */
36248
36317
  delete(): void;
36318
+ /**
36319
+ * Returns the evaluation result of a formula string. Only formula input is supported. If the formula name is invalid, the `InvalidArgument` error is thrown.
36320
+ *
36321
+ * @remarks
36322
+ * [Api set: ExcelApiDesktop 1.1]
36323
+ *
36324
+ * @param name The name of the formula to run.
36325
+ */
36326
+ evaluate(name: string): OfficeExtension.ClientResult<any>;
36249
36327
  /**
36250
36328
  * 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.
36251
36329
  *
@@ -36553,6 +36631,28 @@ declare namespace Excel {
36553
36631
  */
36554
36632
  toJSON(): Excel.Interfaces.WorksheetData;
36555
36633
  }
36634
+ /**
36635
+ * Represents the options for checking spelling.
36636
+ *
36637
+ * @remarks
36638
+ * [Api set: ExcelApiDesktop 1.1]
36639
+ */
36640
+ interface CheckSpellingOptions {
36641
+ /**
36642
+ * 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.
36643
+ *
36644
+ * @remarks
36645
+ * [Api set: ExcelApiDesktop 1.1]
36646
+ */
36647
+ customDictionary?: string;
36648
+ /**
36649
+ * 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.
36650
+ *
36651
+ * @remarks
36652
+ * [Api set: ExcelApiDesktop 1.1]
36653
+ */
36654
+ ignoreUppercase?: boolean;
36655
+ }
36556
36656
  /**
36557
36657
  * Represents a collection of worksheet objects that are part of the workbook.
36558
36658
  *
@@ -37266,6 +37366,13 @@ declare namespace Excel {
37266
37366
  * [Api set: ExcelApi 1.18]
37267
37367
  */
37268
37368
  control: CellControl;
37369
+ /**
37370
+ * Specifies the array formula of a range. If the specified range doesn't contain an array formula, this property returns `null`.
37371
+ *
37372
+ * @remarks
37373
+ * [Api set: ExcelApiDesktop 1.1]
37374
+ */
37375
+ formulaArray: string;
37269
37376
  /**
37270
37377
  * Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead.
37271
37378
  *
@@ -37504,6 +37611,15 @@ declare namespace Excel {
37504
37611
  * [Api set: ExcelApi 1.6]
37505
37612
  */
37506
37613
  calculate(): void;
37614
+ /**
37615
+ * Checks the spelling of words in this range. This method opens the Spelling dialog box in the Excel UI.
37616
+ *
37617
+ * @remarks
37618
+ * [Api set: ExcelApiDesktop 1.1]
37619
+ *
37620
+ * @param options Optional. The options for checking spelling.
37621
+ */
37622
+ checkSpelling(options?: Excel.CheckSpellingOptions): void;
37507
37623
  /**
37508
37624
  * Clear range values and formatting, such as fill and border.
37509
37625
  *
@@ -37751,7 +37867,7 @@ declare namespace Excel {
37751
37867
  */
37752
37868
  getEntireRow(): Excel.Range;
37753
37869
  /**
37754
- * 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 <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Arrow key</kbd> behavior in the Excel on Windows UI.
37870
+ * 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.
37755
37871
  *
37756
37872
  * @remarks
37757
37873
  * [Api set: ExcelApi 1.13]
@@ -37761,7 +37877,7 @@ declare namespace Excel {
37761
37877
  */
37762
37878
  getExtendedRange(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range;
37763
37879
  /**
37764
- * 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 <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Arrow key</kbd> behavior in the Excel on Windows UI.
37880
+ * 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.
37765
37881
  *
37766
37882
  * @remarks
37767
37883
  * [Api set: ExcelApi 1.13]
@@ -37856,7 +37972,7 @@ declare namespace Excel {
37856
37972
  */
37857
37973
  getPrecedents(): Excel.WorkbookRangeAreas;
37858
37974
  /**
37859
- * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the <kbd>Ctrl</kbd>+<kbd>Arrow key</kbd> behavior in the Excel on Windows UI.
37975
+ * 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.
37860
37976
  *
37861
37977
  * @remarks
37862
37978
  * [Api set: ExcelApi 1.13]
@@ -37866,7 +37982,7 @@ declare namespace Excel {
37866
37982
  */
37867
37983
  getRangeEdge(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range;
37868
37984
  /**
37869
- * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the <kbd>Ctrl</kbd>+<kbd>Arrow key</kbd> behavior in the Excel on Windows UI.
37985
+ * 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.
37870
37986
  *
37871
37987
  * @remarks
37872
37988
  * [Api set: ExcelApi 1.13]
@@ -38193,6 +38309,15 @@ declare namespace Excel {
38193
38309
  * [Api set: ExcelApi 1.7]
38194
38310
  */
38195
38311
  showCard(): void;
38312
+ /**
38313
+ * Draws tracer arrows to the direct dependents of the range.
38314
+ *
38315
+ * @remarks
38316
+ * [Api set: ExcelApiDesktop 1.1]
38317
+ *
38318
+ * @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`.
38319
+ */
38320
+ showDependents(remove?: boolean): void;
38196
38321
  /**
38197
38322
  * Shows the details of the row or column group.
38198
38323
  *
@@ -38211,6 +38336,15 @@ declare namespace Excel {
38211
38336
  * @param groupOption Specifies whether to show the details of grouped rows or grouped columns.
38212
38337
  */
38213
38338
  showGroupDetails(groupOption: "ByRows" | "ByColumns"): void;
38339
+ /**
38340
+ * Draws tracer arrows to the direct precedents of the range.
38341
+ *
38342
+ * @remarks
38343
+ * [Api set: ExcelApiDesktop 1.1]
38344
+ *
38345
+ * @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`.
38346
+ */
38347
+ showPrecedents(remove?: boolean): void;
38214
38348
  /**
38215
38349
  * Ungroups columns and rows for an outline.
38216
38350
  *
@@ -52951,6 +53085,13 @@ declare namespace Excel {
52951
53085
  * [Api set: ExcelApi 1.9]
52952
53086
  */
52953
53087
  readonly headersFooters: Excel.HeaderFooterGroup;
53088
+ /**
53089
+ * Specifies whether Excel aligns the header and the footer with the margins set in the page setup options.
53090
+ *
53091
+ * @remarks
53092
+ * [Api set: ExcelApiDesktop 1.1]
53093
+ */
53094
+ alignMarginsHeaderFooter: boolean;
52954
53095
  /**
52955
53096
  * The worksheet's black and white print option.
52956
53097
  *
@@ -53063,6 +53204,15 @@ declare namespace Excel {
53063
53204
  * [Api set: ExcelApi 1.9]
53064
53205
  */
53065
53206
  printOrder: Excel.PrintOrder | "DownThenOver" | "OverThenDown";
53207
+ /**
53208
+ * Specifies a two-element array that contains both horizontal and vertical print quality values.
53209
+ The first element is the horizontal print quality, and the second element is the vertical print quality.
53210
+ Some printers may not support vertical print quality and the supported values may vary by printer.
53211
+ *
53212
+ * @remarks
53213
+ * [Api set: ExcelApiDesktop 1.1]
53214
+ */
53215
+ printQuality: number[];
53066
53216
  /**
53067
53217
  * The worksheet's right margin, in points, for use when printing.
53068
53218
  *
@@ -53301,6 +53451,48 @@ declare namespace Excel {
53301
53451
  class HeaderFooter extends OfficeExtension.ClientObject {
53302
53452
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
53303
53453
  context: RequestContext;
53454
+ /**
53455
+ * Gets a `HeaderFooterPicture` object that represents the picture for the center section of the footer.
53456
+ *
53457
+ * @remarks
53458
+ * [Api set: ExcelApiDesktop 1.1]
53459
+ */
53460
+ readonly centerFooterPicture: Excel.HeaderFooterPicture;
53461
+ /**
53462
+ * Gets a `HeaderFooterPicture` object that represents the picture for the center section of the header.
53463
+ *
53464
+ * @remarks
53465
+ * [Api set: ExcelApiDesktop 1.1]
53466
+ */
53467
+ readonly centerHeaderPicture: Excel.HeaderFooterPicture;
53468
+ /**
53469
+ * Gets a `HeaderFooterPicture` object that represents the picture for the left section of the footer.
53470
+ *
53471
+ * @remarks
53472
+ * [Api set: ExcelApiDesktop 1.1]
53473
+ */
53474
+ readonly leftFooterPicture: Excel.HeaderFooterPicture;
53475
+ /**
53476
+ * Gets a `HeaderFooterPicture` object that represents the picture for the left section of the header.
53477
+ *
53478
+ * @remarks
53479
+ * [Api set: ExcelApiDesktop 1.1]
53480
+ */
53481
+ readonly leftHeaderPicture: Excel.HeaderFooterPicture;
53482
+ /**
53483
+ * Gets a `HeaderFooterPicture` object that represents the picture for the right section of the footer.
53484
+ *
53485
+ * @remarks
53486
+ * [Api set: ExcelApiDesktop 1.1]
53487
+ */
53488
+ readonly rightFooterPicture: Excel.HeaderFooterPicture;
53489
+ /**
53490
+ * Gets a `HeaderFooterPicture` object that represents the picture for the right section of the header.
53491
+ *
53492
+ * @remarks
53493
+ * [Api set: ExcelApiDesktop 1.1]
53494
+ */
53495
+ readonly rightHeaderPicture: Excel.HeaderFooterPicture;
53304
53496
  /**
53305
53497
  * The center footer of the worksheet.
53306
53498
  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 {
53475
53667
  */
53476
53668
  toJSON(): Excel.Interfaces.HeaderFooterGroupData;
53477
53669
  }
53670
+ /**
53671
+ * Represents a picture in the header or footer of a worksheet.
53672
+ *
53673
+ * @remarks
53674
+ * [Api set: ExcelApiDesktop 1.1]
53675
+ */
53676
+ class HeaderFooterPicture extends OfficeExtension.ClientObject {
53677
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
53678
+ context: RequestContext;
53679
+ /**
53680
+ * Specifies the brightness of the picture. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest).
53681
+ *
53682
+ * @remarks
53683
+ * [Api set: ExcelApiDesktop 1.1]
53684
+ */
53685
+ brightness: number;
53686
+ /**
53687
+ * Specifies the type of color transformation of the picture.
53688
+ *
53689
+ * @remarks
53690
+ * [Api set: ExcelApiDesktop 1.1]
53691
+ */
53692
+ colorType: Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark";
53693
+ /**
53694
+ * 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).
53695
+ *
53696
+ * @remarks
53697
+ * [Api set: ExcelApiDesktop 1.1]
53698
+ */
53699
+ contrast: number;
53700
+ /**
53701
+ * Specifies the number of points that are cropped off the bottom of the picture.
53702
+ *
53703
+ * @remarks
53704
+ * [Api set: ExcelApiDesktop 1.1]
53705
+ */
53706
+ cropBottom: number;
53707
+ /**
53708
+ * Specifies the number of points that are cropped off the left side of the picture.
53709
+ *
53710
+ * @remarks
53711
+ * [Api set: ExcelApiDesktop 1.1]
53712
+ */
53713
+ cropLeft: number;
53714
+ /**
53715
+ * Specifies the number of points that are cropped off the right side of the picture.
53716
+ *
53717
+ * @remarks
53718
+ * [Api set: ExcelApiDesktop 1.1]
53719
+ */
53720
+ cropRight: number;
53721
+ /**
53722
+ * Specifies the number of points that are cropped off the top of the picture.
53723
+ *
53724
+ * @remarks
53725
+ * [Api set: ExcelApiDesktop 1.1]
53726
+ */
53727
+ cropTop: number;
53728
+ /**
53729
+ * Specifies the URL (on the intranet or the web) or path (local or network) to the location where the source object is saved.
53730
+ *
53731
+ * @remarks
53732
+ * [Api set: ExcelApiDesktop 1.1]
53733
+ */
53734
+ filename: string;
53735
+ /**
53736
+ * Specifies the height of the picture in points.
53737
+ *
53738
+ * @remarks
53739
+ * [Api set: ExcelApiDesktop 1.1]
53740
+ */
53741
+ height: number;
53742
+ /**
53743
+ * Specifies a value that indicates whether the picture retains its original proportions when resized. `true` if it retains its proportions; otherwise, `false`.
53744
+ *
53745
+ * @remarks
53746
+ * [Api set: ExcelApiDesktop 1.1]
53747
+ */
53748
+ lockAspectRatio: boolean;
53749
+ /**
53750
+ * Specifies the width of the picture in points.
53751
+ *
53752
+ * @remarks
53753
+ * [Api set: ExcelApiDesktop 1.1]
53754
+ */
53755
+ width: number;
53756
+ /**
53757
+ * 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.
53758
+ * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
53759
+ * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
53760
+ */
53761
+ set(properties: Interfaces.HeaderFooterPictureUpdateData, options?: OfficeExtension.UpdateOptions): void;
53762
+ /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
53763
+ set(properties: Excel.HeaderFooterPicture): void;
53764
+ /**
53765
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
53766
+ *
53767
+ * @param options Provides options for which properties of the object to load.
53768
+ */
53769
+ load(options?: Excel.Interfaces.HeaderFooterPictureLoadOptions): Excel.HeaderFooterPicture;
53770
+ /**
53771
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
53772
+ *
53773
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
53774
+ */
53775
+ load(propertyNames?: string | string[]): Excel.HeaderFooterPicture;
53776
+ /**
53777
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
53778
+ *
53779
+ * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
53780
+ */
53781
+ load(propertyNamesAndPaths?: {
53782
+ select?: string;
53783
+ expand?: string;
53784
+ }): Excel.HeaderFooterPicture;
53785
+ /**
53786
+ * 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.)
53787
+ * 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.
53788
+ */
53789
+ toJSON(): Excel.Interfaces.HeaderFooterPictureData;
53790
+ }
53791
+ /**
53792
+ * Specifies the color transformation of a picture in the header or footer of a worksheet.
53793
+ *
53794
+ * @remarks
53795
+ * [Api set: ExcelApiDesktop 1.1]
53796
+ */
53797
+ enum PictureColorType {
53798
+ /**
53799
+ * Mixed transformation.
53800
+ * @remarks
53801
+ * [Api set: ExcelApiDesktop 1.1]
53802
+ */
53803
+ mixed = "Mixed",
53804
+ /**
53805
+ * Default color transformation.
53806
+ * @remarks
53807
+ * [Api set: ExcelApiDesktop 1.1]
53808
+ */
53809
+ automatic = "Automatic",
53810
+ /**
53811
+ * Grayscale transformation.
53812
+ * @remarks
53813
+ * [Api set: ExcelApiDesktop 1.1]
53814
+ */
53815
+ grayScale = "GrayScale",
53816
+ /**
53817
+ * Black-and-white transformation.
53818
+ * @remarks
53819
+ * [Api set: ExcelApiDesktop 1.1]
53820
+ */
53821
+ blackAndWhite = "BlackAndWhite",
53822
+ /**
53823
+ * Watermark transformation.
53824
+ * @remarks
53825
+ * [Api set: ExcelApiDesktop 1.1]
53826
+ */
53827
+ watermark = "Watermark"
53828
+ }
53478
53829
  /**
53479
53830
  * @remarks
53480
53831
  * [Api set: ExcelApi 1.9]
@@ -54865,6 +55216,55 @@ declare namespace Excel {
54865
55216
  * [Api set: ExcelApi 1.9]
54866
55217
  */
54867
55218
  readonly shape: Excel.Shape;
55219
+ /**
55220
+ * Specifies the brightness of the image. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest).
55221
+ *
55222
+ * @remarks
55223
+ * [Api set: ExcelApiDesktop 1.1]
55224
+ */
55225
+ brightness: number;
55226
+ /**
55227
+ * Specifies the type of color transformation applied to the image.
55228
+ *
55229
+ * @remarks
55230
+ * [Api set: ExcelApiDesktop 1.1]
55231
+ */
55232
+ colorType: Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark";
55233
+ /**
55234
+ * 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).
55235
+ *
55236
+ * @remarks
55237
+ * [Api set: ExcelApiDesktop 1.1]
55238
+ */
55239
+ contrast: number;
55240
+ /**
55241
+ * Specifies the number of points that are cropped off the bottom of the image.
55242
+ *
55243
+ * @remarks
55244
+ * [Api set: ExcelApiDesktop 1.1]
55245
+ */
55246
+ cropBottom: number;
55247
+ /**
55248
+ * Specifies the number of points that are cropped off the left side of the image.
55249
+ *
55250
+ * @remarks
55251
+ * [Api set: ExcelApiDesktop 1.1]
55252
+ */
55253
+ cropLeft: number;
55254
+ /**
55255
+ * Specifies the number of points that are cropped off the right side of the image.
55256
+ *
55257
+ * @remarks
55258
+ * [Api set: ExcelApiDesktop 1.1]
55259
+ */
55260
+ cropRight: number;
55261
+ /**
55262
+ * Specifies the number of points that are cropped off the top of the image.
55263
+ *
55264
+ * @remarks
55265
+ * [Api set: ExcelApiDesktop 1.1]
55266
+ */
55267
+ cropTop: number;
54868
55268
  /**
54869
55269
  * Specifies the shape identifier for the image object.
54870
55270
  *
@@ -54879,6 +55279,32 @@ declare namespace Excel {
54879
55279
  * [Api set: ExcelApi 1.9]
54880
55280
  */
54881
55281
  readonly format: Excel.PictureFormat | "UNKNOWN" | "BMP" | "JPEG" | "GIF" | "PNG" | "SVG";
55282
+ /**
55283
+ * 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.
55284
+ * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
55285
+ * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
55286
+ */
55287
+ set(properties: Interfaces.ImageUpdateData, options?: OfficeExtension.UpdateOptions): void;
55288
+ /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
55289
+ set(properties: Excel.Image): void;
55290
+ /**
55291
+ * Increments the brightness of the image by a specified amount.
55292
+ *
55293
+ * @remarks
55294
+ * [Api set: ExcelApiDesktop 1.1]
55295
+ *
55296
+ * @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.
55297
+ */
55298
+ incrementBrightness(increment: number): void;
55299
+ /**
55300
+ * Increments the contrast of the image by a specified amount.
55301
+ *
55302
+ * @remarks
55303
+ * [Api set: ExcelApiDesktop 1.1]
55304
+ *
55305
+ * @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.
55306
+ */
55307
+ incrementContrast(increment: number): void;
54882
55308
  /**
54883
55309
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
54884
55310
  *
@@ -56267,6 +56693,8 @@ declare namespace Excel {
56267
56693
  *
56268
56694
  * @remarks
56269
56695
  * [Api set: ExcelApi 1.19]
56696
+ *
56697
+ * This property isn't supported in Excel on the web.
56270
56698
  */
56271
56699
  source: Excel.EventSource | "Local" | "Remote";
56272
56700
  /**
@@ -63930,6 +64358,687 @@ declare namespace Excel {
63930
64358
  */
63931
64359
  toJSON(): Excel.Interfaces.NoteData;
63932
64360
  }
64361
+ /**
64362
+ * Represents a window in the workbook.
64363
+ *
64364
+ * @remarks
64365
+ * [Api set: ExcelApiDesktop 1.1]
64366
+ */
64367
+ class Window extends OfficeExtension.ClientObject {
64368
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
64369
+ context: RequestContext;
64370
+ /**
64371
+ * Gets the active cell in the window.
64372
+ *
64373
+ * @remarks
64374
+ * [Api set: ExcelApiDesktop 1.1]
64375
+ */
64376
+ readonly activeCell: Excel.Range;
64377
+ /**
64378
+ * Gets the active pane in the window.
64379
+ *
64380
+ * @remarks
64381
+ * [Api set: ExcelApiDesktop 1.1]
64382
+ */
64383
+ readonly activePane: Excel.Pane;
64384
+ /**
64385
+ * Gets the active worksheet in the window.
64386
+ *
64387
+ * @remarks
64388
+ * [Api set: ExcelApiDesktop 1.1]
64389
+ */
64390
+ readonly activeWorksheet: Excel.Worksheet;
64391
+ /**
64392
+ * Gets a collection of panes associated with the window.
64393
+ *
64394
+ * @remarks
64395
+ * [Api set: ExcelApiDesktop 1.1]
64396
+ */
64397
+ readonly panes: Excel.PaneCollection;
64398
+ /**
64399
+ * Gets the visible range of the window.
64400
+ *
64401
+ * @remarks
64402
+ * [Api set: ExcelApiDesktop 1.1]
64403
+ */
64404
+ readonly visibleRange: Excel.Range;
64405
+ /**
64406
+ * Specifies whether AutoFilter date grouping is enabled in the window.
64407
+ *
64408
+ * @remarks
64409
+ * [Api set: ExcelApiDesktop 1.1]
64410
+ */
64411
+ autoFilterDateGroupingEnabled: boolean;
64412
+ /**
64413
+ * Specifies whether resizing is enabled for the window.
64414
+ *
64415
+ * @remarks
64416
+ * [Api set: ExcelApiDesktop 1.1]
64417
+ */
64418
+ readonly enableResize: boolean;
64419
+ /**
64420
+ * Specifies whether panes are frozen in the window.
64421
+ *
64422
+ * @remarks
64423
+ * [Api set: ExcelApiDesktop 1.1]
64424
+ */
64425
+ freezePanes: boolean;
64426
+ /**
64427
+ * Specifies the height of the window.
64428
+ *
64429
+ * @remarks
64430
+ * [Api set: ExcelApiDesktop 1.1]
64431
+ */
64432
+ height: number;
64433
+ /**
64434
+ * Gets the index of the window.
64435
+ *
64436
+ * @remarks
64437
+ * [Api set: ExcelApiDesktop 1.1]
64438
+ */
64439
+ readonly index: number;
64440
+ /**
64441
+ * Specifies whether the window is visible.
64442
+ *
64443
+ * @remarks
64444
+ * [Api set: ExcelApiDesktop 1.1]
64445
+ */
64446
+ isVisible: boolean;
64447
+ /**
64448
+ * Specifies the distance, in points, from the left edge of the computer screen to the left edge of the window.
64449
+ *
64450
+ * @remarks
64451
+ * [Api set: ExcelApiDesktop 1.1]
64452
+ */
64453
+ left: number;
64454
+ /**
64455
+ * Specifies the name of the window.
64456
+ *
64457
+ * @remarks
64458
+ * [Api set: ExcelApiDesktop 1.1]
64459
+ */
64460
+ name: string;
64461
+ /**
64462
+ * Specifies the scroll column of the window.
64463
+ *
64464
+ * @remarks
64465
+ * [Api set: ExcelApiDesktop 1.1]
64466
+ */
64467
+ scrollColumn: number;
64468
+ /**
64469
+ * Specifies the scroll row of the window.
64470
+ *
64471
+ * @remarks
64472
+ * [Api set: ExcelApiDesktop 1.1]
64473
+ */
64474
+ scrollRow: number;
64475
+ /**
64476
+ * Specifies whether formulas are shown in the window.
64477
+ *
64478
+ * @remarks
64479
+ * [Api set: ExcelApiDesktop 1.1]
64480
+ */
64481
+ showFormulas: boolean;
64482
+ /**
64483
+ * Specifies whether gridlines are shown in the window.
64484
+ *
64485
+ * @remarks
64486
+ * [Api set: ExcelApiDesktop 1.1]
64487
+ */
64488
+ showGridlines: boolean;
64489
+ /**
64490
+ * Specifies whether headings are shown in the window.
64491
+ *
64492
+ * @remarks
64493
+ * [Api set: ExcelApiDesktop 1.1]
64494
+ */
64495
+ showHeadings: boolean;
64496
+ /**
64497
+ * Specifies whether the horizontal scroll bar is shown in the window.
64498
+ *
64499
+ * @remarks
64500
+ * [Api set: ExcelApiDesktop 1.1]
64501
+ */
64502
+ showHorizontalScrollBar: boolean;
64503
+ /**
64504
+ * Specifies whether outline is shown in the window.
64505
+ *
64506
+ * @remarks
64507
+ * [Api set: ExcelApiDesktop 1.1]
64508
+ */
64509
+ showOutline: boolean;
64510
+ /**
64511
+ * 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.
64512
+ *
64513
+ * @remarks
64514
+ * [Api set: ExcelApiDesktop 1.1]
64515
+ */
64516
+ readonly showRightToLeft: boolean;
64517
+ /**
64518
+ * Specifies whether the ruler is shown in the window.
64519
+ *
64520
+ * @remarks
64521
+ * [Api set: ExcelApiDesktop 1.1]
64522
+ */
64523
+ showRuler: boolean;
64524
+ /**
64525
+ * Specifies whether the vertical scroll bar is shown in the window.
64526
+ *
64527
+ * @remarks
64528
+ * [Api set: ExcelApiDesktop 1.1]
64529
+ */
64530
+ showVerticalScrollBar: boolean;
64531
+ /**
64532
+ * Specifies whether whitespace is shown in the window.
64533
+ *
64534
+ * @remarks
64535
+ * [Api set: ExcelApiDesktop 1.1]
64536
+ */
64537
+ showWhitespace: boolean;
64538
+ /**
64539
+ * Specifies whether workbook tabs are shown in the window.
64540
+ *
64541
+ * @remarks
64542
+ * [Api set: ExcelApiDesktop 1.1]
64543
+ */
64544
+ showWorkbookTabs: boolean;
64545
+ /**
64546
+ * Specifies whether zeroes are shown in the window.
64547
+ *
64548
+ * @remarks
64549
+ * [Api set: ExcelApiDesktop 1.1]
64550
+ */
64551
+ showZeros: boolean;
64552
+ /**
64553
+ * Specifies the split state of the window.
64554
+ *
64555
+ * @remarks
64556
+ * [Api set: ExcelApiDesktop 1.1]
64557
+ */
64558
+ split: boolean;
64559
+ /**
64560
+ * Specifies the split column of the window.
64561
+ *
64562
+ * @remarks
64563
+ * [Api set: ExcelApiDesktop 1.1]
64564
+ */
64565
+ splitColumn: number;
64566
+ /**
64567
+ * Specifies the horizontal split of the window.
64568
+ *
64569
+ * @remarks
64570
+ * [Api set: ExcelApiDesktop 1.1]
64571
+ */
64572
+ splitHorizontal: number;
64573
+ /**
64574
+ * Specifies the split row of the window.
64575
+ *
64576
+ * @remarks
64577
+ * [Api set: ExcelApiDesktop 1.1]
64578
+ */
64579
+ splitRow: number;
64580
+ /**
64581
+ * Specifies the vertical split of the window.
64582
+ *
64583
+ * @remarks
64584
+ * [Api set: ExcelApiDesktop 1.1]
64585
+ */
64586
+ splitVertical: number;
64587
+ /**
64588
+ * Specifies the tab ratio of the window.
64589
+ *
64590
+ * @remarks
64591
+ * [Api set: ExcelApiDesktop 1.1]
64592
+ */
64593
+ tabRatio: number;
64594
+ /**
64595
+ * 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).
64596
+ *
64597
+ * @remarks
64598
+ * [Api set: ExcelApiDesktop 1.1]
64599
+ */
64600
+ top: number;
64601
+ /**
64602
+ * Specifies the type of the window.
64603
+ *
64604
+ * @remarks
64605
+ * [Api set: ExcelApiDesktop 1.1]
64606
+ */
64607
+ readonly type: Excel.WindowType | "chartAsWindow" | "chartInPlace" | "clipboard" | "workbook";
64608
+ /**
64609
+ * Gets the usable height of the window.
64610
+ *
64611
+ * @remarks
64612
+ * [Api set: ExcelApiDesktop 1.1]
64613
+ */
64614
+ readonly usableHeight: number;
64615
+ /**
64616
+ * Gets the usable width of the window.
64617
+ *
64618
+ * @remarks
64619
+ * [Api set: ExcelApiDesktop 1.1]
64620
+ */
64621
+ readonly usableWidth: number;
64622
+ /**
64623
+ * Specifies the view of the window.
64624
+ *
64625
+ * @remarks
64626
+ * [Api set: ExcelApiDesktop 1.1]
64627
+ */
64628
+ view: Excel.WindowView | "normalView" | "pageBreakPreview" | "pageLayoutView";
64629
+ /**
64630
+ * Specifies the display width of the window.
64631
+ *
64632
+ * @remarks
64633
+ * [Api set: ExcelApiDesktop 1.1]
64634
+ */
64635
+ width: number;
64636
+ /**
64637
+ * Gets the window number.
64638
+ *
64639
+ * @remarks
64640
+ * [Api set: ExcelApiDesktop 1.1]
64641
+ */
64642
+ readonly windowNumber: number;
64643
+ /**
64644
+ * Specifies the window state.
64645
+ *
64646
+ * @remarks
64647
+ * [Api set: ExcelApiDesktop 1.1]
64648
+ */
64649
+ windowState: Excel.WindowState | "maximized" | "minimized" | "normal";
64650
+ /**
64651
+ * Specifies an integer value that represents the display size of the window. It can be set to a percentage between 10 and 400.
64652
+ *
64653
+ * @remarks
64654
+ * [Api set: ExcelApiDesktop 1.1]
64655
+ */
64656
+ zoom: number;
64657
+ /**
64658
+ * 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.
64659
+ * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
64660
+ * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
64661
+ */
64662
+ set(properties: Interfaces.WindowUpdateData, options?: OfficeExtension.UpdateOptions): void;
64663
+ /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
64664
+ set(properties: Excel.Window): void;
64665
+ /**
64666
+ * Activates the window.
64667
+ *
64668
+ * @remarks
64669
+ * [Api set: ExcelApiDesktop 1.1]
64670
+ */
64671
+ activate(): void;
64672
+ /**
64673
+ * Activates the next window.
64674
+ *
64675
+ * @remarks
64676
+ * [Api set: ExcelApiDesktop 1.1]
64677
+ */
64678
+ activateNext(): void;
64679
+ /**
64680
+ * Activates the previous window.
64681
+ *
64682
+ * @remarks
64683
+ * [Api set: ExcelApiDesktop 1.1]
64684
+ */
64685
+ activatePrevious(): void;
64686
+ /**
64687
+ * Closes the window.
64688
+ *
64689
+ * @remarks
64690
+ * [Api set: ExcelApiDesktop 1.1]
64691
+ */
64692
+ close(): OfficeExtension.ClientResult<boolean>;
64693
+ /**
64694
+ * 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.
64695
+ *
64696
+ * @remarks
64697
+ * [Api set: ExcelApiDesktop 1.1]
64698
+ */
64699
+ largeScroll(Down: number, Up: number, ToRight: number, ToLeft: number): void;
64700
+ /**
64701
+ * Opens a new Excel window.
64702
+ *
64703
+ * @remarks
64704
+ * [Api set: ExcelApiDesktop 1.1]
64705
+ */
64706
+ newWindow(): Excel.Window;
64707
+ /**
64708
+ * Converts horizontal points to screen pixels.
64709
+ *
64710
+ * @remarks
64711
+ * [Api set: ExcelApiDesktop 1.1]
64712
+ */
64713
+ pointsToScreenPixelsX(Points: number): OfficeExtension.ClientResult<number>;
64714
+ /**
64715
+ * Converts vertical points to screen pixels.
64716
+ *
64717
+ * @remarks
64718
+ * [Api set: ExcelApiDesktop 1.1]
64719
+ */
64720
+ pointsToScreenPixelsY(Points: number): OfficeExtension.ClientResult<number>;
64721
+ /**
64722
+ * Scrolls the window to bring the specified range into view.
64723
+ *
64724
+ * @remarks
64725
+ * [Api set: ExcelApiDesktop 1.1]
64726
+ */
64727
+ scrollIntoView(Left: number, Top: number, Width: number, Height: number, Start?: boolean): void;
64728
+ /**
64729
+ * Scrolls the workbook tabs.
64730
+ *
64731
+ * @remarks
64732
+ * [Api set: ExcelApiDesktop 1.1]
64733
+ */
64734
+ scrollWorkbookTabs(Sheets?: number, Position?: Excel.ScrollWorkbookTabPosition): void;
64735
+ /**
64736
+ * Scrolls the workbook tabs.
64737
+ *
64738
+ * @remarks
64739
+ * [Api set: ExcelApiDesktop 1.1]
64740
+ */
64741
+ scrollWorkbookTabs(Sheets?: number, Position?: "First" | "Last"): void;
64742
+ /**
64743
+ * 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.
64744
+ *
64745
+ * @remarks
64746
+ * [Api set: ExcelApiDesktop 1.1]
64747
+ */
64748
+ smallScroll(Down: number, Up: number, ToRight: number, ToLeft: number): void;
64749
+ /**
64750
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
64751
+ *
64752
+ * @param options Provides options for which properties of the object to load.
64753
+ */
64754
+ load(options?: Excel.Interfaces.WindowLoadOptions): Excel.Window;
64755
+ /**
64756
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
64757
+ *
64758
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
64759
+ */
64760
+ load(propertyNames?: string | string[]): Excel.Window;
64761
+ /**
64762
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
64763
+ *
64764
+ * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
64765
+ */
64766
+ load(propertyNamesAndPaths?: {
64767
+ select?: string;
64768
+ expand?: string;
64769
+ }): Excel.Window;
64770
+ /**
64771
+ * 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.)
64772
+ * 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.
64773
+ */
64774
+ toJSON(): Excel.Interfaces.WindowData;
64775
+ }
64776
+ /**
64777
+ * Specifies the display state of a window.
64778
+ *
64779
+ * @remarks
64780
+ * [Api set: ExcelApiDesktop 1.1]
64781
+ */
64782
+ enum WindowState {
64783
+ /**
64784
+ * The window is maximized to fill the entire screen.
64785
+ * @remarks
64786
+ * [Api set: ExcelApiDesktop 1.1]
64787
+ */
64788
+ maximized = "maximized",
64789
+ /**
64790
+ * The window is minimized and collapsed to the taskbar.
64791
+ * @remarks
64792
+ * [Api set: ExcelApiDesktop 1.1]
64793
+ */
64794
+ minimized = "minimized",
64795
+ /**
64796
+ * The window is displayed in normal size and can be moved or resized.
64797
+ * @remarks
64798
+ * [Api set: ExcelApiDesktop 1.1]
64799
+ */
64800
+ normal = "normal"
64801
+ }
64802
+ /**
64803
+ * Specifies the view mode of the window.
64804
+ *
64805
+ * @remarks
64806
+ * [Api set: ExcelApiDesktop 1.1]
64807
+ */
64808
+ enum WindowView {
64809
+ /**
64810
+ * The window displays the worksheet in normal view for general data entry and editing.
64811
+ * @remarks
64812
+ * [Api set: ExcelApiDesktop 1.1]
64813
+ */
64814
+ normalView = "normalView",
64815
+ /**
64816
+ * The window displays the worksheet in Page Break Preview mode to show where pages will break when printed.
64817
+ * @remarks
64818
+ * [Api set: ExcelApiDesktop 1.1]
64819
+ */
64820
+ pageBreakPreview = "pageBreakPreview",
64821
+ /**
64822
+ * The window displays the worksheet in Page Layout view to show how the worksheet will look when printed.
64823
+ * @remarks
64824
+ * [Api set: ExcelApiDesktop 1.1]
64825
+ */
64826
+ pageLayoutView = "pageLayoutView"
64827
+ }
64828
+ /**
64829
+ * Specifies the type of window being displayed.
64830
+ *
64831
+ * @remarks
64832
+ * [Api set: ExcelApiDesktop 1.1]
64833
+ */
64834
+ enum WindowType {
64835
+ /**
64836
+ * The window displays a chart in its own separate window.
64837
+ * @remarks
64838
+ * [Api set: ExcelApiDesktop 1.1]
64839
+ */
64840
+ chartAsWindow = "chartAsWindow",
64841
+ /**
64842
+ * The window displays a chart embedded within a worksheet.
64843
+ * @remarks
64844
+ * [Api set: ExcelApiDesktop 1.1]
64845
+ */
64846
+ chartInPlace = "chartInPlace",
64847
+ /**
64848
+ * The window displays the Office clipboard contents.
64849
+ * @remarks
64850
+ * [Api set: ExcelApiDesktop 1.1]
64851
+ */
64852
+ clipboard = "clipboard",
64853
+ /**
64854
+ * The window displays a standard Excel workbook.
64855
+ * @remarks
64856
+ * [Api set: ExcelApiDesktop 1.1]
64857
+ */
64858
+ workbook = "workbook"
64859
+ }
64860
+ /**
64861
+ * Enum representing the scroll position for workbook tab navigation.
64862
+ *
64863
+ * @remarks
64864
+ * [Api set: ExcelApiDesktop 1.1]
64865
+ */
64866
+ enum ScrollWorkbookTabPosition {
64867
+ /**
64868
+ * Scrolls the tab menu to show the first worksheet tab.
64869
+ * @remarks
64870
+ * [Api set: ExcelApiDesktop 1.1]
64871
+ */
64872
+ first = "First",
64873
+ /**
64874
+ * Scrolls the tab menu to show the last worksheet tab.
64875
+ * @remarks
64876
+ * [Api set: ExcelApiDesktop 1.1]
64877
+ */
64878
+ last = "Last"
64879
+ }
64880
+ /**
64881
+ * Represents a collection of Window objects.
64882
+ *
64883
+ * @remarks
64884
+ * [Api set: ExcelApiDesktop 1.1]
64885
+ */
64886
+ class WindowCollection extends OfficeExtension.ClientObject {
64887
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
64888
+ context: RequestContext;
64889
+ /** Gets the loaded child items in this collection. */
64890
+ readonly items: Excel.Window[];
64891
+ /**
64892
+ * Breaks the side-by-side view of windows.
64893
+ *
64894
+ * @remarks
64895
+ * [Api set: ExcelApiDesktop 1.1]
64896
+ */
64897
+ breakSideBySide(): void;
64898
+ /**
64899
+ * Compares the current window side by side with the specified window.
64900
+ *
64901
+ * @remarks
64902
+ * [Api set: ExcelApiDesktop 1.1]
64903
+ */
64904
+ compareCurrentSideBySideWith(windowName: string): void;
64905
+ /**
64906
+ * Gets the number of windows in the collection.
64907
+ *
64908
+ * @remarks
64909
+ * [Api set: ExcelApiDesktop 1.1]
64910
+ */
64911
+ getCount(): OfficeExtension.ClientResult<number>;
64912
+ /**
64913
+ * Gets the Window in the collection by index.
64914
+ *
64915
+ * @remarks
64916
+ * [Api set: ExcelApiDesktop 1.1]
64917
+ */
64918
+ getItemAt(index: number): Excel.Window;
64919
+ /**
64920
+ * Resets the positions of windows in side-by-side view.
64921
+ *
64922
+ * @remarks
64923
+ * [Api set: ExcelApiDesktop 1.1]
64924
+ */
64925
+ resetPositionsSideBySide(): void;
64926
+ /**
64927
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
64928
+ *
64929
+ * @param options Provides options for which properties of the object to load.
64930
+ */
64931
+ load(options?: Excel.Interfaces.WindowCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.WindowCollection;
64932
+ /**
64933
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
64934
+ *
64935
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
64936
+ */
64937
+ load(propertyNames?: string | string[]): Excel.WindowCollection;
64938
+ /**
64939
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
64940
+ *
64941
+ * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
64942
+ */
64943
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.WindowCollection;
64944
+ /**
64945
+ * 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.)
64946
+ * 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.
64947
+ */
64948
+ toJSON(): Excel.Interfaces.WindowCollectionData;
64949
+ }
64950
+ /**
64951
+ * Represents a pane, such as a frozen or split pane, in an Excel window.
64952
+ *
64953
+ * @remarks
64954
+ * [Api set: ExcelApiDesktop 1.1]
64955
+ */
64956
+ class Pane extends OfficeExtension.ClientObject {
64957
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
64958
+ context: RequestContext;
64959
+ /**
64960
+ * Returns index of the pane.
64961
+ *
64962
+ * @remarks
64963
+ * [Api set: ExcelApiDesktop 1.1]
64964
+ */
64965
+ readonly index: number;
64966
+ /**
64967
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
64968
+ *
64969
+ * @param options Provides options for which properties of the object to load.
64970
+ */
64971
+ load(options?: Excel.Interfaces.PaneLoadOptions): Excel.Pane;
64972
+ /**
64973
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
64974
+ *
64975
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
64976
+ */
64977
+ load(propertyNames?: string | string[]): Excel.Pane;
64978
+ /**
64979
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
64980
+ *
64981
+ * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
64982
+ */
64983
+ load(propertyNamesAndPaths?: {
64984
+ select?: string;
64985
+ expand?: string;
64986
+ }): Excel.Pane;
64987
+ /**
64988
+ * 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.)
64989
+ * 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.
64990
+ */
64991
+ toJSON(): Excel.Interfaces.PaneData;
64992
+ }
64993
+ /**
64994
+ * Represents a collection of Pane objects.
64995
+ *
64996
+ * @remarks
64997
+ * [Api set: ExcelApiDesktop 1.1]
64998
+ */
64999
+ class PaneCollection extends OfficeExtension.ClientObject {
65000
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
65001
+ context: RequestContext;
65002
+ /** Gets the loaded child items in this collection. */
65003
+ readonly items: Excel.Pane[];
65004
+ /**
65005
+ * Returns the number of panes in the collection.
65006
+ *
65007
+ * @remarks
65008
+ * [Api set: ExcelApiDesktop 1.1]
65009
+ */
65010
+ getCount(): OfficeExtension.ClientResult<number>;
65011
+ /**
65012
+ * Gets the pane in the collection by index.
65013
+ *
65014
+ * @remarks
65015
+ * [Api set: ExcelApiDesktop 1.1]
65016
+ */
65017
+ getItemAt(index: number): Excel.Pane;
65018
+ /**
65019
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
65020
+ *
65021
+ * @param options Provides options for which properties of the object to load.
65022
+ */
65023
+ load(options?: Excel.Interfaces.PaneCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PaneCollection;
65024
+ /**
65025
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
65026
+ *
65027
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
65028
+ */
65029
+ load(propertyNames?: string | string[]): Excel.PaneCollection;
65030
+ /**
65031
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
65032
+ *
65033
+ * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
65034
+ */
65035
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.PaneCollection;
65036
+ /**
65037
+ * 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.)
65038
+ * 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.
65039
+ */
65040
+ toJSON(): Excel.Interfaces.PaneCollectionData;
65041
+ }
63933
65042
  /**
63934
65043
  * An object containing the result of a function-evaluation operation
63935
65044
  *
@@ -67835,6 +68944,13 @@ declare namespace Excel {
67835
68944
  }
67836
68945
  /** An interface for updating data on the `Application` object, for use in `application.set({ ... })`. */
67837
68946
  interface ApplicationUpdateData {
68947
+ /**
68948
+ * Returns a `window` object that represents the active window (the window on top).
68949
+ *
68950
+ * @remarks
68951
+ * [Api set: ExcelApiDesktop 1.1]
68952
+ */
68953
+ activeWindow?: Excel.Interfaces.WindowUpdateData;
67838
68954
  /**
67839
68955
  * Returns the iterative calculation settings.
67840
68956
  In Excel on Windows and Mac, the settings will apply to the Excel Application.
@@ -68022,6 +69138,13 @@ declare namespace Excel {
68022
69138
  * [Api set: ExcelApi 1.18]
68023
69139
  */
68024
69140
  control?: CellControl;
69141
+ /**
69142
+ * Specifies the array formula of a range. If the specified range doesn't contain an array formula, this property returns `null`.
69143
+ *
69144
+ * @remarks
69145
+ * [Api set: ExcelApiDesktop 1.1]
69146
+ */
69147
+ formulaArray?: string;
68025
69148
  /**
68026
69149
  * Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead.
68027
69150
  *
@@ -71987,6 +73110,13 @@ declare namespace Excel {
71987
73110
  * [Api set: ExcelApi 1.9]
71988
73111
  */
71989
73112
  headersFooters?: Excel.Interfaces.HeaderFooterGroupUpdateData;
73113
+ /**
73114
+ * Specifies whether Excel aligns the header and the footer with the margins set in the page setup options.
73115
+ *
73116
+ * @remarks
73117
+ * [Api set: ExcelApiDesktop 1.1]
73118
+ */
73119
+ alignMarginsHeaderFooter?: boolean;
71990
73120
  /**
71991
73121
  * The worksheet's black and white print option.
71992
73122
  *
@@ -72099,6 +73229,15 @@ declare namespace Excel {
72099
73229
  * [Api set: ExcelApi 1.9]
72100
73230
  */
72101
73231
  printOrder?: Excel.PrintOrder | "DownThenOver" | "OverThenDown";
73232
+ /**
73233
+ * Specifies a two-element array that contains both horizontal and vertical print quality values.
73234
+ The first element is the horizontal print quality, and the second element is the vertical print quality.
73235
+ Some printers may not support vertical print quality and the supported values may vary by printer.
73236
+ *
73237
+ * @remarks
73238
+ * [Api set: ExcelApiDesktop 1.1]
73239
+ */
73240
+ printQuality?: number[];
72102
73241
  /**
72103
73242
  * The worksheet's right margin, in points, for use when printing.
72104
73243
  *
@@ -72124,6 +73263,48 @@ declare namespace Excel {
72124
73263
  }
72125
73264
  /** An interface for updating data on the `HeaderFooter` object, for use in `headerFooter.set({ ... })`. */
72126
73265
  interface HeaderFooterUpdateData {
73266
+ /**
73267
+ * Gets a `HeaderFooterPicture` object that represents the picture for the center section of the footer.
73268
+ *
73269
+ * @remarks
73270
+ * [Api set: ExcelApiDesktop 1.1]
73271
+ */
73272
+ centerFooterPicture?: Excel.Interfaces.HeaderFooterPictureUpdateData;
73273
+ /**
73274
+ * Gets a `HeaderFooterPicture` object that represents the picture for the center section of the header.
73275
+ *
73276
+ * @remarks
73277
+ * [Api set: ExcelApiDesktop 1.1]
73278
+ */
73279
+ centerHeaderPicture?: Excel.Interfaces.HeaderFooterPictureUpdateData;
73280
+ /**
73281
+ * Gets a `HeaderFooterPicture` object that represents the picture for the left section of the footer.
73282
+ *
73283
+ * @remarks
73284
+ * [Api set: ExcelApiDesktop 1.1]
73285
+ */
73286
+ leftFooterPicture?: Excel.Interfaces.HeaderFooterPictureUpdateData;
73287
+ /**
73288
+ * Gets a `HeaderFooterPicture` object that represents the picture for the left section of the header.
73289
+ *
73290
+ * @remarks
73291
+ * [Api set: ExcelApiDesktop 1.1]
73292
+ */
73293
+ leftHeaderPicture?: Excel.Interfaces.HeaderFooterPictureUpdateData;
73294
+ /**
73295
+ * Gets a `HeaderFooterPicture` object that represents the picture for the right section of the footer.
73296
+ *
73297
+ * @remarks
73298
+ * [Api set: ExcelApiDesktop 1.1]
73299
+ */
73300
+ rightFooterPicture?: Excel.Interfaces.HeaderFooterPictureUpdateData;
73301
+ /**
73302
+ * Gets a `HeaderFooterPicture` object that represents the picture for the right section of the header.
73303
+ *
73304
+ * @remarks
73305
+ * [Api set: ExcelApiDesktop 1.1]
73306
+ */
73307
+ rightHeaderPicture?: Excel.Interfaces.HeaderFooterPictureUpdateData;
72127
73308
  /**
72128
73309
  * The center footer of the worksheet.
72129
73310
  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 {
72225
73406
  */
72226
73407
  useSheetScale?: boolean;
72227
73408
  }
73409
+ /** An interface for updating data on the `HeaderFooterPicture` object, for use in `headerFooterPicture.set({ ... })`. */
73410
+ interface HeaderFooterPictureUpdateData {
73411
+ /**
73412
+ * Specifies the brightness of the picture. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest).
73413
+ *
73414
+ * @remarks
73415
+ * [Api set: ExcelApiDesktop 1.1]
73416
+ */
73417
+ brightness?: number;
73418
+ /**
73419
+ * Specifies the type of color transformation of the picture.
73420
+ *
73421
+ * @remarks
73422
+ * [Api set: ExcelApiDesktop 1.1]
73423
+ */
73424
+ colorType?: Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark";
73425
+ /**
73426
+ * 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).
73427
+ *
73428
+ * @remarks
73429
+ * [Api set: ExcelApiDesktop 1.1]
73430
+ */
73431
+ contrast?: number;
73432
+ /**
73433
+ * Specifies the number of points that are cropped off the bottom of the picture.
73434
+ *
73435
+ * @remarks
73436
+ * [Api set: ExcelApiDesktop 1.1]
73437
+ */
73438
+ cropBottom?: number;
73439
+ /**
73440
+ * Specifies the number of points that are cropped off the left side of the picture.
73441
+ *
73442
+ * @remarks
73443
+ * [Api set: ExcelApiDesktop 1.1]
73444
+ */
73445
+ cropLeft?: number;
73446
+ /**
73447
+ * Specifies the number of points that are cropped off the right side of the picture.
73448
+ *
73449
+ * @remarks
73450
+ * [Api set: ExcelApiDesktop 1.1]
73451
+ */
73452
+ cropRight?: number;
73453
+ /**
73454
+ * Specifies the number of points that are cropped off the top of the picture.
73455
+ *
73456
+ * @remarks
73457
+ * [Api set: ExcelApiDesktop 1.1]
73458
+ */
73459
+ cropTop?: number;
73460
+ /**
73461
+ * Specifies the URL (on the intranet or the web) or path (local or network) to the location where the source object is saved.
73462
+ *
73463
+ * @remarks
73464
+ * [Api set: ExcelApiDesktop 1.1]
73465
+ */
73466
+ filename?: string;
73467
+ /**
73468
+ * Specifies the height of the picture in points.
73469
+ *
73470
+ * @remarks
73471
+ * [Api set: ExcelApiDesktop 1.1]
73472
+ */
73473
+ height?: number;
73474
+ /**
73475
+ * Specifies a value that indicates whether the picture retains its original proportions when resized. `true` if it retains its proportions; otherwise, `false`.
73476
+ *
73477
+ * @remarks
73478
+ * [Api set: ExcelApiDesktop 1.1]
73479
+ */
73480
+ lockAspectRatio?: boolean;
73481
+ /**
73482
+ * Specifies the width of the picture in points.
73483
+ *
73484
+ * @remarks
73485
+ * [Api set: ExcelApiDesktop 1.1]
73486
+ */
73487
+ width?: number;
73488
+ }
72228
73489
  /** An interface for updating data on the `PageBreakCollection` object, for use in `pageBreakCollection.set({ ... })`. */
72229
73490
  interface PageBreakCollectionUpdateData {
72230
73491
  items?: Excel.Interfaces.PageBreakData[];
@@ -72381,6 +73642,58 @@ declare namespace Excel {
72381
73642
  */
72382
73643
  width?: number;
72383
73644
  }
73645
+ /** An interface for updating data on the `Image` object, for use in `image.set({ ... })`. */
73646
+ interface ImageUpdateData {
73647
+ /**
73648
+ * Specifies the brightness of the image. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest).
73649
+ *
73650
+ * @remarks
73651
+ * [Api set: ExcelApiDesktop 1.1]
73652
+ */
73653
+ brightness?: number;
73654
+ /**
73655
+ * Specifies the type of color transformation applied to the image.
73656
+ *
73657
+ * @remarks
73658
+ * [Api set: ExcelApiDesktop 1.1]
73659
+ */
73660
+ colorType?: Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark";
73661
+ /**
73662
+ * 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).
73663
+ *
73664
+ * @remarks
73665
+ * [Api set: ExcelApiDesktop 1.1]
73666
+ */
73667
+ contrast?: number;
73668
+ /**
73669
+ * Specifies the number of points that are cropped off the bottom of the image.
73670
+ *
73671
+ * @remarks
73672
+ * [Api set: ExcelApiDesktop 1.1]
73673
+ */
73674
+ cropBottom?: number;
73675
+ /**
73676
+ * Specifies the number of points that are cropped off the left side of the image.
73677
+ *
73678
+ * @remarks
73679
+ * [Api set: ExcelApiDesktop 1.1]
73680
+ */
73681
+ cropLeft?: number;
73682
+ /**
73683
+ * Specifies the number of points that are cropped off the right side of the image.
73684
+ *
73685
+ * @remarks
73686
+ * [Api set: ExcelApiDesktop 1.1]
73687
+ */
73688
+ cropRight?: number;
73689
+ /**
73690
+ * Specifies the number of points that are cropped off the top of the image.
73691
+ *
73692
+ * @remarks
73693
+ * [Api set: ExcelApiDesktop 1.1]
73694
+ */
73695
+ cropTop?: number;
73696
+ }
72384
73697
  /** An interface for updating data on the `GroupShapeCollection` object, for use in `groupShapeCollection.set({ ... })`. */
72385
73698
  interface GroupShapeCollectionUpdateData {
72386
73699
  items?: Excel.Interfaces.ShapeData[];
@@ -72799,6 +74112,241 @@ declare namespace Excel {
72799
74112
  */
72800
74113
  width?: number;
72801
74114
  }
74115
+ /** An interface for updating data on the `Window` object, for use in `window.set({ ... })`. */
74116
+ interface WindowUpdateData {
74117
+ /**
74118
+ * Gets the active cell in the window.
74119
+ *
74120
+ * @remarks
74121
+ * [Api set: ExcelApiDesktop 1.1]
74122
+ */
74123
+ activeCell?: Excel.Interfaces.RangeUpdateData;
74124
+ /**
74125
+ * Gets the active worksheet in the window.
74126
+ *
74127
+ * @remarks
74128
+ * [Api set: ExcelApiDesktop 1.1]
74129
+ */
74130
+ activeWorksheet?: Excel.Interfaces.WorksheetUpdateData;
74131
+ /**
74132
+ * Gets the visible range of the window.
74133
+ *
74134
+ * @remarks
74135
+ * [Api set: ExcelApiDesktop 1.1]
74136
+ */
74137
+ visibleRange?: Excel.Interfaces.RangeUpdateData;
74138
+ /**
74139
+ * Specifies whether AutoFilter date grouping is enabled in the window.
74140
+ *
74141
+ * @remarks
74142
+ * [Api set: ExcelApiDesktop 1.1]
74143
+ */
74144
+ autoFilterDateGroupingEnabled?: boolean;
74145
+ /**
74146
+ * Specifies whether panes are frozen in the window.
74147
+ *
74148
+ * @remarks
74149
+ * [Api set: ExcelApiDesktop 1.1]
74150
+ */
74151
+ freezePanes?: boolean;
74152
+ /**
74153
+ * Specifies the height of the window.
74154
+ *
74155
+ * @remarks
74156
+ * [Api set: ExcelApiDesktop 1.1]
74157
+ */
74158
+ height?: number;
74159
+ /**
74160
+ * Specifies whether the window is visible.
74161
+ *
74162
+ * @remarks
74163
+ * [Api set: ExcelApiDesktop 1.1]
74164
+ */
74165
+ isVisible?: boolean;
74166
+ /**
74167
+ * Specifies the distance, in points, from the left edge of the computer screen to the left edge of the window.
74168
+ *
74169
+ * @remarks
74170
+ * [Api set: ExcelApiDesktop 1.1]
74171
+ */
74172
+ left?: number;
74173
+ /**
74174
+ * Specifies the name of the window.
74175
+ *
74176
+ * @remarks
74177
+ * [Api set: ExcelApiDesktop 1.1]
74178
+ */
74179
+ name?: string;
74180
+ /**
74181
+ * Specifies the scroll column of the window.
74182
+ *
74183
+ * @remarks
74184
+ * [Api set: ExcelApiDesktop 1.1]
74185
+ */
74186
+ scrollColumn?: number;
74187
+ /**
74188
+ * Specifies the scroll row of the window.
74189
+ *
74190
+ * @remarks
74191
+ * [Api set: ExcelApiDesktop 1.1]
74192
+ */
74193
+ scrollRow?: number;
74194
+ /**
74195
+ * Specifies whether formulas are shown in the window.
74196
+ *
74197
+ * @remarks
74198
+ * [Api set: ExcelApiDesktop 1.1]
74199
+ */
74200
+ showFormulas?: boolean;
74201
+ /**
74202
+ * Specifies whether gridlines are shown in the window.
74203
+ *
74204
+ * @remarks
74205
+ * [Api set: ExcelApiDesktop 1.1]
74206
+ */
74207
+ showGridlines?: boolean;
74208
+ /**
74209
+ * Specifies whether headings are shown in the window.
74210
+ *
74211
+ * @remarks
74212
+ * [Api set: ExcelApiDesktop 1.1]
74213
+ */
74214
+ showHeadings?: boolean;
74215
+ /**
74216
+ * Specifies whether the horizontal scroll bar is shown in the window.
74217
+ *
74218
+ * @remarks
74219
+ * [Api set: ExcelApiDesktop 1.1]
74220
+ */
74221
+ showHorizontalScrollBar?: boolean;
74222
+ /**
74223
+ * Specifies whether outline is shown in the window.
74224
+ *
74225
+ * @remarks
74226
+ * [Api set: ExcelApiDesktop 1.1]
74227
+ */
74228
+ showOutline?: boolean;
74229
+ /**
74230
+ * Specifies whether the ruler is shown in the window.
74231
+ *
74232
+ * @remarks
74233
+ * [Api set: ExcelApiDesktop 1.1]
74234
+ */
74235
+ showRuler?: boolean;
74236
+ /**
74237
+ * Specifies whether the vertical scroll bar is shown in the window.
74238
+ *
74239
+ * @remarks
74240
+ * [Api set: ExcelApiDesktop 1.1]
74241
+ */
74242
+ showVerticalScrollBar?: boolean;
74243
+ /**
74244
+ * Specifies whether whitespace is shown in the window.
74245
+ *
74246
+ * @remarks
74247
+ * [Api set: ExcelApiDesktop 1.1]
74248
+ */
74249
+ showWhitespace?: boolean;
74250
+ /**
74251
+ * Specifies whether workbook tabs are shown in the window.
74252
+ *
74253
+ * @remarks
74254
+ * [Api set: ExcelApiDesktop 1.1]
74255
+ */
74256
+ showWorkbookTabs?: boolean;
74257
+ /**
74258
+ * Specifies whether zeroes are shown in the window.
74259
+ *
74260
+ * @remarks
74261
+ * [Api set: ExcelApiDesktop 1.1]
74262
+ */
74263
+ showZeros?: boolean;
74264
+ /**
74265
+ * Specifies the split state of the window.
74266
+ *
74267
+ * @remarks
74268
+ * [Api set: ExcelApiDesktop 1.1]
74269
+ */
74270
+ split?: boolean;
74271
+ /**
74272
+ * Specifies the split column of the window.
74273
+ *
74274
+ * @remarks
74275
+ * [Api set: ExcelApiDesktop 1.1]
74276
+ */
74277
+ splitColumn?: number;
74278
+ /**
74279
+ * Specifies the horizontal split of the window.
74280
+ *
74281
+ * @remarks
74282
+ * [Api set: ExcelApiDesktop 1.1]
74283
+ */
74284
+ splitHorizontal?: number;
74285
+ /**
74286
+ * Specifies the split row of the window.
74287
+ *
74288
+ * @remarks
74289
+ * [Api set: ExcelApiDesktop 1.1]
74290
+ */
74291
+ splitRow?: number;
74292
+ /**
74293
+ * Specifies the vertical split of the window.
74294
+ *
74295
+ * @remarks
74296
+ * [Api set: ExcelApiDesktop 1.1]
74297
+ */
74298
+ splitVertical?: number;
74299
+ /**
74300
+ * Specifies the tab ratio of the window.
74301
+ *
74302
+ * @remarks
74303
+ * [Api set: ExcelApiDesktop 1.1]
74304
+ */
74305
+ tabRatio?: number;
74306
+ /**
74307
+ * 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).
74308
+ *
74309
+ * @remarks
74310
+ * [Api set: ExcelApiDesktop 1.1]
74311
+ */
74312
+ top?: number;
74313
+ /**
74314
+ * Specifies the view of the window.
74315
+ *
74316
+ * @remarks
74317
+ * [Api set: ExcelApiDesktop 1.1]
74318
+ */
74319
+ view?: Excel.WindowView | "normalView" | "pageBreakPreview" | "pageLayoutView";
74320
+ /**
74321
+ * Specifies the display width of the window.
74322
+ *
74323
+ * @remarks
74324
+ * [Api set: ExcelApiDesktop 1.1]
74325
+ */
74326
+ width?: number;
74327
+ /**
74328
+ * Specifies the window state.
74329
+ *
74330
+ * @remarks
74331
+ * [Api set: ExcelApiDesktop 1.1]
74332
+ */
74333
+ windowState?: Excel.WindowState | "maximized" | "minimized" | "normal";
74334
+ /**
74335
+ * Specifies an integer value that represents the display size of the window. It can be set to a percentage between 10 and 400.
74336
+ *
74337
+ * @remarks
74338
+ * [Api set: ExcelApiDesktop 1.1]
74339
+ */
74340
+ zoom?: number;
74341
+ }
74342
+ /** An interface for updating data on the `WindowCollection` object, for use in `windowCollection.set({ ... })`. */
74343
+ interface WindowCollectionUpdateData {
74344
+ items?: Excel.Interfaces.WindowData[];
74345
+ }
74346
+ /** An interface for updating data on the `PaneCollection` object, for use in `paneCollection.set({ ... })`. */
74347
+ interface PaneCollectionUpdateData {
74348
+ items?: Excel.Interfaces.PaneData[];
74349
+ }
72802
74350
  /** An interface describing the data returned by calling `allowEditRange.toJSON()`. */
72803
74351
  interface AllowEditRangeData {
72804
74352
  /**
@@ -72909,6 +74457,13 @@ declare namespace Excel {
72909
74457
  }
72910
74458
  /** An interface describing the data returned by calling `application.toJSON()`. */
72911
74459
  interface ApplicationData {
74460
+ /**
74461
+ * Returns a `window` object that represents the active window (the window on top). Read-only.
74462
+ *
74463
+ * @remarks
74464
+ * [Api set: ExcelApiDesktop 1.1]
74465
+ */
74466
+ activeWindow?: Excel.Interfaces.WindowData;
72912
74467
  /**
72913
74468
  * Provides information based on current system culture settings. This includes the culture names, number formatting, and other culturally dependent settings.
72914
74469
  *
@@ -72925,6 +74480,13 @@ declare namespace Excel {
72925
74480
  * [Api set: ExcelApi 1.9]
72926
74481
  */
72927
74482
  iterativeCalculation?: Excel.Interfaces.IterativeCalculationData;
74483
+ /**
74484
+ * Returns all the open Excel windows.
74485
+ *
74486
+ * @remarks
74487
+ * [Api set: ExcelApiDesktop 1.1]
74488
+ */
74489
+ windows?: Excel.Interfaces.WindowData[];
72928
74490
  /**
72929
74491
  * Returns the Excel calculation engine version used for the last full recalculation.
72930
74492
  *
@@ -73507,6 +75069,13 @@ declare namespace Excel {
73507
75069
  * [Api set: ExcelApi 1.18]
73508
75070
  */
73509
75071
  control?: CellControl;
75072
+ /**
75073
+ * Specifies the array formula of a range. If the specified range doesn't contain an array formula, this property returns `null`.
75074
+ *
75075
+ * @remarks
75076
+ * [Api set: ExcelApiDesktop 1.1]
75077
+ */
75078
+ formulaArray?: string;
73510
75079
  /**
73511
75080
  * Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead.
73512
75081
  *
@@ -78480,6 +80049,13 @@ declare namespace Excel {
78480
80049
  * [Api set: ExcelApi 1.9]
78481
80050
  */
78482
80051
  headersFooters?: Excel.Interfaces.HeaderFooterGroupData;
80052
+ /**
80053
+ * Specifies whether Excel aligns the header and the footer with the margins set in the page setup options.
80054
+ *
80055
+ * @remarks
80056
+ * [Api set: ExcelApiDesktop 1.1]
80057
+ */
80058
+ alignMarginsHeaderFooter?: boolean;
78483
80059
  /**
78484
80060
  * The worksheet's black and white print option.
78485
80061
  *
@@ -78592,6 +80168,15 @@ declare namespace Excel {
78592
80168
  * [Api set: ExcelApi 1.9]
78593
80169
  */
78594
80170
  printOrder?: Excel.PrintOrder | "DownThenOver" | "OverThenDown";
80171
+ /**
80172
+ * Specifies a two-element array that contains both horizontal and vertical print quality values.
80173
+ The first element is the horizontal print quality, and the second element is the vertical print quality.
80174
+ Some printers may not support vertical print quality and the supported values may vary by printer.
80175
+ *
80176
+ * @remarks
80177
+ * [Api set: ExcelApiDesktop 1.1]
80178
+ */
80179
+ printQuality?: number[];
78595
80180
  /**
78596
80181
  * The worksheet's right margin, in points, for use when printing.
78597
80182
  *
@@ -78617,6 +80202,48 @@ declare namespace Excel {
78617
80202
  }
78618
80203
  /** An interface describing the data returned by calling `headerFooter.toJSON()`. */
78619
80204
  interface HeaderFooterData {
80205
+ /**
80206
+ * Gets a `HeaderFooterPicture` object that represents the picture for the center section of the footer.
80207
+ *
80208
+ * @remarks
80209
+ * [Api set: ExcelApiDesktop 1.1]
80210
+ */
80211
+ centerFooterPicture?: Excel.Interfaces.HeaderFooterPictureData;
80212
+ /**
80213
+ * Gets a `HeaderFooterPicture` object that represents the picture for the center section of the header.
80214
+ *
80215
+ * @remarks
80216
+ * [Api set: ExcelApiDesktop 1.1]
80217
+ */
80218
+ centerHeaderPicture?: Excel.Interfaces.HeaderFooterPictureData;
80219
+ /**
80220
+ * Gets a `HeaderFooterPicture` object that represents the picture for the left section of the footer.
80221
+ *
80222
+ * @remarks
80223
+ * [Api set: ExcelApiDesktop 1.1]
80224
+ */
80225
+ leftFooterPicture?: Excel.Interfaces.HeaderFooterPictureData;
80226
+ /**
80227
+ * Gets a `HeaderFooterPicture` object that represents the picture for the left section of the header.
80228
+ *
80229
+ * @remarks
80230
+ * [Api set: ExcelApiDesktop 1.1]
80231
+ */
80232
+ leftHeaderPicture?: Excel.Interfaces.HeaderFooterPictureData;
80233
+ /**
80234
+ * Gets a `HeaderFooterPicture` object that represents the picture for the right section of the footer.
80235
+ *
80236
+ * @remarks
80237
+ * [Api set: ExcelApiDesktop 1.1]
80238
+ */
80239
+ rightFooterPicture?: Excel.Interfaces.HeaderFooterPictureData;
80240
+ /**
80241
+ * Gets a `HeaderFooterPicture` object that represents the picture for the right section of the header.
80242
+ *
80243
+ * @remarks
80244
+ * [Api set: ExcelApiDesktop 1.1]
80245
+ */
80246
+ rightHeaderPicture?: Excel.Interfaces.HeaderFooterPictureData;
78620
80247
  /**
78621
80248
  * The center footer of the worksheet.
78622
80249
  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 {
78718
80345
  */
78719
80346
  useSheetScale?: boolean;
78720
80347
  }
80348
+ /** An interface describing the data returned by calling `headerFooterPicture.toJSON()`. */
80349
+ interface HeaderFooterPictureData {
80350
+ /**
80351
+ * Specifies the brightness of the picture. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest).
80352
+ *
80353
+ * @remarks
80354
+ * [Api set: ExcelApiDesktop 1.1]
80355
+ */
80356
+ brightness?: number;
80357
+ /**
80358
+ * Specifies the type of color transformation of the picture.
80359
+ *
80360
+ * @remarks
80361
+ * [Api set: ExcelApiDesktop 1.1]
80362
+ */
80363
+ colorType?: Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark";
80364
+ /**
80365
+ * 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).
80366
+ *
80367
+ * @remarks
80368
+ * [Api set: ExcelApiDesktop 1.1]
80369
+ */
80370
+ contrast?: number;
80371
+ /**
80372
+ * Specifies the number of points that are cropped off the bottom of the picture.
80373
+ *
80374
+ * @remarks
80375
+ * [Api set: ExcelApiDesktop 1.1]
80376
+ */
80377
+ cropBottom?: number;
80378
+ /**
80379
+ * Specifies the number of points that are cropped off the left side of the picture.
80380
+ *
80381
+ * @remarks
80382
+ * [Api set: ExcelApiDesktop 1.1]
80383
+ */
80384
+ cropLeft?: number;
80385
+ /**
80386
+ * Specifies the number of points that are cropped off the right side of the picture.
80387
+ *
80388
+ * @remarks
80389
+ * [Api set: ExcelApiDesktop 1.1]
80390
+ */
80391
+ cropRight?: number;
80392
+ /**
80393
+ * Specifies the number of points that are cropped off the top of the picture.
80394
+ *
80395
+ * @remarks
80396
+ * [Api set: ExcelApiDesktop 1.1]
80397
+ */
80398
+ cropTop?: number;
80399
+ /**
80400
+ * Specifies the URL (on the intranet or the web) or path (local or network) to the location where the source object is saved.
80401
+ *
80402
+ * @remarks
80403
+ * [Api set: ExcelApiDesktop 1.1]
80404
+ */
80405
+ filename?: string;
80406
+ /**
80407
+ * Specifies the height of the picture in points.
80408
+ *
80409
+ * @remarks
80410
+ * [Api set: ExcelApiDesktop 1.1]
80411
+ */
80412
+ height?: number;
80413
+ /**
80414
+ * Specifies a value that indicates whether the picture retains its original proportions when resized. `true` if it retains its proportions; otherwise, `false`.
80415
+ *
80416
+ * @remarks
80417
+ * [Api set: ExcelApiDesktop 1.1]
80418
+ */
80419
+ lockAspectRatio?: boolean;
80420
+ /**
80421
+ * Specifies the width of the picture in points.
80422
+ *
80423
+ * @remarks
80424
+ * [Api set: ExcelApiDesktop 1.1]
80425
+ */
80426
+ width?: number;
80427
+ }
78721
80428
  /** An interface describing the data returned by calling `pageBreak.toJSON()`. */
78722
80429
  interface PageBreakData {
78723
80430
  /**
@@ -79059,6 +80766,55 @@ declare namespace Excel {
79059
80766
  }
79060
80767
  /** An interface describing the data returned by calling `image.toJSON()`. */
79061
80768
  interface ImageData {
80769
+ /**
80770
+ * Specifies the brightness of the image. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest).
80771
+ *
80772
+ * @remarks
80773
+ * [Api set: ExcelApiDesktop 1.1]
80774
+ */
80775
+ brightness?: number;
80776
+ /**
80777
+ * Specifies the type of color transformation applied to the image.
80778
+ *
80779
+ * @remarks
80780
+ * [Api set: ExcelApiDesktop 1.1]
80781
+ */
80782
+ colorType?: Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark";
80783
+ /**
80784
+ * 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).
80785
+ *
80786
+ * @remarks
80787
+ * [Api set: ExcelApiDesktop 1.1]
80788
+ */
80789
+ contrast?: number;
80790
+ /**
80791
+ * Specifies the number of points that are cropped off the bottom of the image.
80792
+ *
80793
+ * @remarks
80794
+ * [Api set: ExcelApiDesktop 1.1]
80795
+ */
80796
+ cropBottom?: number;
80797
+ /**
80798
+ * Specifies the number of points that are cropped off the left side of the image.
80799
+ *
80800
+ * @remarks
80801
+ * [Api set: ExcelApiDesktop 1.1]
80802
+ */
80803
+ cropLeft?: number;
80804
+ /**
80805
+ * Specifies the number of points that are cropped off the right side of the image.
80806
+ *
80807
+ * @remarks
80808
+ * [Api set: ExcelApiDesktop 1.1]
80809
+ */
80810
+ cropRight?: number;
80811
+ /**
80812
+ * Specifies the number of points that are cropped off the top of the image.
80813
+ *
80814
+ * @remarks
80815
+ * [Api set: ExcelApiDesktop 1.1]
80816
+ */
80817
+ cropTop?: number;
79062
80818
  /**
79063
80819
  * Specifies the shape identifier for the image object.
79064
80820
  *
@@ -79673,6 +81429,314 @@ declare namespace Excel {
79673
81429
  */
79674
81430
  width?: number;
79675
81431
  }
81432
+ /** An interface describing the data returned by calling `window.toJSON()`. */
81433
+ interface WindowData {
81434
+ /**
81435
+ * Gets the active cell in the window.
81436
+ *
81437
+ * @remarks
81438
+ * [Api set: ExcelApiDesktop 1.1]
81439
+ */
81440
+ activeCell?: Excel.Interfaces.RangeData;
81441
+ /**
81442
+ * Gets the active pane in the window.
81443
+ *
81444
+ * @remarks
81445
+ * [Api set: ExcelApiDesktop 1.1]
81446
+ */
81447
+ activePane?: Excel.Interfaces.PaneData;
81448
+ /**
81449
+ * Gets the active worksheet in the window.
81450
+ *
81451
+ * @remarks
81452
+ * [Api set: ExcelApiDesktop 1.1]
81453
+ */
81454
+ activeWorksheet?: Excel.Interfaces.WorksheetData;
81455
+ /**
81456
+ * Gets a collection of panes associated with the window.
81457
+ *
81458
+ * @remarks
81459
+ * [Api set: ExcelApiDesktop 1.1]
81460
+ */
81461
+ panes?: Excel.Interfaces.PaneData[];
81462
+ /**
81463
+ * Gets the visible range of the window.
81464
+ *
81465
+ * @remarks
81466
+ * [Api set: ExcelApiDesktop 1.1]
81467
+ */
81468
+ visibleRange?: Excel.Interfaces.RangeData;
81469
+ /**
81470
+ * Specifies whether AutoFilter date grouping is enabled in the window.
81471
+ *
81472
+ * @remarks
81473
+ * [Api set: ExcelApiDesktop 1.1]
81474
+ */
81475
+ autoFilterDateGroupingEnabled?: boolean;
81476
+ /**
81477
+ * Specifies whether resizing is enabled for the window.
81478
+ *
81479
+ * @remarks
81480
+ * [Api set: ExcelApiDesktop 1.1]
81481
+ */
81482
+ enableResize?: boolean;
81483
+ /**
81484
+ * Specifies whether panes are frozen in the window.
81485
+ *
81486
+ * @remarks
81487
+ * [Api set: ExcelApiDesktop 1.1]
81488
+ */
81489
+ freezePanes?: boolean;
81490
+ /**
81491
+ * Specifies the height of the window.
81492
+ *
81493
+ * @remarks
81494
+ * [Api set: ExcelApiDesktop 1.1]
81495
+ */
81496
+ height?: number;
81497
+ /**
81498
+ * Gets the index of the window.
81499
+ *
81500
+ * @remarks
81501
+ * [Api set: ExcelApiDesktop 1.1]
81502
+ */
81503
+ index?: number;
81504
+ /**
81505
+ * Specifies whether the window is visible.
81506
+ *
81507
+ * @remarks
81508
+ * [Api set: ExcelApiDesktop 1.1]
81509
+ */
81510
+ isVisible?: boolean;
81511
+ /**
81512
+ * Specifies the distance, in points, from the left edge of the computer screen to the left edge of the window.
81513
+ *
81514
+ * @remarks
81515
+ * [Api set: ExcelApiDesktop 1.1]
81516
+ */
81517
+ left?: number;
81518
+ /**
81519
+ * Specifies the name of the window.
81520
+ *
81521
+ * @remarks
81522
+ * [Api set: ExcelApiDesktop 1.1]
81523
+ */
81524
+ name?: string;
81525
+ /**
81526
+ * Specifies the scroll column of the window.
81527
+ *
81528
+ * @remarks
81529
+ * [Api set: ExcelApiDesktop 1.1]
81530
+ */
81531
+ scrollColumn?: number;
81532
+ /**
81533
+ * Specifies the scroll row of the window.
81534
+ *
81535
+ * @remarks
81536
+ * [Api set: ExcelApiDesktop 1.1]
81537
+ */
81538
+ scrollRow?: number;
81539
+ /**
81540
+ * Specifies whether formulas are shown in the window.
81541
+ *
81542
+ * @remarks
81543
+ * [Api set: ExcelApiDesktop 1.1]
81544
+ */
81545
+ showFormulas?: boolean;
81546
+ /**
81547
+ * Specifies whether gridlines are shown in the window.
81548
+ *
81549
+ * @remarks
81550
+ * [Api set: ExcelApiDesktop 1.1]
81551
+ */
81552
+ showGridlines?: boolean;
81553
+ /**
81554
+ * Specifies whether headings are shown in the window.
81555
+ *
81556
+ * @remarks
81557
+ * [Api set: ExcelApiDesktop 1.1]
81558
+ */
81559
+ showHeadings?: boolean;
81560
+ /**
81561
+ * Specifies whether the horizontal scroll bar is shown in the window.
81562
+ *
81563
+ * @remarks
81564
+ * [Api set: ExcelApiDesktop 1.1]
81565
+ */
81566
+ showHorizontalScrollBar?: boolean;
81567
+ /**
81568
+ * Specifies whether outline is shown in the window.
81569
+ *
81570
+ * @remarks
81571
+ * [Api set: ExcelApiDesktop 1.1]
81572
+ */
81573
+ showOutline?: boolean;
81574
+ /**
81575
+ * 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.
81576
+ *
81577
+ * @remarks
81578
+ * [Api set: ExcelApiDesktop 1.1]
81579
+ */
81580
+ showRightToLeft?: boolean;
81581
+ /**
81582
+ * Specifies whether the ruler is shown in the window.
81583
+ *
81584
+ * @remarks
81585
+ * [Api set: ExcelApiDesktop 1.1]
81586
+ */
81587
+ showRuler?: boolean;
81588
+ /**
81589
+ * Specifies whether the vertical scroll bar is shown in the window.
81590
+ *
81591
+ * @remarks
81592
+ * [Api set: ExcelApiDesktop 1.1]
81593
+ */
81594
+ showVerticalScrollBar?: boolean;
81595
+ /**
81596
+ * Specifies whether whitespace is shown in the window.
81597
+ *
81598
+ * @remarks
81599
+ * [Api set: ExcelApiDesktop 1.1]
81600
+ */
81601
+ showWhitespace?: boolean;
81602
+ /**
81603
+ * Specifies whether workbook tabs are shown in the window.
81604
+ *
81605
+ * @remarks
81606
+ * [Api set: ExcelApiDesktop 1.1]
81607
+ */
81608
+ showWorkbookTabs?: boolean;
81609
+ /**
81610
+ * Specifies whether zeroes are shown in the window.
81611
+ *
81612
+ * @remarks
81613
+ * [Api set: ExcelApiDesktop 1.1]
81614
+ */
81615
+ showZeros?: boolean;
81616
+ /**
81617
+ * Specifies the split state of the window.
81618
+ *
81619
+ * @remarks
81620
+ * [Api set: ExcelApiDesktop 1.1]
81621
+ */
81622
+ split?: boolean;
81623
+ /**
81624
+ * Specifies the split column of the window.
81625
+ *
81626
+ * @remarks
81627
+ * [Api set: ExcelApiDesktop 1.1]
81628
+ */
81629
+ splitColumn?: number;
81630
+ /**
81631
+ * Specifies the horizontal split of the window.
81632
+ *
81633
+ * @remarks
81634
+ * [Api set: ExcelApiDesktop 1.1]
81635
+ */
81636
+ splitHorizontal?: number;
81637
+ /**
81638
+ * Specifies the split row of the window.
81639
+ *
81640
+ * @remarks
81641
+ * [Api set: ExcelApiDesktop 1.1]
81642
+ */
81643
+ splitRow?: number;
81644
+ /**
81645
+ * Specifies the vertical split of the window.
81646
+ *
81647
+ * @remarks
81648
+ * [Api set: ExcelApiDesktop 1.1]
81649
+ */
81650
+ splitVertical?: number;
81651
+ /**
81652
+ * Specifies the tab ratio of the window.
81653
+ *
81654
+ * @remarks
81655
+ * [Api set: ExcelApiDesktop 1.1]
81656
+ */
81657
+ tabRatio?: number;
81658
+ /**
81659
+ * 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).
81660
+ *
81661
+ * @remarks
81662
+ * [Api set: ExcelApiDesktop 1.1]
81663
+ */
81664
+ top?: number;
81665
+ /**
81666
+ * Specifies the type of the window.
81667
+ *
81668
+ * @remarks
81669
+ * [Api set: ExcelApiDesktop 1.1]
81670
+ */
81671
+ type?: Excel.WindowType | "chartAsWindow" | "chartInPlace" | "clipboard" | "workbook";
81672
+ /**
81673
+ * Gets the usable height of the window.
81674
+ *
81675
+ * @remarks
81676
+ * [Api set: ExcelApiDesktop 1.1]
81677
+ */
81678
+ usableHeight?: number;
81679
+ /**
81680
+ * Gets the usable width of the window.
81681
+ *
81682
+ * @remarks
81683
+ * [Api set: ExcelApiDesktop 1.1]
81684
+ */
81685
+ usableWidth?: number;
81686
+ /**
81687
+ * Specifies the view of the window.
81688
+ *
81689
+ * @remarks
81690
+ * [Api set: ExcelApiDesktop 1.1]
81691
+ */
81692
+ view?: Excel.WindowView | "normalView" | "pageBreakPreview" | "pageLayoutView";
81693
+ /**
81694
+ * Specifies the display width of the window.
81695
+ *
81696
+ * @remarks
81697
+ * [Api set: ExcelApiDesktop 1.1]
81698
+ */
81699
+ width?: number;
81700
+ /**
81701
+ * Gets the window number.
81702
+ *
81703
+ * @remarks
81704
+ * [Api set: ExcelApiDesktop 1.1]
81705
+ */
81706
+ windowNumber?: number;
81707
+ /**
81708
+ * Specifies the window state.
81709
+ *
81710
+ * @remarks
81711
+ * [Api set: ExcelApiDesktop 1.1]
81712
+ */
81713
+ windowState?: Excel.WindowState | "maximized" | "minimized" | "normal";
81714
+ /**
81715
+ * Specifies an integer value that represents the display size of the window. It can be set to a percentage between 10 and 400.
81716
+ *
81717
+ * @remarks
81718
+ * [Api set: ExcelApiDesktop 1.1]
81719
+ */
81720
+ zoom?: number;
81721
+ }
81722
+ /** An interface describing the data returned by calling `windowCollection.toJSON()`. */
81723
+ interface WindowCollectionData {
81724
+ items?: Excel.Interfaces.WindowData[];
81725
+ }
81726
+ /** An interface describing the data returned by calling `pane.toJSON()`. */
81727
+ interface PaneData {
81728
+ /**
81729
+ * Returns index of the pane.
81730
+ *
81731
+ * @remarks
81732
+ * [Api set: ExcelApiDesktop 1.1]
81733
+ */
81734
+ index?: number;
81735
+ }
81736
+ /** An interface describing the data returned by calling `paneCollection.toJSON()`. */
81737
+ interface PaneCollectionData {
81738
+ items?: Excel.Interfaces.PaneData[];
81739
+ }
79676
81740
  /** An interface describing the data returned by calling `functionResult.toJSON()`. */
79677
81741
  interface FunctionResultData<T> {
79678
81742
  /**
@@ -79951,6 +82015,13 @@ declare namespace Excel {
79951
82015
  */
79952
82016
  $all?: boolean;
79953
82017
  /**
82018
+ * Returns a `window` object that represents the active window (the window on top).
82019
+ *
82020
+ * @remarks
82021
+ * [Api set: ExcelApiDesktop 1.1]
82022
+ */
82023
+ activeWindow?: Excel.Interfaces.WindowLoadOptions;
82024
+ /**
79954
82025
  * Provides information based on current system culture settings. This includes the culture names, number formatting, and other culturally dependent settings.
79955
82026
  *
79956
82027
  * @remarks
@@ -80585,6 +82656,13 @@ declare namespace Excel {
80585
82656
  * [Api set: ExcelApi 1.18]
80586
82657
  */
80587
82658
  control?: boolean;
82659
+ /**
82660
+ * Specifies the array formula of a range. If the specified range doesn't contain an array formula, this property returns `null`.
82661
+ *
82662
+ * @remarks
82663
+ * [Api set: ExcelApiDesktop 1.1]
82664
+ */
82665
+ formulaArray?: boolean;
80588
82666
  /**
80589
82667
  * Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead.
80590
82668
  *
@@ -88620,6 +90698,13 @@ declare namespace Excel {
88620
90698
  * [Api set: ExcelApi 1.9]
88621
90699
  */
88622
90700
  headersFooters?: Excel.Interfaces.HeaderFooterGroupLoadOptions;
90701
+ /**
90702
+ * Specifies whether Excel aligns the header and the footer with the margins set in the page setup options.
90703
+ *
90704
+ * @remarks
90705
+ * [Api set: ExcelApiDesktop 1.1]
90706
+ */
90707
+ alignMarginsHeaderFooter?: boolean;
88623
90708
  /**
88624
90709
  * The worksheet's black and white print option.
88625
90710
  *
@@ -88732,6 +90817,15 @@ declare namespace Excel {
88732
90817
  * [Api set: ExcelApi 1.9]
88733
90818
  */
88734
90819
  printOrder?: boolean;
90820
+ /**
90821
+ * Specifies a two-element array that contains both horizontal and vertical print quality values.
90822
+ The first element is the horizontal print quality, and the second element is the vertical print quality.
90823
+ Some printers may not support vertical print quality and the supported values may vary by printer.
90824
+ *
90825
+ * @remarks
90826
+ * [Api set: ExcelApiDesktop 1.1]
90827
+ */
90828
+ printQuality?: boolean;
88735
90829
  /**
88736
90830
  * The worksheet's right margin, in points, for use when printing.
88737
90831
  *
@@ -88764,6 +90858,48 @@ declare namespace Excel {
88764
90858
  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`).
88765
90859
  */
88766
90860
  $all?: boolean;
90861
+ /**
90862
+ * Gets a `HeaderFooterPicture` object that represents the picture for the center section of the footer.
90863
+ *
90864
+ * @remarks
90865
+ * [Api set: ExcelApiDesktop 1.1]
90866
+ */
90867
+ centerFooterPicture?: Excel.Interfaces.HeaderFooterPictureLoadOptions;
90868
+ /**
90869
+ * Gets a `HeaderFooterPicture` object that represents the picture for the center section of the header.
90870
+ *
90871
+ * @remarks
90872
+ * [Api set: ExcelApiDesktop 1.1]
90873
+ */
90874
+ centerHeaderPicture?: Excel.Interfaces.HeaderFooterPictureLoadOptions;
90875
+ /**
90876
+ * Gets a `HeaderFooterPicture` object that represents the picture for the left section of the footer.
90877
+ *
90878
+ * @remarks
90879
+ * [Api set: ExcelApiDesktop 1.1]
90880
+ */
90881
+ leftFooterPicture?: Excel.Interfaces.HeaderFooterPictureLoadOptions;
90882
+ /**
90883
+ * Gets a `HeaderFooterPicture` object that represents the picture for the left section of the header.
90884
+ *
90885
+ * @remarks
90886
+ * [Api set: ExcelApiDesktop 1.1]
90887
+ */
90888
+ leftHeaderPicture?: Excel.Interfaces.HeaderFooterPictureLoadOptions;
90889
+ /**
90890
+ * Gets a `HeaderFooterPicture` object that represents the picture for the right section of the footer.
90891
+ *
90892
+ * @remarks
90893
+ * [Api set: ExcelApiDesktop 1.1]
90894
+ */
90895
+ rightFooterPicture?: Excel.Interfaces.HeaderFooterPictureLoadOptions;
90896
+ /**
90897
+ * Gets a `HeaderFooterPicture` object that represents the picture for the right section of the header.
90898
+ *
90899
+ * @remarks
90900
+ * [Api set: ExcelApiDesktop 1.1]
90901
+ */
90902
+ rightHeaderPicture?: Excel.Interfaces.HeaderFooterPictureLoadOptions;
88767
90903
  /**
88768
90904
  * The center footer of the worksheet.
88769
90905
  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 {
88872
91008
  */
88873
91009
  useSheetScale?: boolean;
88874
91010
  }
91011
+ /**
91012
+ * Represents a picture in the header or footer of a worksheet.
91013
+ *
91014
+ * @remarks
91015
+ * [Api set: ExcelApiDesktop 1.1]
91016
+ */
91017
+ interface HeaderFooterPictureLoadOptions {
91018
+ /**
91019
+ 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`).
91020
+ */
91021
+ $all?: boolean;
91022
+ /**
91023
+ * Specifies the brightness of the picture. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest).
91024
+ *
91025
+ * @remarks
91026
+ * [Api set: ExcelApiDesktop 1.1]
91027
+ */
91028
+ brightness?: boolean;
91029
+ /**
91030
+ * Specifies the type of color transformation of the picture.
91031
+ *
91032
+ * @remarks
91033
+ * [Api set: ExcelApiDesktop 1.1]
91034
+ */
91035
+ colorType?: boolean;
91036
+ /**
91037
+ * 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).
91038
+ *
91039
+ * @remarks
91040
+ * [Api set: ExcelApiDesktop 1.1]
91041
+ */
91042
+ contrast?: boolean;
91043
+ /**
91044
+ * Specifies the number of points that are cropped off the bottom of the picture.
91045
+ *
91046
+ * @remarks
91047
+ * [Api set: ExcelApiDesktop 1.1]
91048
+ */
91049
+ cropBottom?: boolean;
91050
+ /**
91051
+ * Specifies the number of points that are cropped off the left side of the picture.
91052
+ *
91053
+ * @remarks
91054
+ * [Api set: ExcelApiDesktop 1.1]
91055
+ */
91056
+ cropLeft?: boolean;
91057
+ /**
91058
+ * Specifies the number of points that are cropped off the right side of the picture.
91059
+ *
91060
+ * @remarks
91061
+ * [Api set: ExcelApiDesktop 1.1]
91062
+ */
91063
+ cropRight?: boolean;
91064
+ /**
91065
+ * Specifies the number of points that are cropped off the top of the picture.
91066
+ *
91067
+ * @remarks
91068
+ * [Api set: ExcelApiDesktop 1.1]
91069
+ */
91070
+ cropTop?: boolean;
91071
+ /**
91072
+ * Specifies the URL (on the intranet or the web) or path (local or network) to the location where the source object is saved.
91073
+ *
91074
+ * @remarks
91075
+ * [Api set: ExcelApiDesktop 1.1]
91076
+ */
91077
+ filename?: boolean;
91078
+ /**
91079
+ * Specifies the height of the picture in points.
91080
+ *
91081
+ * @remarks
91082
+ * [Api set: ExcelApiDesktop 1.1]
91083
+ */
91084
+ height?: boolean;
91085
+ /**
91086
+ * Specifies a value that indicates whether the picture retains its original proportions when resized. `true` if it retains its proportions; otherwise, `false`.
91087
+ *
91088
+ * @remarks
91089
+ * [Api set: ExcelApiDesktop 1.1]
91090
+ */
91091
+ lockAspectRatio?: boolean;
91092
+ /**
91093
+ * Specifies the width of the picture in points.
91094
+ *
91095
+ * @remarks
91096
+ * [Api set: ExcelApiDesktop 1.1]
91097
+ */
91098
+ width?: boolean;
91099
+ }
88875
91100
  /**
88876
91101
  * @remarks
88877
91102
  * [Api set: ExcelApi 1.9]
@@ -89000,6 +91225,13 @@ declare namespace Excel {
89000
91225
  * [Api set: ExcelApi 1.18]
89001
91226
  */
89002
91227
  control?: boolean;
91228
+ /**
91229
+ * 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`.
91230
+ *
91231
+ * @remarks
91232
+ * [Api set: ExcelApiDesktop 1.1]
91233
+ */
91234
+ formulaArray?: boolean;
89003
91235
  /**
89004
91236
  * For EACH ITEM in the collection: Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead.
89005
91237
  *
@@ -90025,6 +92257,55 @@ declare namespace Excel {
90025
92257
  * [Api set: ExcelApi 1.9]
90026
92258
  */
90027
92259
  shape?: Excel.Interfaces.ShapeLoadOptions;
92260
+ /**
92261
+ * Specifies the brightness of the image. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest).
92262
+ *
92263
+ * @remarks
92264
+ * [Api set: ExcelApiDesktop 1.1]
92265
+ */
92266
+ brightness?: boolean;
92267
+ /**
92268
+ * Specifies the type of color transformation applied to the image.
92269
+ *
92270
+ * @remarks
92271
+ * [Api set: ExcelApiDesktop 1.1]
92272
+ */
92273
+ colorType?: boolean;
92274
+ /**
92275
+ * 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).
92276
+ *
92277
+ * @remarks
92278
+ * [Api set: ExcelApiDesktop 1.1]
92279
+ */
92280
+ contrast?: boolean;
92281
+ /**
92282
+ * Specifies the number of points that are cropped off the bottom of the image.
92283
+ *
92284
+ * @remarks
92285
+ * [Api set: ExcelApiDesktop 1.1]
92286
+ */
92287
+ cropBottom?: boolean;
92288
+ /**
92289
+ * Specifies the number of points that are cropped off the left side of the image.
92290
+ *
92291
+ * @remarks
92292
+ * [Api set: ExcelApiDesktop 1.1]
92293
+ */
92294
+ cropLeft?: boolean;
92295
+ /**
92296
+ * Specifies the number of points that are cropped off the right side of the image.
92297
+ *
92298
+ * @remarks
92299
+ * [Api set: ExcelApiDesktop 1.1]
92300
+ */
92301
+ cropRight?: boolean;
92302
+ /**
92303
+ * Specifies the number of points that are cropped off the top of the image.
92304
+ *
92305
+ * @remarks
92306
+ * [Api set: ExcelApiDesktop 1.1]
92307
+ */
92308
+ cropTop?: boolean;
90028
92309
  /**
90029
92310
  * Specifies the shape identifier for the image object.
90030
92311
  *
@@ -91279,6 +93560,628 @@ declare namespace Excel {
91279
93560
  */
91280
93561
  width?: boolean;
91281
93562
  }
93563
+ /**
93564
+ * Represents a window in the workbook.
93565
+ *
93566
+ * @remarks
93567
+ * [Api set: ExcelApiDesktop 1.1]
93568
+ */
93569
+ interface WindowLoadOptions {
93570
+ /**
93571
+ 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`).
93572
+ */
93573
+ $all?: boolean;
93574
+ /**
93575
+ * Gets the active cell in the window.
93576
+ *
93577
+ * @remarks
93578
+ * [Api set: ExcelApiDesktop 1.1]
93579
+ */
93580
+ activeCell?: Excel.Interfaces.RangeLoadOptions;
93581
+ /**
93582
+ * Gets the active pane in the window.
93583
+ *
93584
+ * @remarks
93585
+ * [Api set: ExcelApiDesktop 1.1]
93586
+ */
93587
+ activePane?: Excel.Interfaces.PaneLoadOptions;
93588
+ /**
93589
+ * Gets the active worksheet in the window.
93590
+ *
93591
+ * @remarks
93592
+ * [Api set: ExcelApiDesktop 1.1]
93593
+ */
93594
+ activeWorksheet?: Excel.Interfaces.WorksheetLoadOptions;
93595
+ /**
93596
+ * Gets the visible range of the window.
93597
+ *
93598
+ * @remarks
93599
+ * [Api set: ExcelApiDesktop 1.1]
93600
+ */
93601
+ visibleRange?: Excel.Interfaces.RangeLoadOptions;
93602
+ /**
93603
+ * Specifies whether AutoFilter date grouping is enabled in the window.
93604
+ *
93605
+ * @remarks
93606
+ * [Api set: ExcelApiDesktop 1.1]
93607
+ */
93608
+ autoFilterDateGroupingEnabled?: boolean;
93609
+ /**
93610
+ * Specifies whether resizing is enabled for the window.
93611
+ *
93612
+ * @remarks
93613
+ * [Api set: ExcelApiDesktop 1.1]
93614
+ */
93615
+ enableResize?: boolean;
93616
+ /**
93617
+ * Specifies whether panes are frozen in the window.
93618
+ *
93619
+ * @remarks
93620
+ * [Api set: ExcelApiDesktop 1.1]
93621
+ */
93622
+ freezePanes?: boolean;
93623
+ /**
93624
+ * Specifies the height of the window.
93625
+ *
93626
+ * @remarks
93627
+ * [Api set: ExcelApiDesktop 1.1]
93628
+ */
93629
+ height?: boolean;
93630
+ /**
93631
+ * Gets the index of the window.
93632
+ *
93633
+ * @remarks
93634
+ * [Api set: ExcelApiDesktop 1.1]
93635
+ */
93636
+ index?: boolean;
93637
+ /**
93638
+ * Specifies whether the window is visible.
93639
+ *
93640
+ * @remarks
93641
+ * [Api set: ExcelApiDesktop 1.1]
93642
+ */
93643
+ isVisible?: boolean;
93644
+ /**
93645
+ * Specifies the distance, in points, from the left edge of the computer screen to the left edge of the window.
93646
+ *
93647
+ * @remarks
93648
+ * [Api set: ExcelApiDesktop 1.1]
93649
+ */
93650
+ left?: boolean;
93651
+ /**
93652
+ * Specifies the name of the window.
93653
+ *
93654
+ * @remarks
93655
+ * [Api set: ExcelApiDesktop 1.1]
93656
+ */
93657
+ name?: boolean;
93658
+ /**
93659
+ * Specifies the scroll column of the window.
93660
+ *
93661
+ * @remarks
93662
+ * [Api set: ExcelApiDesktop 1.1]
93663
+ */
93664
+ scrollColumn?: boolean;
93665
+ /**
93666
+ * Specifies the scroll row of the window.
93667
+ *
93668
+ * @remarks
93669
+ * [Api set: ExcelApiDesktop 1.1]
93670
+ */
93671
+ scrollRow?: boolean;
93672
+ /**
93673
+ * Specifies whether formulas are shown in the window.
93674
+ *
93675
+ * @remarks
93676
+ * [Api set: ExcelApiDesktop 1.1]
93677
+ */
93678
+ showFormulas?: boolean;
93679
+ /**
93680
+ * Specifies whether gridlines are shown in the window.
93681
+ *
93682
+ * @remarks
93683
+ * [Api set: ExcelApiDesktop 1.1]
93684
+ */
93685
+ showGridlines?: boolean;
93686
+ /**
93687
+ * Specifies whether headings are shown in the window.
93688
+ *
93689
+ * @remarks
93690
+ * [Api set: ExcelApiDesktop 1.1]
93691
+ */
93692
+ showHeadings?: boolean;
93693
+ /**
93694
+ * Specifies whether the horizontal scroll bar is shown in the window.
93695
+ *
93696
+ * @remarks
93697
+ * [Api set: ExcelApiDesktop 1.1]
93698
+ */
93699
+ showHorizontalScrollBar?: boolean;
93700
+ /**
93701
+ * Specifies whether outline is shown in the window.
93702
+ *
93703
+ * @remarks
93704
+ * [Api set: ExcelApiDesktop 1.1]
93705
+ */
93706
+ showOutline?: boolean;
93707
+ /**
93708
+ * 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.
93709
+ *
93710
+ * @remarks
93711
+ * [Api set: ExcelApiDesktop 1.1]
93712
+ */
93713
+ showRightToLeft?: boolean;
93714
+ /**
93715
+ * Specifies whether the ruler is shown in the window.
93716
+ *
93717
+ * @remarks
93718
+ * [Api set: ExcelApiDesktop 1.1]
93719
+ */
93720
+ showRuler?: boolean;
93721
+ /**
93722
+ * Specifies whether the vertical scroll bar is shown in the window.
93723
+ *
93724
+ * @remarks
93725
+ * [Api set: ExcelApiDesktop 1.1]
93726
+ */
93727
+ showVerticalScrollBar?: boolean;
93728
+ /**
93729
+ * Specifies whether whitespace is shown in the window.
93730
+ *
93731
+ * @remarks
93732
+ * [Api set: ExcelApiDesktop 1.1]
93733
+ */
93734
+ showWhitespace?: boolean;
93735
+ /**
93736
+ * Specifies whether workbook tabs are shown in the window.
93737
+ *
93738
+ * @remarks
93739
+ * [Api set: ExcelApiDesktop 1.1]
93740
+ */
93741
+ showWorkbookTabs?: boolean;
93742
+ /**
93743
+ * Specifies whether zeroes are shown in the window.
93744
+ *
93745
+ * @remarks
93746
+ * [Api set: ExcelApiDesktop 1.1]
93747
+ */
93748
+ showZeros?: boolean;
93749
+ /**
93750
+ * Specifies the split state of the window.
93751
+ *
93752
+ * @remarks
93753
+ * [Api set: ExcelApiDesktop 1.1]
93754
+ */
93755
+ split?: boolean;
93756
+ /**
93757
+ * Specifies the split column of the window.
93758
+ *
93759
+ * @remarks
93760
+ * [Api set: ExcelApiDesktop 1.1]
93761
+ */
93762
+ splitColumn?: boolean;
93763
+ /**
93764
+ * Specifies the horizontal split of the window.
93765
+ *
93766
+ * @remarks
93767
+ * [Api set: ExcelApiDesktop 1.1]
93768
+ */
93769
+ splitHorizontal?: boolean;
93770
+ /**
93771
+ * Specifies the split row of the window.
93772
+ *
93773
+ * @remarks
93774
+ * [Api set: ExcelApiDesktop 1.1]
93775
+ */
93776
+ splitRow?: boolean;
93777
+ /**
93778
+ * Specifies the vertical split of the window.
93779
+ *
93780
+ * @remarks
93781
+ * [Api set: ExcelApiDesktop 1.1]
93782
+ */
93783
+ splitVertical?: boolean;
93784
+ /**
93785
+ * Specifies the tab ratio of the window.
93786
+ *
93787
+ * @remarks
93788
+ * [Api set: ExcelApiDesktop 1.1]
93789
+ */
93790
+ tabRatio?: boolean;
93791
+ /**
93792
+ * 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).
93793
+ *
93794
+ * @remarks
93795
+ * [Api set: ExcelApiDesktop 1.1]
93796
+ */
93797
+ top?: boolean;
93798
+ /**
93799
+ * Specifies the type of the window.
93800
+ *
93801
+ * @remarks
93802
+ * [Api set: ExcelApiDesktop 1.1]
93803
+ */
93804
+ type?: boolean;
93805
+ /**
93806
+ * Gets the usable height of the window.
93807
+ *
93808
+ * @remarks
93809
+ * [Api set: ExcelApiDesktop 1.1]
93810
+ */
93811
+ usableHeight?: boolean;
93812
+ /**
93813
+ * Gets the usable width of the window.
93814
+ *
93815
+ * @remarks
93816
+ * [Api set: ExcelApiDesktop 1.1]
93817
+ */
93818
+ usableWidth?: boolean;
93819
+ /**
93820
+ * Specifies the view of the window.
93821
+ *
93822
+ * @remarks
93823
+ * [Api set: ExcelApiDesktop 1.1]
93824
+ */
93825
+ view?: boolean;
93826
+ /**
93827
+ * Specifies the display width of the window.
93828
+ *
93829
+ * @remarks
93830
+ * [Api set: ExcelApiDesktop 1.1]
93831
+ */
93832
+ width?: boolean;
93833
+ /**
93834
+ * Gets the window number.
93835
+ *
93836
+ * @remarks
93837
+ * [Api set: ExcelApiDesktop 1.1]
93838
+ */
93839
+ windowNumber?: boolean;
93840
+ /**
93841
+ * Specifies the window state.
93842
+ *
93843
+ * @remarks
93844
+ * [Api set: ExcelApiDesktop 1.1]
93845
+ */
93846
+ windowState?: boolean;
93847
+ /**
93848
+ * Specifies an integer value that represents the display size of the window. It can be set to a percentage between 10 and 400.
93849
+ *
93850
+ * @remarks
93851
+ * [Api set: ExcelApiDesktop 1.1]
93852
+ */
93853
+ zoom?: boolean;
93854
+ }
93855
+ /**
93856
+ * Represents a collection of Window objects.
93857
+ *
93858
+ * @remarks
93859
+ * [Api set: ExcelApiDesktop 1.1]
93860
+ */
93861
+ interface WindowCollectionLoadOptions {
93862
+ /**
93863
+ 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`).
93864
+ */
93865
+ $all?: boolean;
93866
+ /**
93867
+ * For EACH ITEM in the collection: Gets the active cell in the window.
93868
+ *
93869
+ * @remarks
93870
+ * [Api set: ExcelApiDesktop 1.1]
93871
+ */
93872
+ activeCell?: Excel.Interfaces.RangeLoadOptions;
93873
+ /**
93874
+ * For EACH ITEM in the collection: Gets the active pane in the window.
93875
+ *
93876
+ * @remarks
93877
+ * [Api set: ExcelApiDesktop 1.1]
93878
+ */
93879
+ activePane?: Excel.Interfaces.PaneLoadOptions;
93880
+ /**
93881
+ * For EACH ITEM in the collection: Gets the active worksheet in the window.
93882
+ *
93883
+ * @remarks
93884
+ * [Api set: ExcelApiDesktop 1.1]
93885
+ */
93886
+ activeWorksheet?: Excel.Interfaces.WorksheetLoadOptions;
93887
+ /**
93888
+ * For EACH ITEM in the collection: Gets the visible range of the window.
93889
+ *
93890
+ * @remarks
93891
+ * [Api set: ExcelApiDesktop 1.1]
93892
+ */
93893
+ visibleRange?: Excel.Interfaces.RangeLoadOptions;
93894
+ /**
93895
+ * For EACH ITEM in the collection: Specifies whether AutoFilter date grouping is enabled in the window.
93896
+ *
93897
+ * @remarks
93898
+ * [Api set: ExcelApiDesktop 1.1]
93899
+ */
93900
+ autoFilterDateGroupingEnabled?: boolean;
93901
+ /**
93902
+ * For EACH ITEM in the collection: Specifies whether resizing is enabled for the window.
93903
+ *
93904
+ * @remarks
93905
+ * [Api set: ExcelApiDesktop 1.1]
93906
+ */
93907
+ enableResize?: boolean;
93908
+ /**
93909
+ * For EACH ITEM in the collection: Specifies whether panes are frozen in the window.
93910
+ *
93911
+ * @remarks
93912
+ * [Api set: ExcelApiDesktop 1.1]
93913
+ */
93914
+ freezePanes?: boolean;
93915
+ /**
93916
+ * For EACH ITEM in the collection: Specifies the height of the window.
93917
+ *
93918
+ * @remarks
93919
+ * [Api set: ExcelApiDesktop 1.1]
93920
+ */
93921
+ height?: boolean;
93922
+ /**
93923
+ * For EACH ITEM in the collection: Gets the index of the window.
93924
+ *
93925
+ * @remarks
93926
+ * [Api set: ExcelApiDesktop 1.1]
93927
+ */
93928
+ index?: boolean;
93929
+ /**
93930
+ * For EACH ITEM in the collection: Specifies whether the window is visible.
93931
+ *
93932
+ * @remarks
93933
+ * [Api set: ExcelApiDesktop 1.1]
93934
+ */
93935
+ isVisible?: boolean;
93936
+ /**
93937
+ * 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.
93938
+ *
93939
+ * @remarks
93940
+ * [Api set: ExcelApiDesktop 1.1]
93941
+ */
93942
+ left?: boolean;
93943
+ /**
93944
+ * For EACH ITEM in the collection: Specifies the name of the window.
93945
+ *
93946
+ * @remarks
93947
+ * [Api set: ExcelApiDesktop 1.1]
93948
+ */
93949
+ name?: boolean;
93950
+ /**
93951
+ * For EACH ITEM in the collection: Specifies the scroll column of the window.
93952
+ *
93953
+ * @remarks
93954
+ * [Api set: ExcelApiDesktop 1.1]
93955
+ */
93956
+ scrollColumn?: boolean;
93957
+ /**
93958
+ * For EACH ITEM in the collection: Specifies the scroll row of the window.
93959
+ *
93960
+ * @remarks
93961
+ * [Api set: ExcelApiDesktop 1.1]
93962
+ */
93963
+ scrollRow?: boolean;
93964
+ /**
93965
+ * For EACH ITEM in the collection: Specifies whether formulas are shown in the window.
93966
+ *
93967
+ * @remarks
93968
+ * [Api set: ExcelApiDesktop 1.1]
93969
+ */
93970
+ showFormulas?: boolean;
93971
+ /**
93972
+ * For EACH ITEM in the collection: Specifies whether gridlines are shown in the window.
93973
+ *
93974
+ * @remarks
93975
+ * [Api set: ExcelApiDesktop 1.1]
93976
+ */
93977
+ showGridlines?: boolean;
93978
+ /**
93979
+ * For EACH ITEM in the collection: Specifies whether headings are shown in the window.
93980
+ *
93981
+ * @remarks
93982
+ * [Api set: ExcelApiDesktop 1.1]
93983
+ */
93984
+ showHeadings?: boolean;
93985
+ /**
93986
+ * For EACH ITEM in the collection: Specifies whether the horizontal scroll bar is shown in the window.
93987
+ *
93988
+ * @remarks
93989
+ * [Api set: ExcelApiDesktop 1.1]
93990
+ */
93991
+ showHorizontalScrollBar?: boolean;
93992
+ /**
93993
+ * For EACH ITEM in the collection: Specifies whether outline is shown in the window.
93994
+ *
93995
+ * @remarks
93996
+ * [Api set: ExcelApiDesktop 1.1]
93997
+ */
93998
+ showOutline?: boolean;
93999
+ /**
94000
+ * 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.
94001
+ *
94002
+ * @remarks
94003
+ * [Api set: ExcelApiDesktop 1.1]
94004
+ */
94005
+ showRightToLeft?: boolean;
94006
+ /**
94007
+ * For EACH ITEM in the collection: Specifies whether the ruler is shown in the window.
94008
+ *
94009
+ * @remarks
94010
+ * [Api set: ExcelApiDesktop 1.1]
94011
+ */
94012
+ showRuler?: boolean;
94013
+ /**
94014
+ * For EACH ITEM in the collection: Specifies whether the vertical scroll bar is shown in the window.
94015
+ *
94016
+ * @remarks
94017
+ * [Api set: ExcelApiDesktop 1.1]
94018
+ */
94019
+ showVerticalScrollBar?: boolean;
94020
+ /**
94021
+ * For EACH ITEM in the collection: Specifies whether whitespace is shown in the window.
94022
+ *
94023
+ * @remarks
94024
+ * [Api set: ExcelApiDesktop 1.1]
94025
+ */
94026
+ showWhitespace?: boolean;
94027
+ /**
94028
+ * For EACH ITEM in the collection: Specifies whether workbook tabs are shown in the window.
94029
+ *
94030
+ * @remarks
94031
+ * [Api set: ExcelApiDesktop 1.1]
94032
+ */
94033
+ showWorkbookTabs?: boolean;
94034
+ /**
94035
+ * For EACH ITEM in the collection: Specifies whether zeroes are shown in the window.
94036
+ *
94037
+ * @remarks
94038
+ * [Api set: ExcelApiDesktop 1.1]
94039
+ */
94040
+ showZeros?: boolean;
94041
+ /**
94042
+ * For EACH ITEM in the collection: Specifies the split state of the window.
94043
+ *
94044
+ * @remarks
94045
+ * [Api set: ExcelApiDesktop 1.1]
94046
+ */
94047
+ split?: boolean;
94048
+ /**
94049
+ * For EACH ITEM in the collection: Specifies the split column of the window.
94050
+ *
94051
+ * @remarks
94052
+ * [Api set: ExcelApiDesktop 1.1]
94053
+ */
94054
+ splitColumn?: boolean;
94055
+ /**
94056
+ * For EACH ITEM in the collection: Specifies the horizontal split of the window.
94057
+ *
94058
+ * @remarks
94059
+ * [Api set: ExcelApiDesktop 1.1]
94060
+ */
94061
+ splitHorizontal?: boolean;
94062
+ /**
94063
+ * For EACH ITEM in the collection: Specifies the split row of the window.
94064
+ *
94065
+ * @remarks
94066
+ * [Api set: ExcelApiDesktop 1.1]
94067
+ */
94068
+ splitRow?: boolean;
94069
+ /**
94070
+ * For EACH ITEM in the collection: Specifies the vertical split of the window.
94071
+ *
94072
+ * @remarks
94073
+ * [Api set: ExcelApiDesktop 1.1]
94074
+ */
94075
+ splitVertical?: boolean;
94076
+ /**
94077
+ * For EACH ITEM in the collection: Specifies the tab ratio of the window.
94078
+ *
94079
+ * @remarks
94080
+ * [Api set: ExcelApiDesktop 1.1]
94081
+ */
94082
+ tabRatio?: boolean;
94083
+ /**
94084
+ * 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).
94085
+ *
94086
+ * @remarks
94087
+ * [Api set: ExcelApiDesktop 1.1]
94088
+ */
94089
+ top?: boolean;
94090
+ /**
94091
+ * For EACH ITEM in the collection: Specifies the type of the window.
94092
+ *
94093
+ * @remarks
94094
+ * [Api set: ExcelApiDesktop 1.1]
94095
+ */
94096
+ type?: boolean;
94097
+ /**
94098
+ * For EACH ITEM in the collection: Gets the usable height of the window.
94099
+ *
94100
+ * @remarks
94101
+ * [Api set: ExcelApiDesktop 1.1]
94102
+ */
94103
+ usableHeight?: boolean;
94104
+ /**
94105
+ * For EACH ITEM in the collection: Gets the usable width of the window.
94106
+ *
94107
+ * @remarks
94108
+ * [Api set: ExcelApiDesktop 1.1]
94109
+ */
94110
+ usableWidth?: boolean;
94111
+ /**
94112
+ * For EACH ITEM in the collection: Specifies the view of the window.
94113
+ *
94114
+ * @remarks
94115
+ * [Api set: ExcelApiDesktop 1.1]
94116
+ */
94117
+ view?: boolean;
94118
+ /**
94119
+ * For EACH ITEM in the collection: Specifies the display width of the window.
94120
+ *
94121
+ * @remarks
94122
+ * [Api set: ExcelApiDesktop 1.1]
94123
+ */
94124
+ width?: boolean;
94125
+ /**
94126
+ * For EACH ITEM in the collection: Gets the window number.
94127
+ *
94128
+ * @remarks
94129
+ * [Api set: ExcelApiDesktop 1.1]
94130
+ */
94131
+ windowNumber?: boolean;
94132
+ /**
94133
+ * For EACH ITEM in the collection: Specifies the window state.
94134
+ *
94135
+ * @remarks
94136
+ * [Api set: ExcelApiDesktop 1.1]
94137
+ */
94138
+ windowState?: boolean;
94139
+ /**
94140
+ * 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.
94141
+ *
94142
+ * @remarks
94143
+ * [Api set: ExcelApiDesktop 1.1]
94144
+ */
94145
+ zoom?: boolean;
94146
+ }
94147
+ /**
94148
+ * Represents a pane, such as a frozen or split pane, in an Excel window.
94149
+ *
94150
+ * @remarks
94151
+ * [Api set: ExcelApiDesktop 1.1]
94152
+ */
94153
+ interface PaneLoadOptions {
94154
+ /**
94155
+ 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`).
94156
+ */
94157
+ $all?: boolean;
94158
+ /**
94159
+ * Returns index of the pane.
94160
+ *
94161
+ * @remarks
94162
+ * [Api set: ExcelApiDesktop 1.1]
94163
+ */
94164
+ index?: boolean;
94165
+ }
94166
+ /**
94167
+ * Represents a collection of Pane objects.
94168
+ *
94169
+ * @remarks
94170
+ * [Api set: ExcelApiDesktop 1.1]
94171
+ */
94172
+ interface PaneCollectionLoadOptions {
94173
+ /**
94174
+ 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`).
94175
+ */
94176
+ $all?: boolean;
94177
+ /**
94178
+ * For EACH ITEM in the collection: Returns index of the pane.
94179
+ *
94180
+ * @remarks
94181
+ * [Api set: ExcelApiDesktop 1.1]
94182
+ */
94183
+ index?: boolean;
94184
+ }
91282
94185
  /**
91283
94186
  * An object containing the result of a function-evaluation operation
91284
94187
  *