@types/office-js 1.0.531 → 1.0.533

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: Thu, 28 Aug 2025 21:02:18 GMT
11
+ * Last updated: Wed, 03 Sep 2025 19:32:33 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
office-js/index.d.ts CHANGED
@@ -611,19 +611,28 @@ declare namespace Office {
611
611
  */
612
612
  BindingSelectionChanged,
613
613
  /**
614
- * Triggers when Dialog has an event, such as dialog closed or dialog navigation failed.
614
+ * Occurs when a dialog is closed or when dialog navigation failed.
615
+ *
616
+ * For guidance on how to implement a dialog in your add-in, see
617
+ * {@link https://learn.microsoft.com/office/dev/add-ins/develop/dialog-api-in-office-add-ins | Use the Office dialog API in Office Add-ins}.
615
618
  */
616
619
  DialogEventReceived,
617
620
  /**
618
- * Triggers when a dialog sends a message via `messageParent`.
621
+ * Occurs when a dialog sends a message using `Office.context.ui.messageParent`.
622
+ *
623
+ * For guidance on how to implement a dialog in your add-in, see
624
+ * {@link https://learn.microsoft.com/office/dev/add-ins/develop/dialog-api-in-office-add-ins | Use the Office dialog API in Office Add-ins}.
619
625
  */
620
626
  DialogMessageReceived,
621
627
  /**
622
- * Triggers when a host page sends a message to a child dialog box with `messageChild`.
628
+ * Occurs when a host page sends a message to a child dialog box with `Dialog.messageChild`.
629
+ *
630
+ * For guidance on how to implement a dialog in your add-in, see
631
+ * {@link https://learn.microsoft.com/office/dev/add-ins/develop/dialog-api-in-office-add-ins | Use the Office dialog API in Office Add-ins}.
623
632
  */
624
633
  DialogParentMessageReceived,
625
634
  /**
626
- * Triggers when a document-level selection happens in Excel or Word.
635
+ * Occurs when a document-level selection happens in Excel or Word.
627
636
  */
628
637
  DocumentSelectionChanged,
629
638
  /**
@@ -699,15 +708,15 @@ declare namespace Office {
699
708
  */
700
709
  DragAndDropEvent,
701
710
  /**
702
- * Triggers when a `customXmlPart` node is deleted.
711
+ * Occurs when a `customXmlPart` node is deleted.
703
712
  */
704
713
  NodeDeleted,
705
714
  /**
706
- * Triggers when a `customXmlPart` node is inserted.
715
+ * Occurs when a `customXmlPart` node is inserted.
707
716
  */
708
717
  NodeInserted,
709
718
  /**
710
- * Triggers when a `customXmlPart` node is replaced.
719
+ * Occurs when a `customXmlPart` node is replaced.
711
720
  */
712
721
  NodeReplaced,
713
722
  /**
@@ -752,7 +761,7 @@ declare namespace Office {
752
761
  */
753
762
  RecurrenceChanged,
754
763
  /**
755
- * Triggers when a Resource selection happens in Project.
764
+ * Occurs when a Resource selection happens in Project.
756
765
  */
757
766
  ResourceSelectionChanged,
758
767
  /**
@@ -789,11 +798,11 @@ declare namespace Office {
789
798
  */
790
799
  SpamReporting,
791
800
  /**
792
- * Triggers when a Task selection happens in Project.
801
+ * Occurs when a Task selection happens in Project.
793
802
  */
794
803
  TaskSelectionChanged,
795
804
  /**
796
- * Triggers when a View selection happens in Project.
805
+ * Occurs when a View selection happens in Project.
797
806
  */
798
807
  ViewSelectionChanged
799
808
  }
@@ -30805,7 +30814,7 @@ declare namespace Excel {
30805
30814
  provider?: CellValueProviderAttributes;
30806
30815
  }
30807
30816
  /**
30808
- * Represents the value of a cell containing a #N/A! error.
30817
+ * Represents the value of a cell containing a #N/A error.
30809
30818
  *
30810
30819
  * @remarks
30811
30820
  * [Api set: ExcelApi 1.16]
@@ -30826,7 +30835,7 @@ declare namespace Excel {
30826
30835
  * @remarks
30827
30836
  * [Api set: ExcelApi 1.16]
30828
30837
  */
30829
- basicValue?: "#N/A!" | string;
30838
+ basicValue?: "#N/A" | string;
30830
30839
  /**
30831
30840
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
30832
30841
  *
@@ -32038,6 +32047,7 @@ declare namespace Excel {
32038
32047
  /**
32039
32048
  *
32040
32049
  * Creates and opens a new workbook. Optionally, the workbook can be pre-populated with a Base64-encoded .xlsx file.
32050
+ * The `extensionHardening` Windows registry key affects the `base64File` param. The file extension defined by the param must match the real file type of the file. If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error: "This operation is not allowed due to the extension hardening policy."
32041
32051
  * Note: Macros can be a security risk. If this API is used to create a workbook that includes a macro, the add-in user will be prompted with a "Trust this add-in?" dialog in the Excel UI. The user must select the "Trust add-in" button to proceed.
32042
32052
  *
32043
32053
  * [Api set: ExcelApi 1.8]
@@ -35680,11 +35690,12 @@ declare namespace Excel {
35680
35690
  getSelectedRanges(): Excel.RangeAreas;
35681
35691
  /**
35682
35692
  * Inserts the specified worksheets from a source workbook into the current workbook.
35683
-
35684
- **Note**: This API is currently only supported for Office on Windows, Mac, and the web.
35693
+ * The `extensionHardening` Windows registry key affects this API. The file extension defined by the `base64File` param must match the real file type of the inserted file. If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error: "This operation is not allowed due to the extension hardening policy."
35685
35694
  *
35686
35695
  * @remarks
35687
35696
  * [Api set: ExcelApi 1.13]
35697
+ *
35698
+ * This API is currently only supported for Office on Windows, Mac, and the web.
35688
35699
  *
35689
35700
  * @param base64File Required. The Base64-encoded string representing the source workbook file.
35690
35701
  * @param options Optional. The options that define which worksheets to insert and where in the workbook the new worksheets will be inserted. By default, all the worksheets from the source workbook are inserted at the end of the current workbook.
@@ -37622,7 +37633,7 @@ declare namespace Excel {
37622
37633
  */
37623
37634
  getEntireRow(): Excel.Range;
37624
37635
  /**
37625
- * 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.
37636
+ * 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.
37626
37637
  *
37627
37638
  * @remarks
37628
37639
  * [Api set: ExcelApi 1.13]
@@ -37632,7 +37643,7 @@ declare namespace Excel {
37632
37643
  */
37633
37644
  getExtendedRange(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range;
37634
37645
  /**
37635
- * 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.
37646
+ * 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.
37636
37647
  *
37637
37648
  * @remarks
37638
37649
  * [Api set: ExcelApi 1.13]
@@ -37727,7 +37738,7 @@ declare namespace Excel {
37727
37738
  */
37728
37739
  getPrecedents(): Excel.WorkbookRangeAreas;
37729
37740
  /**
37730
- * 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.
37741
+ * 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.
37731
37742
  *
37732
37743
  * @remarks
37733
37744
  * [Api set: ExcelApi 1.13]
@@ -37737,7 +37748,7 @@ declare namespace Excel {
37737
37748
  */
37738
37749
  getRangeEdge(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range;
37739
37750
  /**
37740
- * 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.
37751
+ * 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.
37741
37752
  *
37742
37753
  * @remarks
37743
37754
  * [Api set: ExcelApi 1.13]
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.531",
3
+ "version": "1.0.533",
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": "ca6c578116f68bf60005a3c18dd109de601cb88850b467ae73cd1fcb30e83abf",
49
+ "typesPublisherContentHash": "80c5689f8ce2969de9538d9a02436d25f022d29b805d457c9e6cbd3659ce3f0e",
50
50
  "typeScriptVersion": "5.2"
51
51
  }