@types/office-js 1.0.496 → 1.0.498
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 +30 -38
- 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:
|
|
11
|
+
* Last updated: Mon, 12 May 2025 16:39:10 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
|
|
14
14
|
# Credits
|
office-js/index.d.ts
CHANGED
|
@@ -29519,11 +29519,11 @@ declare namespace Excel {
|
|
|
29519
29519
|
*/
|
|
29520
29520
|
text?: string;
|
|
29521
29521
|
/**
|
|
29522
|
-
|
|
29523
|
-
|
|
29524
|
-
|
|
29525
|
-
|
|
29526
|
-
|
|
29522
|
+
* Represents the properties of this entity and their metadata.
|
|
29523
|
+
*
|
|
29524
|
+
* @remarks
|
|
29525
|
+
* [Api set: ExcelApi 1.16]
|
|
29526
|
+
*/
|
|
29527
29527
|
properties?: {
|
|
29528
29528
|
[key: string]: EntityPropertyType;
|
|
29529
29529
|
};
|
|
@@ -30022,11 +30022,11 @@ declare namespace Excel {
|
|
|
30022
30022
|
*/
|
|
30023
30023
|
text?: string;
|
|
30024
30024
|
/**
|
|
30025
|
-
|
|
30026
|
-
|
|
30027
|
-
|
|
30028
|
-
|
|
30029
|
-
|
|
30025
|
+
* Represents the properties of this linked entity and their metadata.
|
|
30026
|
+
*
|
|
30027
|
+
* @remarks
|
|
30028
|
+
* [Api set: ExcelApi 1.16]
|
|
30029
|
+
*/
|
|
30030
30030
|
properties?: {
|
|
30031
30031
|
[key: string]: EntityPropertyType;
|
|
30032
30032
|
};
|
|
@@ -35354,7 +35354,7 @@ declare namespace Excel {
|
|
|
35354
35354
|
* @remarks
|
|
35355
35355
|
* [Api set: ExcelApi 1.1]
|
|
35356
35356
|
*
|
|
35357
|
-
* @param address Optional. The string representing the address or name of the range. For example, "A1:B2". If not specified, the entire worksheet range is returned.
|
|
35357
|
+
* @param address Optional. The string representing the address or name of the range. For example, "A1:B2". If not specified, the entire worksheet range is returned. The `address` has a limit of 8192 characters. If the address exceeds the character limit, this method returns an `InvalidArgument` error.
|
|
35358
35358
|
*/
|
|
35359
35359
|
getRange(address?: string): Excel.Range;
|
|
35360
35360
|
/**
|
|
@@ -92105,7 +92105,7 @@ declare namespace Word {
|
|
|
92105
92105
|
* @remarks
|
|
92106
92106
|
* [Api set: WordApi 1.5]
|
|
92107
92107
|
*
|
|
92108
|
-
*
|
|
92108
|
+
* Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario.
|
|
92109
92109
|
*
|
|
92110
92110
|
* @param base64File Required. The Base64-encoded content of a .docx file.
|
|
92111
92111
|
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
@@ -92407,7 +92407,7 @@ declare namespace Word {
|
|
|
92407
92407
|
* @remarks
|
|
92408
92408
|
* [Api set: WordApiHiddenDocument 1.5]
|
|
92409
92409
|
*
|
|
92410
|
-
*
|
|
92410
|
+
* Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario.
|
|
92411
92411
|
*
|
|
92412
92412
|
* @param base64File Required. The Base64-encoded content of a .docx file.
|
|
92413
92413
|
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
@@ -92791,10 +92791,8 @@ declare namespace Word {
|
|
|
92791
92791
|
* [Api set: WordApi 1.4]
|
|
92792
92792
|
*
|
|
92793
92793
|
* Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5.
|
|
92794
|
-
* Support for managing fields is similar to what's available in the Word UI.
|
|
92795
|
-
*
|
|
92796
|
-
* To learn more about Word UI clients that more fully support fields,
|
|
92797
|
-
* see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}.
|
|
92794
|
+
* Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}).
|
|
92795
|
+
* To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}.
|
|
92798
92796
|
*/
|
|
92799
92797
|
class Field extends OfficeExtension.ClientObject {
|
|
92800
92798
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -92995,10 +92993,8 @@ declare namespace Word {
|
|
|
92995
92993
|
* [Api set: WordApi 1.4]
|
|
92996
92994
|
*
|
|
92997
92995
|
* Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5.
|
|
92998
|
-
* Support for managing fields is similar to what's available in the Word UI.
|
|
92999
|
-
*
|
|
93000
|
-
* To learn more about Word UI clients that more fully support fields,
|
|
93001
|
-
* see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}.
|
|
92996
|
+
* Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}).
|
|
92997
|
+
* To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}.
|
|
93002
92998
|
*/
|
|
93003
92999
|
class FieldCollection extends OfficeExtension.ClientObject {
|
|
93004
93000
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -93371,7 +93367,7 @@ declare namespace Word {
|
|
|
93371
93367
|
* @remarks
|
|
93372
93368
|
* [Api set: WordApi 1.2]
|
|
93373
93369
|
*
|
|
93374
|
-
*
|
|
93370
|
+
* Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario.
|
|
93375
93371
|
*
|
|
93376
93372
|
* @param base64File Required. The Base64-encoded content of a .docx file.
|
|
93377
93373
|
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
@@ -95184,7 +95180,7 @@ declare namespace Word {
|
|
|
95184
95180
|
* @remarks
|
|
95185
95181
|
* [Api set: WordApi 1.1]
|
|
95186
95182
|
*
|
|
95187
|
-
*
|
|
95183
|
+
* Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario.
|
|
95188
95184
|
*
|
|
95189
95185
|
* @param base64File Required. The Base64-encoded content of a .docx file.
|
|
95190
95186
|
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
@@ -99037,7 +99033,7 @@ declare namespace Word {
|
|
|
99037
99033
|
*/
|
|
99038
99034
|
rotation: number;
|
|
99039
99035
|
/**
|
|
99040
|
-
* The distance, in points, from the top edge of the shape to the vertical relative position
|
|
99036
|
+
* The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
|
|
99041
99037
|
*
|
|
99042
99038
|
* @remarks
|
|
99043
99039
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -99783,7 +99779,7 @@ declare namespace Word {
|
|
|
99783
99779
|
toJSON(): Word.Interfaces.ShapeTextWrapData;
|
|
99784
99780
|
}
|
|
99785
99781
|
/**
|
|
99786
|
-
*
|
|
99782
|
+
* Represents the possible change tracking modes.
|
|
99787
99783
|
*
|
|
99788
99784
|
* @remarks
|
|
99789
99785
|
* [Api set: WordApi 1.4]
|
|
@@ -106809,7 +106805,7 @@ declare namespace Word {
|
|
|
106809
106805
|
*/
|
|
106810
106806
|
rotation?: number;
|
|
106811
106807
|
/**
|
|
106812
|
-
* The distance, in points, from the top edge of the shape to the vertical relative position
|
|
106808
|
+
* The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
|
|
106813
106809
|
*
|
|
106814
106810
|
* @remarks
|
|
106815
106811
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -109486,7 +109482,7 @@ declare namespace Word {
|
|
|
109486
109482
|
*/
|
|
109487
109483
|
rotation?: number;
|
|
109488
109484
|
/**
|
|
109489
|
-
* The distance, in points, from the top edge of the shape to the vertical relative position
|
|
109485
|
+
* The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
|
|
109490
109486
|
*
|
|
109491
109487
|
* @remarks
|
|
109492
109488
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -111093,10 +111089,8 @@ declare namespace Word {
|
|
|
111093
111089
|
* [Api set: WordApi 1.4]
|
|
111094
111090
|
*
|
|
111095
111091
|
* Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5.
|
|
111096
|
-
* Support for managing fields is similar to what's available in the Word UI.
|
|
111097
|
-
*
|
|
111098
|
-
* the `Addin` field is editable. To learn more about Word UI clients that more fully support fields,
|
|
111099
|
-
* see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}.
|
|
111092
|
+
* Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}).
|
|
111093
|
+
* To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}.
|
|
111100
111094
|
*/
|
|
111101
111095
|
interface FieldLoadOptions {
|
|
111102
111096
|
/**
|
|
@@ -111210,11 +111204,9 @@ declare namespace Word {
|
|
|
111210
111204
|
* @remarks
|
|
111211
111205
|
* [Api set: WordApi 1.4]
|
|
111212
111206
|
*
|
|
111213
|
-
* Important: To learn more about which fields can be inserted, see the `Word.Range.insertField API
|
|
111214
|
-
* Support for managing fields is similar to what's available in the Word UI.
|
|
111215
|
-
*
|
|
111216
|
-
* the `Addin` field is editable. To learn more about Word UI clients that more fully support fields,
|
|
111217
|
-
* see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}.
|
|
111207
|
+
* Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5.
|
|
111208
|
+
* Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}).
|
|
111209
|
+
* To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}.
|
|
111218
111210
|
*/
|
|
111219
111211
|
interface FieldCollectionLoadOptions {
|
|
111220
111212
|
/**
|
|
@@ -114337,7 +114329,7 @@ declare namespace Word {
|
|
|
114337
114329
|
*/
|
|
114338
114330
|
rotation?: boolean;
|
|
114339
114331
|
/**
|
|
114340
|
-
* The distance, in points, from the top edge of the shape to the vertical relative position
|
|
114332
|
+
* The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
|
|
114341
114333
|
*
|
|
114342
114334
|
* @remarks
|
|
114343
114335
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -114611,7 +114603,7 @@ declare namespace Word {
|
|
|
114611
114603
|
*/
|
|
114612
114604
|
rotation?: boolean;
|
|
114613
114605
|
/**
|
|
114614
|
-
* For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the vertical relative position
|
|
114606
|
+
* For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
|
|
114615
114607
|
*
|
|
114616
114608
|
* @remarks
|
|
114617
114609
|
* [Api set: WordApiDesktop 1.2]
|
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.498",
|
|
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": "5ec0b4c1b6b4aa09b8c797132b0a750ab09e781f8ed82bc7d08a89df44e4b937",
|
|
50
50
|
"typeScriptVersion": "5.1"
|
|
51
51
|
}
|