@types/office-js 1.0.462 → 1.0.464

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/README.md CHANGED
@@ -8,7 +8,7 @@ This package contains type definitions for office-js (https://github.com/OfficeD
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Fri, 31 Jan 2025 18:02:56 GMT
11
+ * Last updated: Fri, 07 Feb 2025 19:32:28 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
office-js/index.d.ts CHANGED
@@ -20626,7 +20626,7 @@ declare namespace Office {
20626
20626
  /**
20627
20627
  * Provides methods to manage an item's session data.
20628
20628
  *
20629
- * **Important**: The entire SessionData object is limited to 50,000 characters per add-in.
20629
+ * Session data is specific to a single mail item. It isn't shared among multiple items even if the same add-in is used to set or retrieve data.
20630
20630
  *
20631
20631
  * @remarks
20632
20632
  * [Api set: Mailbox 1.11]
@@ -20634,6 +20634,8 @@ declare namespace Office {
20634
20634
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
20635
20635
  *
20636
20636
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
20637
+ *
20638
+ * **Important**: For each mail item, the entire SessionData object is limited to 50,000 characters per add-in.
20637
20639
  */
20638
20640
  interface SessionData {
20639
20641
  /**
@@ -20679,7 +20681,7 @@ declare namespace Office {
20679
20681
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter,
20680
20682
  * `asyncResult`, which is an `Office.AsyncResult` object.
20681
20683
  */
20682
- getAllAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
20684
+ getAllAsync(callback: (asyncResult: Office.AsyncResult<object>) => void): void;
20683
20685
  /**
20684
20686
  * Gets the session data value of the specified key.
20685
20687
  *
@@ -20730,15 +20732,15 @@ declare namespace Office {
20730
20732
  /**
20731
20733
  * Sets a session data key-value pair.
20732
20734
  *
20733
- * **Important**: The entire SessionData object is limited to 50,000 characters per add-in.
20734
- *
20735
20735
  * @remarks
20736
20736
  * [Api set: Mailbox 1.11]
20737
20737
  *
20738
20738
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
20739
20739
  *
20740
20740
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
20741
-
20741
+ *
20742
+ * **Important**: For each mail item, the entire SessionData object is limited to 50,000 characters per add-in.
20743
+ *
20742
20744
  * @param name - The session data key.
20743
20745
  * @param value - The session data value as a string.
20744
20746
  * @param options - An object literal that contains one or more of the following properties:-
@@ -20750,15 +20752,15 @@ declare namespace Office {
20750
20752
  /**
20751
20753
  * Sets a session data key-value pair.
20752
20754
  *
20753
- * **Important**: The entire SessionData object is limited to 50,000 characters per add-in.
20754
- *
20755
20755
  * @remarks
20756
20756
  * [Api set: Mailbox 1.11]
20757
20757
  *
20758
20758
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
20759
20759
  *
20760
20760
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
20761
-
20761
+ *
20762
+ * **Important**: For each mail item, the entire SessionData object is limited to 50,000 characters per add-in.
20763
+ *
20762
20764
  * @param name - The session data key.
20763
20765
  * @param value - The session data value as a string.
20764
20766
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
@@ -21867,6 +21869,52 @@ declare namespace OfficeCore {
21867
21869
 
21868
21870
 
21869
21871
  declare namespace Excel {
21872
+ /**
21873
+ * Represents an unknown cell control.
21874
+ * This represents a control that was added in a future version of Excel, and the current version of Excel doesn't know how to display this control.
21875
+ *
21876
+ * @remarks
21877
+ * [Api set: ExcelApi 1.18]
21878
+ */
21879
+ interface UnknownCellControl {
21880
+ type: CellControlType.unknown;
21881
+ }
21882
+ /**
21883
+ * Represents an empty cell control.
21884
+ * This represents the state where a cell does not have a control.
21885
+ *
21886
+ * @remarks
21887
+ * [Api set: ExcelApi 1.18]
21888
+ */
21889
+ interface EmptyCellControl {
21890
+ type: CellControlType.empty;
21891
+ }
21892
+ /**
21893
+ * Represents the result of a query that resulted in multiple cell controls.
21894
+ * If the result has multiple controls, then they can't be represented as a single result.
21895
+ *
21896
+ * @remarks
21897
+ * [Api set: ExcelApi 1.18]
21898
+ */
21899
+ interface MixedCellControl {
21900
+ type: CellControlType.mixed;
21901
+ }
21902
+ /**
21903
+ * Represents a checkbox. This is a cell control that allows a user to toggle the boolean value in a cell.
21904
+ *
21905
+ * @remarks
21906
+ * [Api set: ExcelApi 1.18]
21907
+ */
21908
+ interface CheckboxCellControl {
21909
+ type: CellControlType.checkbox;
21910
+ }
21911
+ /**
21912
+ * Represents an interactable control inside of a cell.
21913
+ *
21914
+ * @remarks
21915
+ * [Api set: ExcelApi 1.18]
21916
+ */
21917
+ type CellControl = UnknownCellControl | EmptyCellControl | MixedCellControl | CheckboxCellControl;
21870
21918
  /**
21871
21919
  * Represents a 2D array of cell values.
21872
21920
  *
@@ -30570,6 +30618,39 @@ declare namespace Excel {
30570
30618
  */
30571
30619
  type: "WorkbookAutoSaveSettingChanged";
30572
30620
  }
30621
+ /**
30622
+ * Represents the type of cell control.
30623
+ *
30624
+ * @remarks
30625
+ * [Api set: ExcelApi 1.18]
30626
+ */
30627
+ enum CellControlType {
30628
+ /**
30629
+ * Type representing an unknown control.
30630
+ This represents a control that was added in a future version of Excel, and the current version of Excel doesn't know how to display this control.
30631
+ * @remarks
30632
+ * [Api set: ExcelApi 1.18]
30633
+ */
30634
+ unknown = "Unknown",
30635
+ /**
30636
+ * Type representing an empty control.
30637
+ * @remarks
30638
+ * [Api set: ExcelApi 1.18]
30639
+ */
30640
+ empty = "Empty",
30641
+ /**
30642
+ * Type representing a query that results in a mix of control results.
30643
+ * @remarks
30644
+ * [Api set: ExcelApi 1.18]
30645
+ */
30646
+ mixed = "Mixed",
30647
+ /**
30648
+ * Type representing a checkbox control.
30649
+ * @remarks
30650
+ * [Api set: ExcelApi 1.18]
30651
+ */
30652
+ checkbox = "Checkbox"
30653
+ }
30573
30654
  /**
30574
30655
  * Represents the direction that existing or remaining cells in a worksheet will shift when cells are inserted into or deleted from a worksheet.
30575
30656
  *
@@ -32047,6 +32128,13 @@ declare namespace Excel {
32047
32128
  * [Api set: ExcelApi 1.1]
32048
32129
  */
32049
32130
  readonly names: Excel.NamedItemCollection;
32131
+ /**
32132
+ * Returns a collection of all the notes objects in the workbook.
32133
+ *
32134
+ * @remarks
32135
+ * [Api set: ExcelApi 1.18]
32136
+ */
32137
+ readonly notes: Excel.NoteCollection;
32050
32138
  /**
32051
32139
  * Represents a collection of PivotTableStyles associated with the workbook.
32052
32140
  *
@@ -32533,6 +32621,13 @@ declare namespace Excel {
32533
32621
  * [Api set: ExcelApi 1.4]
32534
32622
  */
32535
32623
  readonly names: Excel.NamedItemCollection;
32624
+ /**
32625
+ * Returns a collection of all the notes objects in the worksheet.
32626
+ *
32627
+ * @remarks
32628
+ * [Api set: ExcelApi 1.18]
32629
+ */
32630
+ readonly notes: Excel.NoteCollection;
32536
32631
  /**
32537
32632
  * Gets the `PageLayout` object of the worksheet.
32538
32633
  *
@@ -33722,6 +33817,14 @@ declare namespace Excel {
33722
33817
  * [Api set: ExcelApi 1.1]
33723
33818
  */
33724
33819
  readonly columnIndex: number;
33820
+ /**
33821
+ * Accesses the cell control applied to this range.
33822
+ If the range has multiple cell controls, this returns `EmptyCellControl`.
33823
+ *
33824
+ * @remarks
33825
+ * [Api set: ExcelApi 1.18]
33826
+ */
33827
+ control: CellControl;
33725
33828
  /**
33726
33829
  * Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead.
33727
33830
  *
@@ -33977,7 +34080,16 @@ declare namespace Excel {
33977
34080
  *
33978
34081
  * @param applyTo Optional. Determines the type of clear action. See `Excel.ClearApplyTo` for details.
33979
34082
  */
33980
- clear(applyTo?: "All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks"): void;
34083
+ clear(applyTo?: "All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks" | "ResetContents"): void;
34084
+ /**
34085
+ * Clears the values of the cells in the range, with special consideration given to cells containing controls.
34086
+ If the range contains only blank values and controls set to their default value, then the values and control formatting are removed.
34087
+ Otherwise, this sets the cells with controls to their default value and clears the values of the other cells in the range.
34088
+ *
34089
+ * @remarks
34090
+ * [Api set: ExcelApi 1.18]
34091
+ */
34092
+ clearOrResetContents(): void;
33981
34093
  /**
33982
34094
  * Converts the range cells with data types into text.
33983
34095
  *
@@ -34884,7 +34996,16 @@ declare namespace Excel {
34884
34996
  *
34885
34997
  * @param applyTo Optional. Determines the type of clear action. See `Excel.ClearApplyTo` for details. Default is "All".
34886
34998
  */
34887
- clear(applyTo?: "All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks"): void;
34999
+ clear(applyTo?: "All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks" | "ResetContents"): void;
35000
+ /**
35001
+ * Clears the values of the cells in the ranges, with special consideration given to cells containing controls.
35002
+ If the ranges contain only blank values and controls set to their default value, then the values and control formatting are removed.
35003
+ Otherwise, this sets the cells with controls to their default value and clears the values of the other cells in the ranges.
35004
+ *
35005
+ * @remarks
35006
+ * [Api set: ExcelApi 1.18]
35007
+ */
35008
+ clearOrResetContents(): void;
34888
35009
  /**
34889
35010
  * Converts all cells in the `RangeAreas` with data types into text.
34890
35011
  *
@@ -35043,6 +35164,13 @@ declare namespace Excel {
35043
35164
  * @param valuesOnly Whether to only consider cells with values as used cells.
35044
35165
  */
35045
35166
  getUsedRangeAreasOrNullObject(valuesOnly?: boolean): Excel.RangeAreas;
35167
+ /**
35168
+ * Selects the specified range areas in the Excel UI.
35169
+ *
35170
+ * @remarks
35171
+ * [Api set: ExcelApi 1.18]
35172
+ */
35173
+ select(): void;
35046
35174
  /**
35047
35175
  * Sets the `RangeAreas` to be recalculated when the next recalculation occurs.
35048
35176
  *
@@ -35405,6 +35533,28 @@ declare namespace Excel {
35405
35533
  */
35406
35534
  weight?: boolean;
35407
35535
  }
35536
+ /**
35537
+ * Represents a sequence of one or more characters that share the same font attributes in a cell. Can be used as the `textRuns` properties of `getCellProperties` or the `textRuns` input parameter of `setCellProperties`.
35538
+ *
35539
+ * @remarks
35540
+ * [Api set: ExcelApi 1.18]
35541
+ */
35542
+ interface RangeTextRun {
35543
+ /**
35544
+ * The font attributes (such as font name, font size, and color) applied to this text run.
35545
+ *
35546
+ * @remarks
35547
+ * [Api set: ExcelApi 1.18]
35548
+ */
35549
+ font?: Excel.CellPropertiesFont;
35550
+ /**
35551
+ * The text of this text run.
35552
+ *
35553
+ * @remarks
35554
+ * [Api set: ExcelApi 1.18]
35555
+ */
35556
+ text: string;
35557
+ }
35408
35558
  /**
35409
35559
  * Represents the `format.protection` properties of `getCellProperties`, `getRowProperties`, and `getColumnProperties`, or the `format.protection` input parameter of `setCellProperties`, `setRowProperties`, and `setColumnProperties`.
35410
35560
  *
@@ -54415,7 +54565,15 @@ declare namespace Excel {
54415
54565
  * @remarks
54416
54566
  * [Api set: ExcelApi 1.7]
54417
54567
  */
54418
- removeHyperlinks = "RemoveHyperlinks"
54568
+ removeHyperlinks = "RemoveHyperlinks",
54569
+ /**
54570
+ * Sets all cells in the range to their default state.
54571
+ Cells with cell controls are set to the default value defined by each control.
54572
+ Cells without cell controls are set to blank.
54573
+ * @remarks
54574
+ * [Api set: ExcelApi 1.18]
54575
+ */
54576
+ resetContents = "ResetContents"
54419
54577
  }
54420
54578
  /**
54421
54579
  * Represents the format options for a data bar axis.
@@ -59216,6 +59374,182 @@ declare namespace Excel {
59216
59374
  */
59217
59375
  toJSON(): Excel.Interfaces.NamedSheetViewCollectionData;
59218
59376
  }
59377
+ /**
59378
+ * Represents a collection of note objects that are part of the workbook.
59379
+ *
59380
+ * @remarks
59381
+ * [Api set: ExcelApi 1.18]
59382
+ */
59383
+ class NoteCollection extends OfficeExtension.ClientObject {
59384
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
59385
+ context: RequestContext;
59386
+ /** Gets the loaded child items in this collection. */
59387
+ readonly items: Excel.Note[];
59388
+ /**
59389
+ * Adds a new note with the given content on the given cell.
59390
+ *
59391
+ * @remarks
59392
+ * [Api set: ExcelApi 1.18]
59393
+ *
59394
+ * @param cellAddress The cell to which the note is added. This can be a `Range` object or a string such as "A1". If the string is invalid, or the range is not a single cell, an `InvalidCellAddress` error is thrown.
59395
+ * @param content The text of the note.
59396
+ */
59397
+ add(cellAddress: Range | string, content: any): Excel.Note;
59398
+ /**
59399
+ * Gets the number of notes in the collection.
59400
+ *
59401
+ * @remarks
59402
+ * [Api set: ExcelApi 1.18]
59403
+ */
59404
+ getCount(): OfficeExtension.ClientResult<number>;
59405
+ /**
59406
+ * Gets a note by its cell address.
59407
+ *
59408
+ * @remarks
59409
+ * [Api set: ExcelApi 1.18]
59410
+ *
59411
+ * @param key The cell address of the note.
59412
+ * @returns The note with the given cell address. If there is no note with the given cell address, then the `ItemNotFound` error is thrown.
59413
+ */
59414
+ getItem(key: string): Excel.Note;
59415
+ /**
59416
+ * Gets a note from the collection based on its position.
59417
+ *
59418
+ * @remarks
59419
+ * [Api set: ExcelApi 1.18]
59420
+ *
59421
+ * @param index The index value of the note to be retrieved. Zero-indexed.
59422
+ */
59423
+ getItemAt(index: number): Excel.Note;
59424
+ /**
59425
+ * Gets a note by its cell address.
59426
+ If the note object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
59427
+ For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
59428
+ *
59429
+ * @remarks
59430
+ * [Api set: ExcelApi 1.18]
59431
+ *
59432
+ * @param key The cell address of the note.
59433
+ * @returns The note with the given cell address or null object.
59434
+ */
59435
+ getItemOrNullObject(key: string): Excel.Note;
59436
+ /**
59437
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
59438
+ *
59439
+ * @param options Provides options for which properties of the object to load.
59440
+ */
59441
+ load(options?: Excel.Interfaces.NoteCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.NoteCollection;
59442
+ /**
59443
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
59444
+ *
59445
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
59446
+ */
59447
+ load(propertyNames?: string | string[]): Excel.NoteCollection;
59448
+ /**
59449
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
59450
+ *
59451
+ * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
59452
+ */
59453
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.NoteCollection;
59454
+ /**
59455
+ * 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.)
59456
+ * Whereas the original `Excel.NoteCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.NoteCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
59457
+ */
59458
+ toJSON(): Excel.Interfaces.NoteCollectionData;
59459
+ }
59460
+ /**
59461
+ * Represents a note in the workbook or worksheet.
59462
+ *
59463
+ * @remarks
59464
+ * [Api set: ExcelApi 1.18]
59465
+ */
59466
+ class Note extends OfficeExtension.ClientObject {
59467
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
59468
+ context: RequestContext;
59469
+ /**
59470
+ * Gets the author of the note.
59471
+ *
59472
+ * @remarks
59473
+ * [Api set: ExcelApi 1.18]
59474
+ */
59475
+ readonly authorName: string;
59476
+ /**
59477
+ * Gets or sets the text of the note.
59478
+ *
59479
+ * @remarks
59480
+ * [Api set: ExcelApi 1.18]
59481
+ */
59482
+ content: string;
59483
+ /**
59484
+ * Specifies the height of the note.
59485
+ *
59486
+ * @remarks
59487
+ * [Api set: ExcelApi 1.18]
59488
+ */
59489
+ height: number;
59490
+ /**
59491
+ * Specifies the visibility of the note. A value of `true` means the note is shown.
59492
+ *
59493
+ * @remarks
59494
+ * [Api set: ExcelApi 1.18]
59495
+ */
59496
+ visible: boolean;
59497
+ /**
59498
+ * Specifies the width of the note.
59499
+ *
59500
+ * @remarks
59501
+ * [Api set: ExcelApi 1.18]
59502
+ */
59503
+ width: number;
59504
+ /**
59505
+ * 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.
59506
+ * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
59507
+ * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
59508
+ */
59509
+ set(properties: Interfaces.NoteUpdateData, options?: OfficeExtension.UpdateOptions): void;
59510
+ /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
59511
+ set(properties: Excel.Note): void;
59512
+ /**
59513
+ * Deletes the note.
59514
+ *
59515
+ * @remarks
59516
+ * [Api set: ExcelApi 1.18]
59517
+ */
59518
+ delete(): void;
59519
+ /**
59520
+ * Gets the cell where this note is located.
59521
+ *
59522
+ * @remarks
59523
+ * [Api set: ExcelApi 1.18]
59524
+ */
59525
+ getLocation(): Excel.Range;
59526
+ /**
59527
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
59528
+ *
59529
+ * @param options Provides options for which properties of the object to load.
59530
+ */
59531
+ load(options?: Excel.Interfaces.NoteLoadOptions): Excel.Note;
59532
+ /**
59533
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
59534
+ *
59535
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
59536
+ */
59537
+ load(propertyNames?: string | string[]): Excel.Note;
59538
+ /**
59539
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
59540
+ *
59541
+ * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
59542
+ */
59543
+ load(propertyNamesAndPaths?: {
59544
+ select?: string;
59545
+ expand?: string;
59546
+ }): Excel.Note;
59547
+ /**
59548
+ * 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.)
59549
+ * Whereas the original `Excel.Note` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.NoteData`) that contains shallow copies of any loaded child properties from the original object.
59550
+ */
59551
+ toJSON(): Excel.Interfaces.NoteData;
59552
+ }
59219
59553
  /**
59220
59554
  * An object containing the result of a function-evaluation operation
59221
59555
  *
@@ -63292,6 +63626,14 @@ declare namespace Excel {
63292
63626
  * [Api set: ExcelApi 1.2]
63293
63627
  */
63294
63628
  columnHidden?: boolean;
63629
+ /**
63630
+ * Accesses the cell control applied to this range.
63631
+ If the range has multiple cell controls, this returns `EmptyCellControl`.
63632
+ *
63633
+ * @remarks
63634
+ * [Api set: ExcelApi 1.18]
63635
+ */
63636
+ control?: CellControl;
63295
63637
  /**
63296
63638
  * Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead.
63297
63639
  *
@@ -67941,6 +68283,41 @@ declare namespace Excel {
67941
68283
  interface NamedSheetViewCollectionUpdateData {
67942
68284
  items?: Excel.Interfaces.NamedSheetViewData[];
67943
68285
  }
68286
+ /** An interface for updating data on the `NoteCollection` object, for use in `noteCollection.set({ ... })`. */
68287
+ interface NoteCollectionUpdateData {
68288
+ items?: Excel.Interfaces.NoteData[];
68289
+ }
68290
+ /** An interface for updating data on the `Note` object, for use in `note.set({ ... })`. */
68291
+ interface NoteUpdateData {
68292
+ /**
68293
+ * Gets or sets the text of the note.
68294
+ *
68295
+ * @remarks
68296
+ * [Api set: ExcelApi 1.18]
68297
+ */
68298
+ content?: string;
68299
+ /**
68300
+ * Specifies the height of the note.
68301
+ *
68302
+ * @remarks
68303
+ * [Api set: ExcelApi 1.18]
68304
+ */
68305
+ height?: number;
68306
+ /**
68307
+ * Specifies the visibility of the note. A value of `true` means the note is shown.
68308
+ *
68309
+ * @remarks
68310
+ * [Api set: ExcelApi 1.18]
68311
+ */
68312
+ visible?: boolean;
68313
+ /**
68314
+ * Specifies the width of the note.
68315
+ *
68316
+ * @remarks
68317
+ * [Api set: ExcelApi 1.18]
68318
+ */
68319
+ width?: number;
68320
+ }
67944
68321
  /** An interface describing the data returned by calling `allowEditRange.toJSON()`. */
67945
68322
  interface AllowEditRangeData {
67946
68323
  /**
@@ -68166,6 +68543,13 @@ declare namespace Excel {
68166
68543
  */
68167
68544
  names?: Excel.Interfaces.NamedItemData[];
68168
68545
  /**
68546
+ * Returns a collection of all the notes objects in the workbook.
68547
+ *
68548
+ * @remarks
68549
+ * [Api set: ExcelApi 1.18]
68550
+ */
68551
+ notes?: Excel.Interfaces.NoteData[];
68552
+ /**
68169
68553
  * Represents a collection of PivotTableStyles associated with the workbook.
68170
68554
  *
68171
68555
  * @remarks
@@ -68367,6 +68751,13 @@ declare namespace Excel {
68367
68751
  */
68368
68752
  names?: Excel.Interfaces.NamedItemData[];
68369
68753
  /**
68754
+ * Returns a collection of all the notes objects in the worksheet.
68755
+ *
68756
+ * @remarks
68757
+ * [Api set: ExcelApi 1.18]
68758
+ */
68759
+ notes?: Excel.Interfaces.NoteData[];
68760
+ /**
68370
68761
  * Gets the `PageLayout` object of the worksheet.
68371
68762
  *
68372
68763
  * @remarks
@@ -68620,6 +69011,14 @@ declare namespace Excel {
68620
69011
  * [Api set: ExcelApi 1.1]
68621
69012
  */
68622
69013
  columnIndex?: number;
69014
+ /**
69015
+ * Accesses the cell control applied to this range.
69016
+ If the range has multiple cell controls, this returns `EmptyCellControl`.
69017
+ *
69018
+ * @remarks
69019
+ * [Api set: ExcelApi 1.18]
69020
+ */
69021
+ control?: CellControl;
68623
69022
  /**
68624
69023
  * Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead.
68625
69024
  *
@@ -74562,6 +74961,48 @@ declare namespace Excel {
74562
74961
  interface NamedSheetViewCollectionData {
74563
74962
  items?: Excel.Interfaces.NamedSheetViewData[];
74564
74963
  }
74964
+ /** An interface describing the data returned by calling `noteCollection.toJSON()`. */
74965
+ interface NoteCollectionData {
74966
+ items?: Excel.Interfaces.NoteData[];
74967
+ }
74968
+ /** An interface describing the data returned by calling `note.toJSON()`. */
74969
+ interface NoteData {
74970
+ /**
74971
+ * Gets the author of the note.
74972
+ *
74973
+ * @remarks
74974
+ * [Api set: ExcelApi 1.18]
74975
+ */
74976
+ authorName?: string;
74977
+ /**
74978
+ * Gets or sets the text of the note.
74979
+ *
74980
+ * @remarks
74981
+ * [Api set: ExcelApi 1.18]
74982
+ */
74983
+ content?: string;
74984
+ /**
74985
+ * Specifies the height of the note.
74986
+ *
74987
+ * @remarks
74988
+ * [Api set: ExcelApi 1.18]
74989
+ */
74990
+ height?: number;
74991
+ /**
74992
+ * Specifies the visibility of the note. A value of `true` means the note is shown.
74993
+ *
74994
+ * @remarks
74995
+ * [Api set: ExcelApi 1.18]
74996
+ */
74997
+ visible?: boolean;
74998
+ /**
74999
+ * Specifies the width of the note.
75000
+ *
75001
+ * @remarks
75002
+ * [Api set: ExcelApi 1.18]
75003
+ */
75004
+ width?: number;
75005
+ }
74565
75006
  /** An interface describing the data returned by calling `functionResult.toJSON()`. */
74566
75007
  interface FunctionResultData<T> {
74567
75008
  /**
@@ -75452,6 +75893,14 @@ declare namespace Excel {
75452
75893
  * [Api set: ExcelApi 1.1]
75453
75894
  */
75454
75895
  columnIndex?: boolean;
75896
+ /**
75897
+ * Accesses the cell control applied to this range.
75898
+ If the range has multiple cell controls, this returns `EmptyCellControl`.
75899
+ *
75900
+ * @remarks
75901
+ * [Api set: ExcelApi 1.18]
75902
+ */
75903
+ control?: boolean;
75455
75904
  /**
75456
75905
  * Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead.
75457
75906
  *
@@ -83735,6 +84184,14 @@ declare namespace Excel {
83735
84184
  * [Api set: ExcelApi 1.1]
83736
84185
  */
83737
84186
  columnIndex?: boolean;
84187
+ /**
84188
+ * For EACH ITEM in the collection: Accesses the cell control applied to this range.
84189
+ If the range has multiple cell controls, this returns `EmptyCellControl`.
84190
+ *
84191
+ * @remarks
84192
+ * [Api set: ExcelApi 1.18]
84193
+ */
84194
+ control?: boolean;
83738
84195
  /**
83739
84196
  * For EACH ITEM in the collection: Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead.
83740
84197
  *
@@ -85699,6 +86156,100 @@ declare namespace Excel {
85699
86156
  */
85700
86157
  name?: boolean;
85701
86158
  }
86159
+ /**
86160
+ * Represents a collection of note objects that are part of the workbook.
86161
+ *
86162
+ * @remarks
86163
+ * [Api set: ExcelApi 1.18]
86164
+ */
86165
+ interface NoteCollectionLoadOptions {
86166
+ /**
86167
+ 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`).
86168
+ */
86169
+ $all?: boolean;
86170
+ /**
86171
+ * For EACH ITEM in the collection: Gets the author of the note.
86172
+ *
86173
+ * @remarks
86174
+ * [Api set: ExcelApi 1.18]
86175
+ */
86176
+ authorName?: boolean;
86177
+ /**
86178
+ * For EACH ITEM in the collection: Gets or sets the text of the note.
86179
+ *
86180
+ * @remarks
86181
+ * [Api set: ExcelApi 1.18]
86182
+ */
86183
+ content?: boolean;
86184
+ /**
86185
+ * For EACH ITEM in the collection: Specifies the height of the note.
86186
+ *
86187
+ * @remarks
86188
+ * [Api set: ExcelApi 1.18]
86189
+ */
86190
+ height?: boolean;
86191
+ /**
86192
+ * For EACH ITEM in the collection: Specifies the visibility of the note. A value of `true` means the note is shown.
86193
+ *
86194
+ * @remarks
86195
+ * [Api set: ExcelApi 1.18]
86196
+ */
86197
+ visible?: boolean;
86198
+ /**
86199
+ * For EACH ITEM in the collection: Specifies the width of the note.
86200
+ *
86201
+ * @remarks
86202
+ * [Api set: ExcelApi 1.18]
86203
+ */
86204
+ width?: boolean;
86205
+ }
86206
+ /**
86207
+ * Represents a note in the workbook or worksheet.
86208
+ *
86209
+ * @remarks
86210
+ * [Api set: ExcelApi 1.18]
86211
+ */
86212
+ interface NoteLoadOptions {
86213
+ /**
86214
+ 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`).
86215
+ */
86216
+ $all?: boolean;
86217
+ /**
86218
+ * Gets the author of the note.
86219
+ *
86220
+ * @remarks
86221
+ * [Api set: ExcelApi 1.18]
86222
+ */
86223
+ authorName?: boolean;
86224
+ /**
86225
+ * Gets or sets the text of the note.
86226
+ *
86227
+ * @remarks
86228
+ * [Api set: ExcelApi 1.18]
86229
+ */
86230
+ content?: boolean;
86231
+ /**
86232
+ * Specifies the height of the note.
86233
+ *
86234
+ * @remarks
86235
+ * [Api set: ExcelApi 1.18]
86236
+ */
86237
+ height?: boolean;
86238
+ /**
86239
+ * Specifies the visibility of the note. A value of `true` means the note is shown.
86240
+ *
86241
+ * @remarks
86242
+ * [Api set: ExcelApi 1.18]
86243
+ */
86244
+ visible?: boolean;
86245
+ /**
86246
+ * Specifies the width of the note.
86247
+ *
86248
+ * @remarks
86249
+ * [Api set: ExcelApi 1.18]
86250
+ */
86251
+ width?: boolean;
86252
+ }
85702
86253
  /**
85703
86254
  * An object containing the result of a function-evaluation operation
85704
86255
  *
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.462",
3
+ "version": "1.0.464",
4
4
  "description": "TypeScript definitions for office-js",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
6
6
  "license": "MIT",
@@ -46,6 +46,6 @@
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
48
  "peerDependencies": {},
49
- "typesPublisherContentHash": "3d95d952efcdeb0d44bb5ae14a5ddbe960a780ed3142d3df9021bedb36b1b58c",
49
+ "typesPublisherContentHash": "d3543dcb2e7aa5f497e2bdc719c71dbccd014b5e7e45de0a0833ea4eca7efd4c",
50
50
  "typeScriptVersion": "5.0"
51
51
  }