@types/office-js 1.0.532 → 1.0.534
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 +1 -1
- office-js/index.d.ts +99 -10
- office-js/package.json +2 -2
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: Tue,
|
|
11
|
+
* Last updated: Tue, 09 Sep 2025 21:32:19 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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
711
|
+
* Occurs when a `customXmlPart` node is deleted.
|
|
703
712
|
*/
|
|
704
713
|
NodeDeleted,
|
|
705
714
|
/**
|
|
706
|
-
*
|
|
715
|
+
* Occurs when a `customXmlPart` node is inserted.
|
|
707
716
|
*/
|
|
708
717
|
NodeInserted,
|
|
709
718
|
/**
|
|
710
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
801
|
+
* Occurs when a Task selection happens in Project.
|
|
793
802
|
*/
|
|
794
803
|
TaskSelectionChanged,
|
|
795
804
|
/**
|
|
796
|
-
*
|
|
805
|
+
* Occurs when a View selection happens in Project.
|
|
797
806
|
*/
|
|
798
807
|
ViewSelectionChanged
|
|
799
808
|
}
|
|
@@ -32227,6 +32236,16 @@ declare namespace Excel {
|
|
|
32227
32236
|
* The default behavior with no `delayForCellEdit` property specified is equivalent to when it is `false`.
|
|
32228
32237
|
*/
|
|
32229
32238
|
delayForCellEdit?: boolean;
|
|
32239
|
+
/**
|
|
32240
|
+
* Determines whether the batch requests should be merged to one undo group.
|
|
32241
|
+
*
|
|
32242
|
+
* When false, each `context.sync()` call creates an undo record.
|
|
32243
|
+
* When true, all `context.sync()` calls in a single `Excel.run` are merged into one `undo` group.
|
|
32244
|
+
*
|
|
32245
|
+
* @remarks
|
|
32246
|
+
* [Api set: ExcelApi 1.20]
|
|
32247
|
+
*/
|
|
32248
|
+
mergeUndoGroup?: boolean;
|
|
32230
32249
|
}
|
|
32231
32250
|
/**
|
|
32232
32251
|
* Executes a batch script that performs actions on the Excel object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.
|
|
@@ -51789,6 +51808,76 @@ declare namespace Excel {
|
|
|
51789
51808
|
*/
|
|
51790
51809
|
toJSON(): Excel.Interfaces.ConditionalRangeBorderCollectionData;
|
|
51791
51810
|
}
|
|
51811
|
+
/**
|
|
51812
|
+
* Manages settings on custom functions.
|
|
51813
|
+
*
|
|
51814
|
+
* @remarks
|
|
51815
|
+
* [Api set: ExcelApi 1.20]
|
|
51816
|
+
*/
|
|
51817
|
+
class CustomFunctionManager extends OfficeExtension.ClientObject {
|
|
51818
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
51819
|
+
context: RequestContext;
|
|
51820
|
+
/**
|
|
51821
|
+
* Show or hide custom functions in Excel AutoComplete.
|
|
51822
|
+
*
|
|
51823
|
+
* @remarks
|
|
51824
|
+
* [Api set: ExcelApi 1.20]
|
|
51825
|
+
*
|
|
51826
|
+
* @param customFunctionVisibilityOptions Specifies which custom functions to show or hide.
|
|
51827
|
+
*/
|
|
51828
|
+
static setVisibility(customFunctionVisibilityOptions: Excel.CustomFunctionVisibilityOptions): void;
|
|
51829
|
+
/**
|
|
51830
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
51831
|
+
*
|
|
51832
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
51833
|
+
*/
|
|
51834
|
+
load(propertyNames?: string | string[]): Excel.CustomFunctionManager;
|
|
51835
|
+
/**
|
|
51836
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
51837
|
+
*
|
|
51838
|
+
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
51839
|
+
*
|
|
51840
|
+
* @remarks
|
|
51841
|
+
* [Api set: ExcelApi 1.20]
|
|
51842
|
+
*/
|
|
51843
|
+
load(propertyNamesAndPaths?: {
|
|
51844
|
+
select?: string;
|
|
51845
|
+
expand?: string;
|
|
51846
|
+
}): Excel.CustomFunctionManager;
|
|
51847
|
+
/**
|
|
51848
|
+
* Create a new instance of the `Excel.CustomFunctionManager` object.
|
|
51849
|
+
* @remarks
|
|
51850
|
+
* [Api set: ExcelApi 1.20]
|
|
51851
|
+
*/
|
|
51852
|
+
static newObject(context: OfficeExtension.ClientRequestContext): Excel.CustomFunctionManager;
|
|
51853
|
+
/**
|
|
51854
|
+
* 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.)
|
|
51855
|
+
* Whereas the original `Excel.CustomFunctionManager` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.CustomFunctionManagerData`) that contains shallow copies of any loaded child properties from the original object.
|
|
51856
|
+
*/
|
|
51857
|
+
toJSON(): Excel.Interfaces.CustomFunctionManagerData;
|
|
51858
|
+
}
|
|
51859
|
+
/**
|
|
51860
|
+
* Represents which custom functions to show or hide in Excel AutoComplete.
|
|
51861
|
+
*
|
|
51862
|
+
* @remarks
|
|
51863
|
+
* [Api set: ExcelApi 1.20]
|
|
51864
|
+
*/
|
|
51865
|
+
interface CustomFunctionVisibilityOptions {
|
|
51866
|
+
/**
|
|
51867
|
+
* A list of custom functions to hide from Excel AutoComplete.
|
|
51868
|
+
*
|
|
51869
|
+
* @remarks
|
|
51870
|
+
* [Api set: ExcelApi 1.20]
|
|
51871
|
+
*/
|
|
51872
|
+
hide?: string[];
|
|
51873
|
+
/**
|
|
51874
|
+
* A list of custom functions to show in Excel AutoComplete.
|
|
51875
|
+
*
|
|
51876
|
+
* @remarks
|
|
51877
|
+
* [Api set: ExcelApi 1.20]
|
|
51878
|
+
*/
|
|
51879
|
+
show?: string[];
|
|
51880
|
+
}
|
|
51792
51881
|
/**
|
|
51793
51882
|
* An object encapsulating a style's format and other properties.
|
|
51794
51883
|
*
|
office-js/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/office-js",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.534",
|
|
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": "
|
|
49
|
+
"typesPublisherContentHash": "bfcd6204043b4e1578a21c61a86ea09a037bc16cc9f499b0e5c2c1d656637a62",
|
|
50
50
|
"typeScriptVersion": "5.2"
|
|
51
51
|
}
|