@types/office-js-preview 1.0.644 → 1.0.646
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-preview/README.md +1 -1
- office-js-preview/index.d.ts +24 -24
- office-js-preview/package.json +2 -2
office-js-preview/README.md
CHANGED
|
@@ -8,7 +8,7 @@ This package contains type definitions for office-js-preview (https://github.com
|
|
|
8
8
|
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
|
|
9
9
|
|
|
10
10
|
### Additional Details
|
|
11
|
-
* Last updated:
|
|
11
|
+
* Last updated: Fri, 03 Oct 2025 16:37:01 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
|
|
14
14
|
# Credits
|
office-js-preview/index.d.ts
CHANGED
|
@@ -101287,7 +101287,7 @@ declare namespace Word {
|
|
|
101287
101287
|
*/
|
|
101288
101288
|
readonly fields: Word.FieldCollection;
|
|
101289
101289
|
/**
|
|
101290
|
-
* Gets the text format of the body. Use this to get and set font name, size, color and other properties.
|
|
101290
|
+
* Gets the text format of the body. Use this to get and set font name, size, color, and other properties.
|
|
101291
101291
|
*
|
|
101292
101292
|
* @remarks
|
|
101293
101293
|
* [Api set: WordApi 1.1]
|
|
@@ -104484,7 +104484,7 @@ declare namespace Word {
|
|
|
104484
104484
|
*/
|
|
104485
104485
|
readonly errorCode: number;
|
|
104486
104486
|
/**
|
|
104487
|
-
* Gets the name of the error in the `CustomXmlValidationError` object. If no errors exist, the property returns `Nothing
|
|
104487
|
+
* Gets the name of the error in the `CustomXmlValidationError` object. If no errors exist, the property returns `"Nothing"`.
|
|
104488
104488
|
*
|
|
104489
104489
|
* @remarks
|
|
104490
104490
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -119033,8 +119033,8 @@ declare namespace Word {
|
|
|
119033
119033
|
addedStyles?: string;
|
|
119034
119034
|
/**
|
|
119035
119035
|
* If provided, specifies the label that identifies the items to include in a table of figures.
|
|
119036
|
-
|
|
119037
|
-
|
|
119036
|
+
Corresponds to the `\c` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}.
|
|
119037
|
+
The default value is "Figure".
|
|
119038
119038
|
*
|
|
119039
119039
|
* @remarks
|
|
119040
119040
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -119043,7 +119043,7 @@ declare namespace Word {
|
|
|
119043
119043
|
captionLabel?: string;
|
|
119044
119044
|
/**
|
|
119045
119045
|
* If provided, specifies whether the page numbers in the table of figures should be hidden when publishing to the web.
|
|
119046
|
-
|
|
119046
|
+
The default value is `true`.
|
|
119047
119047
|
*
|
|
119048
119048
|
* @remarks
|
|
119049
119049
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -119052,7 +119052,7 @@ declare namespace Word {
|
|
|
119052
119052
|
hidePageNumbersOnWeb?: boolean;
|
|
119053
119053
|
/**
|
|
119054
119054
|
* If provided, specifies whether to include the caption label and caption number in a table of figures.
|
|
119055
|
-
|
|
119055
|
+
The default value is `true`.
|
|
119056
119056
|
*
|
|
119057
119057
|
* @remarks
|
|
119058
119058
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -119061,7 +119061,7 @@ declare namespace Word {
|
|
|
119061
119061
|
includeLabel?: boolean;
|
|
119062
119062
|
/**
|
|
119063
119063
|
* If provided, specifies whether page numbers are included in a table of figures.
|
|
119064
|
-
|
|
119064
|
+
The default value is `true`.
|
|
119065
119065
|
*
|
|
119066
119066
|
* @remarks
|
|
119067
119067
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -119070,8 +119070,8 @@ declare namespace Word {
|
|
|
119070
119070
|
includePageNumbers?: boolean;
|
|
119071
119071
|
/**
|
|
119072
119072
|
* If provided, specifies the ending heading level for a table of figures when `useBuiltInHeadingStyles` is set to `true`. Should be a value from 1 to 9 and greater than `upperHeadingLevel`.
|
|
119073
|
-
|
|
119074
|
-
|
|
119073
|
+
Corresponds to the ending value used with the `\o` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}.
|
|
119074
|
+
The default value is `9`.
|
|
119075
119075
|
*
|
|
119076
119076
|
* @remarks
|
|
119077
119077
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -119080,7 +119080,7 @@ declare namespace Word {
|
|
|
119080
119080
|
lowerHeadingLevel?: number;
|
|
119081
119081
|
/**
|
|
119082
119082
|
* If provided, specifies whether to align page numbers with the right margin in a table of figures.
|
|
119083
|
-
|
|
119083
|
+
The default value is `true`.
|
|
119084
119084
|
*
|
|
119085
119085
|
* @remarks
|
|
119086
119086
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -119089,7 +119089,7 @@ declare namespace Word {
|
|
|
119089
119089
|
rightAlignPageNumbers?: boolean;
|
|
119090
119090
|
/**
|
|
119091
119091
|
* If provided, specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for a table of figures.
|
|
119092
|
-
|
|
119092
|
+
Corresponds to the `\f` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. For example, "T" indicates a table of figures includes TC fields that use the table identifier T.
|
|
119093
119093
|
*
|
|
119094
119094
|
* @remarks
|
|
119095
119095
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -119098,8 +119098,8 @@ declare namespace Word {
|
|
|
119098
119098
|
tableId?: string;
|
|
119099
119099
|
/**
|
|
119100
119100
|
* If provided, specifies the starting heading level for a table of figures when `useBuiltInHeadingStyles` is set to `true`. Should be a value from 1 to 9 and smaller than `lowerHeadingLevel`.
|
|
119101
|
-
|
|
119102
|
-
|
|
119101
|
+
Corresponds to the starting value used with the `\o` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}.
|
|
119102
|
+
The default value is `1`.
|
|
119103
119103
|
*
|
|
119104
119104
|
* @remarks
|
|
119105
119105
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -119108,7 +119108,7 @@ declare namespace Word {
|
|
|
119108
119108
|
upperHeadingLevel?: number;
|
|
119109
119109
|
/**
|
|
119110
119110
|
* If provided, specifies whether to use built-in heading styles to create a table of figures.
|
|
119111
|
-
|
|
119111
|
+
The default value is `false`.
|
|
119112
119112
|
*
|
|
119113
119113
|
* @remarks
|
|
119114
119114
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -119117,8 +119117,8 @@ declare namespace Word {
|
|
|
119117
119117
|
useBuiltInHeadingStyles?: boolean;
|
|
119118
119118
|
/**
|
|
119119
119119
|
* If provided, specifies whether to use {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} to create a table of figures.
|
|
119120
|
-
|
|
119121
|
-
|
|
119120
|
+
Use the {@link Word.TableOfFiguresCollection | TableOfFiguresCollection.markTocEntry} method to mark entries to include in a table of figures.
|
|
119121
|
+
The default value is `false`.
|
|
119122
119122
|
*
|
|
119123
119123
|
* @remarks
|
|
119124
119124
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -119127,7 +119127,7 @@ declare namespace Word {
|
|
|
119127
119127
|
useFields?: boolean;
|
|
119128
119128
|
/**
|
|
119129
119129
|
* If provided, specifies whether entries in a table of figures should be formatted as hyperlinks when the document is published to the web.
|
|
119130
|
-
|
|
119130
|
+
The default value is `true`.
|
|
119131
119131
|
*
|
|
119132
119132
|
* @remarks
|
|
119133
119133
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -145130,7 +145130,7 @@ declare namespace Word {
|
|
|
145130
145130
|
* @param xml The XML string to insert.
|
|
145131
145131
|
* @param transform Optional. XSL transform to apply.
|
|
145132
145132
|
*/
|
|
145133
|
-
|
|
145133
|
+
insertXml(xml: string, transform?: string): void;
|
|
145134
145134
|
/**
|
|
145135
145135
|
* Returns whether the selection is equal to the specified range.
|
|
145136
145136
|
*
|
|
@@ -157308,7 +157308,7 @@ declare namespace Word {
|
|
|
157308
157308
|
*/
|
|
157309
157309
|
errorCode?: number;
|
|
157310
157310
|
/**
|
|
157311
|
-
* Gets the name of the error in the `CustomXmlValidationError` object. If no errors exist, the property returns `Nothing
|
|
157311
|
+
* Gets the name of the error in the `CustomXmlValidationError` object. If no errors exist, the property returns `"Nothing"`.
|
|
157312
157312
|
*
|
|
157313
157313
|
* @remarks
|
|
157314
157314
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -166878,7 +166878,7 @@ declare namespace Word {
|
|
|
166878
166878
|
*/
|
|
166879
166879
|
errorCode?: boolean;
|
|
166880
166880
|
/**
|
|
166881
|
-
* For EACH ITEM in the collection: Gets the name of the error in the `CustomXmlValidationError` object. If no errors exist, the property returns `Nothing
|
|
166881
|
+
* For EACH ITEM in the collection: Gets the name of the error in the `CustomXmlValidationError` object. If no errors exist, the property returns `"Nothing"`.
|
|
166882
166882
|
*
|
|
166883
166883
|
* @remarks
|
|
166884
166884
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -166931,7 +166931,7 @@ declare namespace Word {
|
|
|
166931
166931
|
*/
|
|
166932
166932
|
errorCode?: boolean;
|
|
166933
166933
|
/**
|
|
166934
|
-
* Gets the name of the error in the `CustomXmlValidationError` object. If no errors exist, the property returns `Nothing
|
|
166934
|
+
* Gets the name of the error in the `CustomXmlValidationError` object. If no errors exist, the property returns `"Nothing"`.
|
|
166935
166935
|
*
|
|
166936
166936
|
* @remarks
|
|
166937
166937
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -198120,10 +198120,10 @@ declare namespace PowerPoint {
|
|
|
198120
198120
|
/**
|
|
198121
198121
|
* Exports the slide to its own presentation file, returned as Base64-encoded data.
|
|
198122
198122
|
*
|
|
198123
|
+
* Note: This method is optimized to export a single slide. Exporting multiple slides can impact performance.
|
|
198124
|
+
*
|
|
198123
198125
|
* @remarks
|
|
198124
198126
|
* [Api set: PowerPointApi 1.8]
|
|
198125
|
-
*
|
|
198126
|
-
* This method is optimized to export a single slide. Exporting multiple slides can impact performance.
|
|
198127
198127
|
*/
|
|
198128
198128
|
exportAsBase64(): OfficeExtension.ClientResult<string>;
|
|
198129
198129
|
/**
|
|
@@ -198873,7 +198873,7 @@ declare namespace PowerPoint {
|
|
|
198873
198873
|
*/
|
|
198874
198874
|
delete(): void;
|
|
198875
198875
|
/**
|
|
198876
|
-
* Returns the shape represented by the binding.
|
|
198876
|
+
* Returns the shape represented by the binding. Throws an error if the binding isn't of the correct type.
|
|
198877
198877
|
*
|
|
198878
198878
|
* @remarks
|
|
198879
198879
|
* [Api set: PowerPointApi 1.8]
|
office-js-preview/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/office-js-preview",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.646",
|
|
4
4
|
"description": "TypeScript definitions for office-js-preview",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
|
|
6
6
|
"license": "MIT",
|
|
@@ -46,7 +46,7 @@
|
|
|
46
46
|
"scripts": {},
|
|
47
47
|
"dependencies": {},
|
|
48
48
|
"peerDependencies": {},
|
|
49
|
-
"typesPublisherContentHash": "
|
|
49
|
+
"typesPublisherContentHash": "67188fae923a68af6bf41ff1d278b62bf3ea647f98ba4d1c4bc8804e188f2d6d",
|
|
50
50
|
"typeScriptVersion": "5.2",
|
|
51
51
|
"nonNpm": true
|
|
52
52
|
}
|