@types/office-js-preview 1.0.330 → 1.0.332
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 +95 -645
- 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 (https://github.com/OfficeD
|
|
|
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: Tue, 13 Sep 2022 18:26:27 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
* Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
|
|
14
14
|
|
office-js-preview/index.d.ts
CHANGED
|
@@ -1048,14 +1048,14 @@ declare namespace Office {
|
|
|
1048
1048
|
}
|
|
1049
1049
|
namespace AddinCommands {
|
|
1050
1050
|
/**
|
|
1051
|
-
* The `Event` object is passed as a parameter to add-in functions invoked by
|
|
1051
|
+
* The `Event` object is passed as a parameter to add-in functions invoked by function command buttons. The object allows the add-in to identify
|
|
1052
1052
|
* which button was clicked and to signal the host that it has completed its processing.
|
|
1053
1053
|
*
|
|
1054
1054
|
* @remarks
|
|
1055
1055
|
*
|
|
1056
1056
|
* See {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/add-in-commands-requirement-sets | Add-in commands requirement sets} for more support information.
|
|
1057
1057
|
*
|
|
1058
|
-
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: Restricted
|
|
1058
|
+
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: `Restricted`
|
|
1059
1059
|
*
|
|
1060
1060
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
1061
1061
|
*/
|
|
@@ -1072,18 +1072,20 @@ declare namespace Office {
|
|
|
1072
1072
|
/**
|
|
1073
1073
|
* Indicates that the add-in has completed processing and will automatically be closed.
|
|
1074
1074
|
*
|
|
1075
|
-
* This method must be called at the end of a function which was invoked by the following
|
|
1075
|
+
* This method must be called at the end of a function which was invoked by the following:
|
|
1076
1076
|
*
|
|
1077
|
-
* - A
|
|
1077
|
+
* - A function command button (that is, an add-in command defined with an `Action` element, where the `xsi:type` attribute is set to `ExecuteFunction`).
|
|
1078
1078
|
*
|
|
1079
|
+
* - An event defined in the {@link https://docs.microsoft.com/javascript/api/manifest/extensionpoint#launchevent | LaunchEvent extension point}.
|
|
1080
|
+
* For example, an `OnMessageSend` event.
|
|
1081
|
+
*
|
|
1079
1082
|
* - An {@link https://docs.microsoft.com/javascript/api/manifest/event | event} defined in the
|
|
1080
|
-
* {@link https://docs.microsoft.com/javascript/api/manifest/extensionpoint#events | Events extension point},
|
|
1081
|
-
* e.g., an `ItemSend` event
|
|
1082
|
-
*
|
|
1083
|
-
* [Api set: Mailbox 1.3]
|
|
1083
|
+
* {@link https://docs.microsoft.com/javascript/api/manifest/extensionpoint#events | Events extension point}. For example, an `ItemSend` event.
|
|
1084
1084
|
*
|
|
1085
1085
|
* @remarks
|
|
1086
1086
|
*
|
|
1087
|
+
* [Api set: Mailbox 1.3]
|
|
1088
|
+
*
|
|
1087
1089
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted`
|
|
1088
1090
|
*
|
|
1089
1091
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
@@ -1100,20 +1102,35 @@ declare namespace Office {
|
|
|
1100
1102
|
*/
|
|
1101
1103
|
interface EventCompletedOptions {
|
|
1102
1104
|
/**
|
|
1103
|
-
* When the completed
|
|
1104
|
-
* this value indicates if the handled event should continue execution or be canceled.
|
|
1105
|
-
* For example, an add-in that handles the `
|
|
1105
|
+
* When the {@link https://docs.microsoft.com/javascript/api/office/office.addincommands.event#office-office-addincommands-event-completed-member(1) | completed method}
|
|
1106
|
+
* is used to signal completion of an event handler, this value indicates if the handled event should continue execution or be canceled.
|
|
1107
|
+
* For example, an add-in that handles the `OnMessageSend` or `OnAppointmentSend` event can set `allowEvent` to `false` to cancel the
|
|
1108
|
+
* sending of an item. For a complete sample, see the
|
|
1109
|
+
* {@link https://docs.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough | Smart Alerts walkthrough}.
|
|
1110
|
+
*
|
|
1111
|
+
* @remarks
|
|
1112
|
+
*
|
|
1113
|
+
* [Api set: Mailbox 1.8]
|
|
1114
|
+
*
|
|
1115
|
+
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: `Restricted`
|
|
1116
|
+
*
|
|
1117
|
+
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
1106
1118
|
*/
|
|
1107
1119
|
allowEvent: boolean;
|
|
1108
1120
|
|
|
1109
1121
|
/**
|
|
1110
|
-
* When the
|
|
1111
|
-
*
|
|
1122
|
+
* When the {@link https://docs.microsoft.com/javascript/api/office/office.addincommands.event#office-office-addincommands-event-completed-member(1) | completed method}
|
|
1123
|
+
* is used to signal completion of an event handler and if the `allowEvent` option is set to `false`, this value sets the error message
|
|
1124
|
+
* that will be displayed to the user. For an example, see the
|
|
1112
1125
|
* {@link https://docs.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough | Smart Alerts walkthrough}.
|
|
1126
|
+
*
|
|
1127
|
+
* @remarks
|
|
1113
1128
|
*
|
|
1114
|
-
* [Api set: Mailbox
|
|
1129
|
+
* [Api set: Mailbox 1.12]
|
|
1130
|
+
*
|
|
1131
|
+
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: `Restricted`
|
|
1115
1132
|
*
|
|
1116
|
-
* @
|
|
1133
|
+
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
1117
1134
|
*/
|
|
1118
1135
|
errorMessage?: string;
|
|
1119
1136
|
}
|
|
@@ -83823,16 +83840,7 @@ declare namespace Word {
|
|
|
83823
83840
|
*
|
|
83824
83841
|
* @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
|
|
83825
83842
|
*/
|
|
83826
|
-
getRange(rangeLocation?: Word.RangeLocation): Word.Range;
|
|
83827
|
-
/**
|
|
83828
|
-
* Gets the whole body, or the starting or ending point of the body, as a range.
|
|
83829
|
-
*
|
|
83830
|
-
* @remarks
|
|
83831
|
-
* [Api set: WordApi 1.3]
|
|
83832
|
-
*
|
|
83833
|
-
* @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
|
|
83834
|
-
*/
|
|
83835
|
-
getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
|
|
83843
|
+
getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | Word.RangeLocation.content | "Whole" | "Start" | "End" | "After" | "Content"): Word.Range;
|
|
83836
83844
|
/**
|
|
83837
83845
|
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
83838
83846
|
*
|
|
@@ -83860,17 +83868,7 @@ declare namespace Word {
|
|
|
83860
83868
|
* @param breakType Required. The break type to add to the body.
|
|
83861
83869
|
* @param insertLocation Required. The value must be 'Start' or 'End'.
|
|
83862
83870
|
*/
|
|
83863
|
-
insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void;
|
|
83864
|
-
/**
|
|
83865
|
-
* Inserts a break at the specified location in the main document.
|
|
83866
|
-
*
|
|
83867
|
-
* @remarks
|
|
83868
|
-
* [Api set: WordApi 1.1]
|
|
83869
|
-
*
|
|
83870
|
-
* @param breakType Required. The break type to add to the body.
|
|
83871
|
-
* @param insertLocation Required. The value must be 'Start' or 'End'.
|
|
83872
|
-
*/
|
|
83873
|
-
insertBreak(breakType: "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): void;
|
|
83871
|
+
insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End"): void;
|
|
83874
83872
|
/**
|
|
83875
83873
|
* Wraps the body object with a Rich Text content control.
|
|
83876
83874
|
*
|
|
@@ -83887,17 +83885,7 @@ declare namespace Word {
|
|
|
83887
83885
|
* @param base64File Required. The base64 encoded content of a .docx file.
|
|
83888
83886
|
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
83889
83887
|
*/
|
|
83890
|
-
insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
83891
|
-
/**
|
|
83892
|
-
* Inserts a document into the body at the specified location.
|
|
83893
|
-
*
|
|
83894
|
-
* @remarks
|
|
83895
|
-
* [Api set: WordApi 1.1]
|
|
83896
|
-
*
|
|
83897
|
-
* @param base64File Required. The base64 encoded content of a .docx file.
|
|
83898
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
83899
|
-
*/
|
|
83900
|
-
insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
|
|
83888
|
+
insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
|
|
83901
83889
|
/**
|
|
83902
83890
|
* Inserts HTML at the specified location.
|
|
83903
83891
|
*
|
|
@@ -83907,27 +83895,7 @@ declare namespace Word {
|
|
|
83907
83895
|
* @param html Required. The HTML to be inserted in the document.
|
|
83908
83896
|
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
83909
83897
|
*/
|
|
83910
|
-
insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
83911
|
-
/**
|
|
83912
|
-
* Inserts HTML at the specified location.
|
|
83913
|
-
*
|
|
83914
|
-
* @remarks
|
|
83915
|
-
* [Api set: WordApi 1.1]
|
|
83916
|
-
*
|
|
83917
|
-
* @param html Required. The HTML to be inserted in the document.
|
|
83918
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
83919
|
-
*/
|
|
83920
|
-
insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
|
|
83921
|
-
/**
|
|
83922
|
-
* Inserts a picture into the body at the specified location.
|
|
83923
|
-
*
|
|
83924
|
-
* @remarks
|
|
83925
|
-
* [Api set: WordApi 1.2]
|
|
83926
|
-
*
|
|
83927
|
-
* @param base64EncodedImage Required. The base64 encoded image to be inserted in the body.
|
|
83928
|
-
* @param insertLocation Required. The value must be 'Start' or 'End'.
|
|
83929
|
-
*/
|
|
83930
|
-
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture;
|
|
83898
|
+
insertHtml(html: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
|
|
83931
83899
|
/**
|
|
83932
83900
|
* Inserts a picture into the body at the specified location.
|
|
83933
83901
|
*
|
|
@@ -83937,7 +83905,7 @@ declare namespace Word {
|
|
|
83937
83905
|
* @param base64EncodedImage Required. The base64 encoded image to be inserted in the body.
|
|
83938
83906
|
* @param insertLocation Required. The value must be 'Start' or 'End'.
|
|
83939
83907
|
*/
|
|
83940
|
-
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation:
|
|
83908
|
+
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End"): Word.InlinePicture;
|
|
83941
83909
|
/**
|
|
83942
83910
|
* Inserts OOXML at the specified location.
|
|
83943
83911
|
*
|
|
@@ -83947,17 +83915,7 @@ declare namespace Word {
|
|
|
83947
83915
|
* @param ooxml Required. The OOXML to be inserted.
|
|
83948
83916
|
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
83949
83917
|
*/
|
|
83950
|
-
insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
83951
|
-
/**
|
|
83952
|
-
* Inserts OOXML at the specified location.
|
|
83953
|
-
*
|
|
83954
|
-
* @remarks
|
|
83955
|
-
* [Api set: WordApi 1.1]
|
|
83956
|
-
*
|
|
83957
|
-
* @param ooxml Required. The OOXML to be inserted.
|
|
83958
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
83959
|
-
*/
|
|
83960
|
-
insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
|
|
83918
|
+
insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
|
|
83961
83919
|
/**
|
|
83962
83920
|
* Inserts a paragraph at the specified location.
|
|
83963
83921
|
*
|
|
@@ -83967,17 +83925,7 @@ declare namespace Word {
|
|
|
83967
83925
|
* @param paragraphText Required. The paragraph text to be inserted.
|
|
83968
83926
|
* @param insertLocation Required. The value must be 'Start' or 'End'.
|
|
83969
83927
|
*/
|
|
83970
|
-
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
|
|
83971
|
-
/**
|
|
83972
|
-
* Inserts a paragraph at the specified location.
|
|
83973
|
-
*
|
|
83974
|
-
* @remarks
|
|
83975
|
-
* [Api set: WordApi 1.1]
|
|
83976
|
-
*
|
|
83977
|
-
* @param paragraphText Required. The paragraph text to be inserted.
|
|
83978
|
-
* @param insertLocation Required. The value must be 'Start' or 'End'.
|
|
83979
|
-
*/
|
|
83980
|
-
insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph;
|
|
83928
|
+
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End"): Word.Paragraph;
|
|
83981
83929
|
/**
|
|
83982
83930
|
* Inserts a table with the specified number of rows and columns.
|
|
83983
83931
|
*
|
|
@@ -83989,29 +83937,7 @@ declare namespace Word {
|
|
|
83989
83937
|
* @param insertLocation Required. The value must be 'Start' or 'End'.
|
|
83990
83938
|
* @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
|
|
83991
83939
|
*/
|
|
83992
|
-
insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table;
|
|
83993
|
-
/**
|
|
83994
|
-
* Inserts a table with the specified number of rows and columns.
|
|
83995
|
-
*
|
|
83996
|
-
* @remarks
|
|
83997
|
-
* [Api set: WordApi 1.3]
|
|
83998
|
-
*
|
|
83999
|
-
* @param rowCount Required. The number of rows in the table.
|
|
84000
|
-
* @param columnCount Required. The number of columns in the table.
|
|
84001
|
-
* @param insertLocation Required. The value must be 'Start' or 'End'.
|
|
84002
|
-
* @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
|
|
84003
|
-
*/
|
|
84004
|
-
insertTable(rowCount: number, columnCount: number, insertLocation: "Before" | "After" | "Start" | "End" | "Replace", values?: string[][]): Word.Table;
|
|
84005
|
-
/**
|
|
84006
|
-
* Inserts text into the body at the specified location.
|
|
84007
|
-
*
|
|
84008
|
-
* @remarks
|
|
84009
|
-
* [Api set: WordApi 1.1]
|
|
84010
|
-
*
|
|
84011
|
-
* @param text Required. Text to be inserted.
|
|
84012
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
84013
|
-
*/
|
|
84014
|
-
insertText(text: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
83940
|
+
insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", values?: string[][]): Word.Table;
|
|
84015
83941
|
/**
|
|
84016
83942
|
* Inserts text into the body at the specified location.
|
|
84017
83943
|
*
|
|
@@ -84021,7 +83947,7 @@ declare namespace Word {
|
|
|
84021
83947
|
* @param text Required. Text to be inserted.
|
|
84022
83948
|
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
84023
83949
|
*/
|
|
84024
|
-
insertText(text: string, insertLocation:
|
|
83950
|
+
insertText(text: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
|
|
84025
83951
|
/**
|
|
84026
83952
|
* Performs a search with the specified SearchOptions on the scope of the body object. The search results are a collection of range objects.
|
|
84027
83953
|
*
|
|
@@ -84249,15 +84175,6 @@ declare namespace Word {
|
|
|
84249
84175
|
* [Api set: WordApiOnline 1.1]
|
|
84250
84176
|
*/
|
|
84251
84177
|
getFirstOrNullObject(): Word.Comment;
|
|
84252
|
-
/**
|
|
84253
|
-
* Gets a comment object by its index in the collection.
|
|
84254
|
-
*
|
|
84255
|
-
* @remarks
|
|
84256
|
-
* [Api set: WordApiOnline 1.1]
|
|
84257
|
-
*
|
|
84258
|
-
* @param index A number that identifies the index location of a comment object.
|
|
84259
|
-
*/
|
|
84260
|
-
getItem(index: number): Word.Comment;
|
|
84261
84178
|
/**
|
|
84262
84179
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
84263
84180
|
*
|
|
@@ -84361,19 +84278,9 @@ declare namespace Word {
|
|
|
84361
84278
|
* [Api set: WordApiOnline 1.1]
|
|
84362
84279
|
*
|
|
84363
84280
|
* @param text Required. The text to be inserted in to the CommentContentRange.
|
|
84364
|
-
* @param insertLocation Required. The value must be '
|
|
84365
|
-
*/
|
|
84366
|
-
insertText(text: string, insertLocation: Word.InsertLocation): Word.CommentContentRange;
|
|
84367
|
-
/**
|
|
84368
|
-
* Inserts text into at the specified location. **Note**: For the modern comment, the content range tracked across context turns to empty if any revision to the comment is posted through the UI.
|
|
84369
|
-
*
|
|
84370
|
-
* @remarks
|
|
84371
|
-
* [Api set: WordApiOnline 1.1]
|
|
84372
|
-
*
|
|
84373
|
-
* @param text Required. The text to be inserted in to the CommentContentRange.
|
|
84374
|
-
* @param insertLocation Required. The value must be 'After', 'Before', 'Replace', 'Start', or 'End'.
|
|
84281
|
+
* @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
|
|
84375
84282
|
*/
|
|
84376
|
-
insertText(text: string, insertLocation:
|
|
84283
|
+
insertText(text: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.CommentContentRange;
|
|
84377
84284
|
/**
|
|
84378
84285
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
84379
84286
|
*
|
|
@@ -84542,15 +84449,6 @@ declare namespace Word {
|
|
|
84542
84449
|
* [Api set: WordApiOnline 1.1]
|
|
84543
84450
|
*/
|
|
84544
84451
|
getFirstOrNullObject(): Word.CommentReply;
|
|
84545
|
-
/**
|
|
84546
|
-
* Gets a comment reply object by its index in the collection.
|
|
84547
|
-
*
|
|
84548
|
-
* @remarks
|
|
84549
|
-
* [Api set: WordApiOnline 1.1]
|
|
84550
|
-
*
|
|
84551
|
-
* @param index A number that identifies the index location of a comment reply object.
|
|
84552
|
-
*/
|
|
84553
|
-
getItem(index: number): Word.CommentReply;
|
|
84554
84452
|
/**
|
|
84555
84453
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
84556
84454
|
*
|
|
@@ -84855,18 +84753,9 @@ declare namespace Word {
|
|
|
84855
84753
|
* @remarks
|
|
84856
84754
|
* [Api set: WordApi 1.3]
|
|
84857
84755
|
*
|
|
84858
|
-
* @param rangeLocation Optional. The range location must be 'Whole', '
|
|
84859
|
-
*/
|
|
84860
|
-
getRange(rangeLocation?: Word.RangeLocation): Word.Range;
|
|
84861
|
-
/**
|
|
84862
|
-
* Gets the whole content control, or the starting or ending point of the content control, as a range.
|
|
84863
|
-
*
|
|
84864
|
-
* @remarks
|
|
84865
|
-
* [Api set: WordApi 1.3]
|
|
84866
|
-
*
|
|
84867
|
-
* @param rangeLocation Optional. The range location must be 'Whole', 'Before', 'Start', 'End', 'After', or 'Content'.
|
|
84756
|
+
* @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'Before', 'After', or 'Content'.
|
|
84868
84757
|
*/
|
|
84869
|
-
getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
|
|
84758
|
+
getRange(rangeLocation?: Word.RangeLocation | "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
|
|
84870
84759
|
/**
|
|
84871
84760
|
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
84872
84761
|
*
|
|
@@ -84904,17 +84793,7 @@ declare namespace Word {
|
|
|
84904
84793
|
* @param breakType Required. Type of break.
|
|
84905
84794
|
* @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'.
|
|
84906
84795
|
*/
|
|
84907
|
-
insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void;
|
|
84908
|
-
/**
|
|
84909
|
-
* Inserts a break at the specified location in the main document. This method cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls.
|
|
84910
|
-
*
|
|
84911
|
-
* @remarks
|
|
84912
|
-
* [Api set: WordApi 1.1]
|
|
84913
|
-
*
|
|
84914
|
-
* @param breakType Required. Type of break.
|
|
84915
|
-
* @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'.
|
|
84916
|
-
*/
|
|
84917
|
-
insertBreak(breakType: "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): void;
|
|
84796
|
+
insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After"): void;
|
|
84918
84797
|
/**
|
|
84919
84798
|
* Inserts a document into the content control at the specified location.
|
|
84920
84799
|
*
|
|
@@ -84924,17 +84803,7 @@ declare namespace Word {
|
|
|
84924
84803
|
* @param base64File Required. The base64 encoded content of a .docx file.
|
|
84925
84804
|
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
|
|
84926
84805
|
*/
|
|
84927
|
-
insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
84928
|
-
/**
|
|
84929
|
-
* Inserts a document into the content control at the specified location.
|
|
84930
|
-
*
|
|
84931
|
-
* @remarks
|
|
84932
|
-
* [Api set: WordApi 1.1]
|
|
84933
|
-
*
|
|
84934
|
-
* @param base64File Required. The base64 encoded content of a .docx file.
|
|
84935
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
|
|
84936
|
-
*/
|
|
84937
|
-
insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
|
|
84806
|
+
insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
|
|
84938
84807
|
/**
|
|
84939
84808
|
* Inserts HTML into the content control at the specified location.
|
|
84940
84809
|
*
|
|
@@ -84944,27 +84813,7 @@ declare namespace Word {
|
|
|
84944
84813
|
* @param html Required. The HTML to be inserted in to the content control.
|
|
84945
84814
|
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
|
|
84946
84815
|
*/
|
|
84947
|
-
insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
84948
|
-
/**
|
|
84949
|
-
* Inserts HTML into the content control at the specified location.
|
|
84950
|
-
*
|
|
84951
|
-
* @remarks
|
|
84952
|
-
* [Api set: WordApi 1.1]
|
|
84953
|
-
*
|
|
84954
|
-
* @param html Required. The HTML to be inserted in to the content control.
|
|
84955
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
|
|
84956
|
-
*/
|
|
84957
|
-
insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
|
|
84958
|
-
/**
|
|
84959
|
-
* Inserts an inline picture into the content control at the specified location.
|
|
84960
|
-
*
|
|
84961
|
-
* @remarks
|
|
84962
|
-
* [Api set: WordApi 1.2]
|
|
84963
|
-
*
|
|
84964
|
-
* @param base64EncodedImage Required. The base64 encoded image to be inserted in the content control.
|
|
84965
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
|
|
84966
|
-
*/
|
|
84967
|
-
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture;
|
|
84816
|
+
insertHtml(html: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
|
|
84968
84817
|
/**
|
|
84969
84818
|
* Inserts an inline picture into the content control at the specified location.
|
|
84970
84819
|
*
|
|
@@ -84974,7 +84823,7 @@ declare namespace Word {
|
|
|
84974
84823
|
* @param base64EncodedImage Required. The base64 encoded image to be inserted in the content control.
|
|
84975
84824
|
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
|
|
84976
84825
|
*/
|
|
84977
|
-
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation:
|
|
84826
|
+
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.InlinePicture;
|
|
84978
84827
|
/**
|
|
84979
84828
|
* Inserts OOXML into the content control at the specified location.
|
|
84980
84829
|
*
|
|
@@ -84984,27 +84833,7 @@ declare namespace Word {
|
|
|
84984
84833
|
* @param ooxml Required. The OOXML to be inserted in to the content control.
|
|
84985
84834
|
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
|
|
84986
84835
|
*/
|
|
84987
|
-
insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
84988
|
-
/**
|
|
84989
|
-
* Inserts OOXML into the content control at the specified location.
|
|
84990
|
-
*
|
|
84991
|
-
* @remarks
|
|
84992
|
-
* [Api set: WordApi 1.1]
|
|
84993
|
-
*
|
|
84994
|
-
* @param ooxml Required. The OOXML to be inserted in to the content control.
|
|
84995
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
|
|
84996
|
-
*/
|
|
84997
|
-
insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
|
|
84998
|
-
/**
|
|
84999
|
-
* Inserts a paragraph at the specified location.
|
|
85000
|
-
*
|
|
85001
|
-
* @remarks
|
|
85002
|
-
* [Api set: WordApi 1.1]
|
|
85003
|
-
*
|
|
85004
|
-
* @param paragraphText Required. The paragraph text to be inserted.
|
|
85005
|
-
* @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'. 'Before' and 'After' cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls.
|
|
85006
|
-
*/
|
|
85007
|
-
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
|
|
84836
|
+
insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
|
|
85008
84837
|
/**
|
|
85009
84838
|
* Inserts a paragraph at the specified location.
|
|
85010
84839
|
*
|
|
@@ -85014,7 +84843,7 @@ declare namespace Word {
|
|
|
85014
84843
|
* @param paragraphText Required. The paragraph text to be inserted.
|
|
85015
84844
|
* @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'. 'Before' and 'After' cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls.
|
|
85016
84845
|
*/
|
|
85017
|
-
insertParagraph(paragraphText: string, insertLocation:
|
|
84846
|
+
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After"): Word.Paragraph;
|
|
85018
84847
|
/**
|
|
85019
84848
|
* Inserts a table with the specified number of rows and columns into, or next to, a content control.
|
|
85020
84849
|
*
|
|
@@ -85026,29 +84855,7 @@ declare namespace Word {
|
|
|
85026
84855
|
* @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'. 'Before' and 'After' cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls.
|
|
85027
84856
|
* @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
|
|
85028
84857
|
*/
|
|
85029
|
-
insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table;
|
|
85030
|
-
/**
|
|
85031
|
-
* Inserts a table with the specified number of rows and columns into, or next to, a content control.
|
|
85032
|
-
*
|
|
85033
|
-
* @remarks
|
|
85034
|
-
* [Api set: WordApi 1.3]
|
|
85035
|
-
*
|
|
85036
|
-
* @param rowCount Required. The number of rows in the table.
|
|
85037
|
-
* @param columnCount Required. The number of columns in the table.
|
|
85038
|
-
* @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'. 'Before' and 'After' cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls.
|
|
85039
|
-
* @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
|
|
85040
|
-
*/
|
|
85041
|
-
insertTable(rowCount: number, columnCount: number, insertLocation: "Before" | "After" | "Start" | "End" | "Replace", values?: string[][]): Word.Table;
|
|
85042
|
-
/**
|
|
85043
|
-
* Inserts text into the content control at the specified location.
|
|
85044
|
-
*
|
|
85045
|
-
* @remarks
|
|
85046
|
-
* [Api set: WordApi 1.1]
|
|
85047
|
-
*
|
|
85048
|
-
* @param text Required. The text to be inserted in to the content control.
|
|
85049
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
|
|
85050
|
-
*/
|
|
85051
|
-
insertText(text: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
84858
|
+
insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After", values?: string[][]): Word.Table;
|
|
85052
84859
|
/**
|
|
85053
84860
|
* Inserts text into the content control at the specified location.
|
|
85054
84861
|
*
|
|
@@ -85058,7 +84865,7 @@ declare namespace Word {
|
|
|
85058
84865
|
* @param text Required. The text to be inserted in to the content control.
|
|
85059
84866
|
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
|
|
85060
84867
|
*/
|
|
85061
|
-
insertText(text: string, insertLocation:
|
|
84868
|
+
insertText(text: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
|
|
85062
84869
|
/**
|
|
85063
84870
|
* Performs a search with the specified SearchOptions on the scope of the content control object. The search results are a collection of range objects.
|
|
85064
84871
|
*
|
|
@@ -85243,14 +85050,14 @@ declare namespace Word {
|
|
|
85243
85050
|
*/
|
|
85244
85051
|
getFirstOrNullObject(): Word.ContentControl;
|
|
85245
85052
|
/**
|
|
85246
|
-
* Gets a content control by its
|
|
85053
|
+
* Gets a content control by its ID.
|
|
85247
85054
|
*
|
|
85248
85055
|
* @remarks
|
|
85249
85056
|
* [Api set: WordApi 1.1]
|
|
85250
85057
|
*
|
|
85251
|
-
* @param
|
|
85058
|
+
* @param id The content control's ID.
|
|
85252
85059
|
*/
|
|
85253
|
-
getItem(
|
|
85060
|
+
getItem(id: number): Word.ContentControl;
|
|
85254
85061
|
/**
|
|
85255
85062
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
85256
85063
|
*
|
|
@@ -86931,16 +86738,7 @@ declare namespace Word {
|
|
|
86931
86738
|
*
|
|
86932
86739
|
* @param rangeLocation Optional. The range location must be 'Whole', 'Start', or 'End'.
|
|
86933
86740
|
*/
|
|
86934
|
-
getRange(rangeLocation?: Word.RangeLocation): Word.Range;
|
|
86935
|
-
/**
|
|
86936
|
-
* Gets the picture, or the starting or ending point of the picture, as a range.
|
|
86937
|
-
*
|
|
86938
|
-
* @remarks
|
|
86939
|
-
* [Api set: WordApi 1.3]
|
|
86940
|
-
*
|
|
86941
|
-
* @param rangeLocation Optional. The range location must be 'Whole', 'Start', or 'End'.
|
|
86942
|
-
*/
|
|
86943
|
-
getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
|
|
86741
|
+
getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range;
|
|
86944
86742
|
/**
|
|
86945
86743
|
* Inserts a break at the specified location in the main document.
|
|
86946
86744
|
*
|
|
@@ -86950,17 +86748,7 @@ declare namespace Word {
|
|
|
86950
86748
|
* @param breakType Required. The break type to add.
|
|
86951
86749
|
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
86952
86750
|
*/
|
|
86953
|
-
insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void;
|
|
86954
|
-
/**
|
|
86955
|
-
* Inserts a break at the specified location in the main document.
|
|
86956
|
-
*
|
|
86957
|
-
* @remarks
|
|
86958
|
-
* [Api set: WordApi 1.2]
|
|
86959
|
-
*
|
|
86960
|
-
* @param breakType Required. The break type to add.
|
|
86961
|
-
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
86962
|
-
*/
|
|
86963
|
-
insertBreak(breakType: "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): void;
|
|
86751
|
+
insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void;
|
|
86964
86752
|
/**
|
|
86965
86753
|
* Wraps the inline picture with a rich text content control.
|
|
86966
86754
|
*
|
|
@@ -86977,17 +86765,7 @@ declare namespace Word {
|
|
|
86977
86765
|
* @param base64File Required. The base64 encoded content of a .docx file.
|
|
86978
86766
|
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
86979
86767
|
*/
|
|
86980
|
-
insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
86981
|
-
/**
|
|
86982
|
-
* Inserts a document at the specified location.
|
|
86983
|
-
*
|
|
86984
|
-
* @remarks
|
|
86985
|
-
* [Api set: WordApi 1.2]
|
|
86986
|
-
*
|
|
86987
|
-
* @param base64File Required. The base64 encoded content of a .docx file.
|
|
86988
|
-
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
86989
|
-
*/
|
|
86990
|
-
insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
|
|
86768
|
+
insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;
|
|
86991
86769
|
/**
|
|
86992
86770
|
* Inserts HTML at the specified location.
|
|
86993
86771
|
*
|
|
@@ -86997,27 +86775,7 @@ declare namespace Word {
|
|
|
86997
86775
|
* @param html Required. The HTML to be inserted.
|
|
86998
86776
|
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
86999
86777
|
*/
|
|
87000
|
-
insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
87001
|
-
/**
|
|
87002
|
-
* Inserts HTML at the specified location.
|
|
87003
|
-
*
|
|
87004
|
-
* @remarks
|
|
87005
|
-
* [Api set: WordApi 1.2]
|
|
87006
|
-
*
|
|
87007
|
-
* @param html Required. The HTML to be inserted.
|
|
87008
|
-
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
87009
|
-
*/
|
|
87010
|
-
insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
|
|
87011
|
-
/**
|
|
87012
|
-
* Inserts an inline picture at the specified location.
|
|
87013
|
-
*
|
|
87014
|
-
* @remarks
|
|
87015
|
-
* [Api set: WordApi 1.2]
|
|
87016
|
-
*
|
|
87017
|
-
* @param base64EncodedImage Required. The base64 encoded image to be inserted.
|
|
87018
|
-
* @param insertLocation Required. The value must be 'Replace', 'Before', or 'After'.
|
|
87019
|
-
*/
|
|
87020
|
-
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture;
|
|
86778
|
+
insertHtml(html: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;
|
|
87021
86779
|
/**
|
|
87022
86780
|
* Inserts an inline picture at the specified location.
|
|
87023
86781
|
*
|
|
@@ -87027,17 +86785,7 @@ declare namespace Word {
|
|
|
87027
86785
|
* @param base64EncodedImage Required. The base64 encoded image to be inserted.
|
|
87028
86786
|
* @param insertLocation Required. The value must be 'Replace', 'Before', or 'After'.
|
|
87029
86787
|
*/
|
|
87030
|
-
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation:
|
|
87031
|
-
/**
|
|
87032
|
-
* Inserts OOXML at the specified location.
|
|
87033
|
-
*
|
|
87034
|
-
* @remarks
|
|
87035
|
-
* [Api set: WordApi 1.2]
|
|
87036
|
-
*
|
|
87037
|
-
* @param ooxml Required. The OOXML to be inserted.
|
|
87038
|
-
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
87039
|
-
*/
|
|
87040
|
-
insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
86788
|
+
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.before | Word.InsertLocation.after | "Replace" | "Before" | "After"): Word.InlinePicture;
|
|
87041
86789
|
/**
|
|
87042
86790
|
* Inserts OOXML at the specified location.
|
|
87043
86791
|
*
|
|
@@ -87047,17 +86795,7 @@ declare namespace Word {
|
|
|
87047
86795
|
* @param ooxml Required. The OOXML to be inserted.
|
|
87048
86796
|
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
87049
86797
|
*/
|
|
87050
|
-
insertOoxml(ooxml: string, insertLocation:
|
|
87051
|
-
/**
|
|
87052
|
-
* Inserts a paragraph at the specified location.
|
|
87053
|
-
*
|
|
87054
|
-
* @remarks
|
|
87055
|
-
* [Api set: WordApi 1.2]
|
|
87056
|
-
*
|
|
87057
|
-
* @param paragraphText Required. The paragraph text to be inserted.
|
|
87058
|
-
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
87059
|
-
*/
|
|
87060
|
-
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
|
|
86798
|
+
insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;
|
|
87061
86799
|
/**
|
|
87062
86800
|
* Inserts a paragraph at the specified location.
|
|
87063
86801
|
*
|
|
@@ -87067,7 +86805,7 @@ declare namespace Word {
|
|
|
87067
86805
|
* @param paragraphText Required. The paragraph text to be inserted.
|
|
87068
86806
|
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
87069
86807
|
*/
|
|
87070
|
-
insertParagraph(paragraphText: string, insertLocation:
|
|
86808
|
+
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph;
|
|
87071
86809
|
/**
|
|
87072
86810
|
* Inserts text at the specified location.
|
|
87073
86811
|
*
|
|
@@ -87077,17 +86815,7 @@ declare namespace Word {
|
|
|
87077
86815
|
* @param text Required. Text to be inserted.
|
|
87078
86816
|
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
87079
86817
|
*/
|
|
87080
|
-
insertText(text: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
87081
|
-
/**
|
|
87082
|
-
* Inserts text at the specified location.
|
|
87083
|
-
*
|
|
87084
|
-
* @remarks
|
|
87085
|
-
* [Api set: WordApi 1.2]
|
|
87086
|
-
*
|
|
87087
|
-
* @param text Required. Text to be inserted.
|
|
87088
|
-
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
87089
|
-
*/
|
|
87090
|
-
insertText(text: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
|
|
86818
|
+
insertText(text: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;
|
|
87091
86819
|
/**
|
|
87092
86820
|
* Selects the inline picture. This causes Word to scroll to the selection.
|
|
87093
86821
|
*
|
|
@@ -87282,17 +87010,7 @@ declare namespace Word {
|
|
|
87282
87010
|
* @param paragraphText Required. The paragraph text to be inserted.
|
|
87283
87011
|
* @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'.
|
|
87284
87012
|
*/
|
|
87285
|
-
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
|
|
87286
|
-
/**
|
|
87287
|
-
* Inserts a paragraph at the specified location.
|
|
87288
|
-
*
|
|
87289
|
-
* @remarks
|
|
87290
|
-
* [Api set: WordApi 1.3]
|
|
87291
|
-
*
|
|
87292
|
-
* @param paragraphText Required. The paragraph text to be inserted.
|
|
87293
|
-
* @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'.
|
|
87294
|
-
*/
|
|
87295
|
-
insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph;
|
|
87013
|
+
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After"): Word.Paragraph;
|
|
87296
87014
|
/**
|
|
87297
87015
|
* Resets the font of the bullet, number, or picture at the specified level in the list.
|
|
87298
87016
|
*
|
|
@@ -87481,14 +87199,14 @@ declare namespace Word {
|
|
|
87481
87199
|
*/
|
|
87482
87200
|
getFirstOrNullObject(): Word.List;
|
|
87483
87201
|
/**
|
|
87484
|
-
* Gets a list object by its
|
|
87202
|
+
* Gets a list object by its ID.
|
|
87485
87203
|
*
|
|
87486
87204
|
* @remarks
|
|
87487
87205
|
* [Api set: WordApi 1.3]
|
|
87488
87206
|
*
|
|
87489
|
-
* @param
|
|
87207
|
+
* @param id The list's ID.
|
|
87490
87208
|
*/
|
|
87491
|
-
getItem(
|
|
87209
|
+
getItem(id: number): Word.List;
|
|
87492
87210
|
/**
|
|
87493
87211
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
87494
87212
|
*
|
|
@@ -88109,16 +87827,7 @@ declare namespace Word {
|
|
|
88109
87827
|
*
|
|
88110
87828
|
* @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
|
|
88111
87829
|
*/
|
|
88112
|
-
getRange(rangeLocation?: Word.RangeLocation): Word.Range;
|
|
88113
|
-
/**
|
|
88114
|
-
* Gets the whole paragraph, or the starting or ending point of the paragraph, as a range.
|
|
88115
|
-
*
|
|
88116
|
-
* @remarks
|
|
88117
|
-
* [Api set: WordApi 1.3]
|
|
88118
|
-
*
|
|
88119
|
-
* @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
|
|
88120
|
-
*/
|
|
88121
|
-
getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
|
|
87830
|
+
getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | Word.RangeLocation.content | "Whole" | "Start" | "End" | "After" | "Content"): Word.Range;
|
|
88122
87831
|
/**
|
|
88123
87832
|
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
88124
87833
|
*
|
|
@@ -88156,17 +87865,7 @@ declare namespace Word {
|
|
|
88156
87865
|
* @param breakType Required. The break type to add to the document.
|
|
88157
87866
|
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
88158
87867
|
*/
|
|
88159
|
-
insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void;
|
|
88160
|
-
/**
|
|
88161
|
-
* Inserts a break at the specified location in the main document.
|
|
88162
|
-
*
|
|
88163
|
-
* @remarks
|
|
88164
|
-
* [Api set: WordApi 1.1]
|
|
88165
|
-
*
|
|
88166
|
-
* @param breakType Required. The break type to add to the document.
|
|
88167
|
-
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
88168
|
-
*/
|
|
88169
|
-
insertBreak(breakType: "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): void;
|
|
87868
|
+
insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void;
|
|
88170
87869
|
/**
|
|
88171
87870
|
* Wraps the paragraph object with a rich text content control.
|
|
88172
87871
|
*
|
|
@@ -88183,17 +87882,7 @@ declare namespace Word {
|
|
|
88183
87882
|
* @param base64File Required. The base64 encoded content of a .docx file.
|
|
88184
87883
|
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
88185
87884
|
*/
|
|
88186
|
-
insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
88187
|
-
/**
|
|
88188
|
-
* Inserts a document into the paragraph at the specified location.
|
|
88189
|
-
*
|
|
88190
|
-
* @remarks
|
|
88191
|
-
* [Api set: WordApi 1.1]
|
|
88192
|
-
*
|
|
88193
|
-
* @param base64File Required. The base64 encoded content of a .docx file.
|
|
88194
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
88195
|
-
*/
|
|
88196
|
-
insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
|
|
87885
|
+
insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
|
|
88197
87886
|
/**
|
|
88198
87887
|
* Inserts HTML into the paragraph at the specified location.
|
|
88199
87888
|
*
|
|
@@ -88203,27 +87892,7 @@ declare namespace Word {
|
|
|
88203
87892
|
* @param html Required. The HTML to be inserted in the paragraph.
|
|
88204
87893
|
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
88205
87894
|
*/
|
|
88206
|
-
insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
88207
|
-
/**
|
|
88208
|
-
* Inserts HTML into the paragraph at the specified location.
|
|
88209
|
-
*
|
|
88210
|
-
* @remarks
|
|
88211
|
-
* [Api set: WordApi 1.1]
|
|
88212
|
-
*
|
|
88213
|
-
* @param html Required. The HTML to be inserted in the paragraph.
|
|
88214
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
88215
|
-
*/
|
|
88216
|
-
insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
|
|
88217
|
-
/**
|
|
88218
|
-
* Inserts a picture into the paragraph at the specified location.
|
|
88219
|
-
*
|
|
88220
|
-
* @remarks
|
|
88221
|
-
* [Api set: WordApi 1.1]
|
|
88222
|
-
*
|
|
88223
|
-
* @param base64EncodedImage Required. The base64 encoded image to be inserted.
|
|
88224
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
88225
|
-
*/
|
|
88226
|
-
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture;
|
|
87895
|
+
insertHtml(html: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
|
|
88227
87896
|
/**
|
|
88228
87897
|
* Inserts a picture into the paragraph at the specified location.
|
|
88229
87898
|
*
|
|
@@ -88233,7 +87902,7 @@ declare namespace Word {
|
|
|
88233
87902
|
* @param base64EncodedImage Required. The base64 encoded image to be inserted.
|
|
88234
87903
|
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
88235
87904
|
*/
|
|
88236
|
-
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation:
|
|
87905
|
+
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.InlinePicture;
|
|
88237
87906
|
/**
|
|
88238
87907
|
* Inserts OOXML into the paragraph at the specified location.
|
|
88239
87908
|
*
|
|
@@ -88243,17 +87912,7 @@ declare namespace Word {
|
|
|
88243
87912
|
* @param ooxml Required. The OOXML to be inserted in the paragraph.
|
|
88244
87913
|
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
88245
87914
|
*/
|
|
88246
|
-
insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
88247
|
-
/**
|
|
88248
|
-
* Inserts OOXML into the paragraph at the specified location.
|
|
88249
|
-
*
|
|
88250
|
-
* @remarks
|
|
88251
|
-
* [Api set: WordApi 1.1]
|
|
88252
|
-
*
|
|
88253
|
-
* @param ooxml Required. The OOXML to be inserted in the paragraph.
|
|
88254
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
88255
|
-
*/
|
|
88256
|
-
insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
|
|
87915
|
+
insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
|
|
88257
87916
|
/**
|
|
88258
87917
|
* Inserts a paragraph at the specified location.
|
|
88259
87918
|
*
|
|
@@ -88263,17 +87922,7 @@ declare namespace Word {
|
|
|
88263
87922
|
* @param paragraphText Required. The paragraph text to be inserted.
|
|
88264
87923
|
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
88265
87924
|
*/
|
|
88266
|
-
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
|
|
88267
|
-
/**
|
|
88268
|
-
* Inserts a paragraph at the specified location.
|
|
88269
|
-
*
|
|
88270
|
-
* @remarks
|
|
88271
|
-
* [Api set: WordApi 1.1]
|
|
88272
|
-
*
|
|
88273
|
-
* @param paragraphText Required. The paragraph text to be inserted.
|
|
88274
|
-
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
88275
|
-
*/
|
|
88276
|
-
insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph;
|
|
87925
|
+
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph;
|
|
88277
87926
|
/**
|
|
88278
87927
|
* Inserts a table with the specified number of rows and columns.
|
|
88279
87928
|
*
|
|
@@ -88285,19 +87934,7 @@ declare namespace Word {
|
|
|
88285
87934
|
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
88286
87935
|
* @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
|
|
88287
87936
|
*/
|
|
88288
|
-
insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table;
|
|
88289
|
-
/**
|
|
88290
|
-
* Inserts a table with the specified number of rows and columns.
|
|
88291
|
-
*
|
|
88292
|
-
* @remarks
|
|
88293
|
-
* [Api set: WordApi 1.3]
|
|
88294
|
-
*
|
|
88295
|
-
* @param rowCount Required. The number of rows in the table.
|
|
88296
|
-
* @param columnCount Required. The number of columns in the table.
|
|
88297
|
-
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
88298
|
-
* @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
|
|
88299
|
-
*/
|
|
88300
|
-
insertTable(rowCount: number, columnCount: number, insertLocation: "Before" | "After" | "Start" | "End" | "Replace", values?: string[][]): Word.Table;
|
|
87937
|
+
insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table;
|
|
88301
87938
|
/**
|
|
88302
87939
|
* Inserts text into the paragraph at the specified location.
|
|
88303
87940
|
*
|
|
@@ -88307,17 +87944,7 @@ declare namespace Word {
|
|
|
88307
87944
|
* @param text Required. Text to be inserted.
|
|
88308
87945
|
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
88309
87946
|
*/
|
|
88310
|
-
insertText(text: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
88311
|
-
/**
|
|
88312
|
-
* Inserts text into the paragraph at the specified location.
|
|
88313
|
-
*
|
|
88314
|
-
* @remarks
|
|
88315
|
-
* [Api set: WordApi 1.1]
|
|
88316
|
-
*
|
|
88317
|
-
* @param text Required. Text to be inserted.
|
|
88318
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
88319
|
-
*/
|
|
88320
|
-
insertText(text: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
|
|
87947
|
+
insertText(text: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
|
|
88321
87948
|
/**
|
|
88322
87949
|
* Performs a search with the specified SearchOptions on the scope of the paragraph object. The search results are a collection of range objects.
|
|
88323
87950
|
*
|
|
@@ -88752,16 +88379,7 @@ declare namespace Word {
|
|
|
88752
88379
|
*
|
|
88753
88380
|
* @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
|
|
88754
88381
|
*/
|
|
88755
|
-
getRange(rangeLocation?: Word.RangeLocation): Word.Range;
|
|
88756
|
-
/**
|
|
88757
|
-
* Clones the range, or gets the starting or ending point of the range as a new range.
|
|
88758
|
-
*
|
|
88759
|
-
* @remarks
|
|
88760
|
-
* [Api set: WordApi 1.3]
|
|
88761
|
-
*
|
|
88762
|
-
* @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
|
|
88763
|
-
*/
|
|
88764
|
-
getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
|
|
88382
|
+
getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | Word.RangeLocation.content | "Whole" | "Start" | "End" | "After" | "Content"): Word.Range;
|
|
88765
88383
|
/**
|
|
88766
88384
|
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
88767
88385
|
*
|
|
@@ -88809,17 +88427,7 @@ declare namespace Word {
|
|
|
88809
88427
|
* @param breakType Required. The break type to add.
|
|
88810
88428
|
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
88811
88429
|
*/
|
|
88812
|
-
insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void;
|
|
88813
|
-
/**
|
|
88814
|
-
* Inserts a break at the specified location in the main document.
|
|
88815
|
-
*
|
|
88816
|
-
* @remarks
|
|
88817
|
-
* [Api set: WordApi 1.1]
|
|
88818
|
-
*
|
|
88819
|
-
* @param breakType Required. The break type to add.
|
|
88820
|
-
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
88821
|
-
*/
|
|
88822
|
-
insertBreak(breakType: "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): void;
|
|
88430
|
+
insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void;
|
|
88823
88431
|
/**
|
|
88824
88432
|
* Insert a comment on the range.
|
|
88825
88433
|
*
|
|
@@ -88855,17 +88463,7 @@ declare namespace Word {
|
|
|
88855
88463
|
* @param base64File Required. The base64 encoded content of a .docx file.
|
|
88856
88464
|
* @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
|
|
88857
88465
|
*/
|
|
88858
|
-
insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
88859
|
-
/**
|
|
88860
|
-
* Inserts a document at the specified location.
|
|
88861
|
-
*
|
|
88862
|
-
* @remarks
|
|
88863
|
-
* [Api set: WordApi 1.1]
|
|
88864
|
-
*
|
|
88865
|
-
* @param base64File Required. The base64 encoded content of a .docx file.
|
|
88866
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
|
|
88867
|
-
*/
|
|
88868
|
-
insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
|
|
88466
|
+
insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;
|
|
88869
88467
|
/**
|
|
88870
88468
|
* Inserts a footnote. The footnote reference is placed after the range.
|
|
88871
88469
|
*
|
|
@@ -88884,17 +88482,7 @@ declare namespace Word {
|
|
|
88884
88482
|
* @param html Required. The HTML to be inserted.
|
|
88885
88483
|
* @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
|
|
88886
88484
|
*/
|
|
88887
|
-
insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
88888
|
-
/**
|
|
88889
|
-
* Inserts HTML at the specified location.
|
|
88890
|
-
*
|
|
88891
|
-
* @remarks
|
|
88892
|
-
* [Api set: WordApi 1.1]
|
|
88893
|
-
*
|
|
88894
|
-
* @param html Required. The HTML to be inserted.
|
|
88895
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
|
|
88896
|
-
*/
|
|
88897
|
-
insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
|
|
88485
|
+
insertHtml(html: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;
|
|
88898
88486
|
/**
|
|
88899
88487
|
* Inserts a picture at the specified location.
|
|
88900
88488
|
*
|
|
@@ -88904,17 +88492,7 @@ declare namespace Word {
|
|
|
88904
88492
|
* @param base64EncodedImage Required. The base64 encoded image to be inserted.
|
|
88905
88493
|
* @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
|
|
88906
88494
|
*/
|
|
88907
|
-
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture;
|
|
88908
|
-
/**
|
|
88909
|
-
* Inserts a picture at the specified location.
|
|
88910
|
-
*
|
|
88911
|
-
* @remarks
|
|
88912
|
-
* [Api set: WordApi 1.2]
|
|
88913
|
-
*
|
|
88914
|
-
* @param base64EncodedImage Required. The base64 encoded image to be inserted.
|
|
88915
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
|
|
88916
|
-
*/
|
|
88917
|
-
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.InlinePicture;
|
|
88495
|
+
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.InlinePicture;
|
|
88918
88496
|
/**
|
|
88919
88497
|
* Inserts OOXML at the specified location.
|
|
88920
88498
|
*
|
|
@@ -88924,27 +88502,7 @@ declare namespace Word {
|
|
|
88924
88502
|
* @param ooxml Required. The OOXML to be inserted.
|
|
88925
88503
|
* @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
|
|
88926
88504
|
*/
|
|
88927
|
-
insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
88928
|
-
/**
|
|
88929
|
-
* Inserts OOXML at the specified location.
|
|
88930
|
-
*
|
|
88931
|
-
* @remarks
|
|
88932
|
-
* [Api set: WordApi 1.1]
|
|
88933
|
-
*
|
|
88934
|
-
* @param ooxml Required. The OOXML to be inserted.
|
|
88935
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
|
|
88936
|
-
*/
|
|
88937
|
-
insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
|
|
88938
|
-
/**
|
|
88939
|
-
* Inserts a paragraph at the specified location.
|
|
88940
|
-
*
|
|
88941
|
-
* @remarks
|
|
88942
|
-
* [Api set: WordApi 1.1]
|
|
88943
|
-
*
|
|
88944
|
-
* @param paragraphText Required. The paragraph text to be inserted.
|
|
88945
|
-
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
88946
|
-
*/
|
|
88947
|
-
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
|
|
88505
|
+
insertOoxml(ooxml: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;
|
|
88948
88506
|
/**
|
|
88949
88507
|
* Inserts a paragraph at the specified location.
|
|
88950
88508
|
*
|
|
@@ -88954,7 +88512,7 @@ declare namespace Word {
|
|
|
88954
88512
|
* @param paragraphText Required. The paragraph text to be inserted.
|
|
88955
88513
|
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
88956
88514
|
*/
|
|
88957
|
-
insertParagraph(paragraphText: string, insertLocation:
|
|
88515
|
+
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph;
|
|
88958
88516
|
/**
|
|
88959
88517
|
* Inserts a table with the specified number of rows and columns.
|
|
88960
88518
|
*
|
|
@@ -88966,29 +88524,7 @@ declare namespace Word {
|
|
|
88966
88524
|
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
88967
88525
|
* @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
|
|
88968
88526
|
*/
|
|
88969
|
-
insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table;
|
|
88970
|
-
/**
|
|
88971
|
-
* Inserts a table with the specified number of rows and columns.
|
|
88972
|
-
*
|
|
88973
|
-
* @remarks
|
|
88974
|
-
* [Api set: WordApi 1.3]
|
|
88975
|
-
*
|
|
88976
|
-
* @param rowCount Required. The number of rows in the table.
|
|
88977
|
-
* @param columnCount Required. The number of columns in the table.
|
|
88978
|
-
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
88979
|
-
* @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
|
|
88980
|
-
*/
|
|
88981
|
-
insertTable(rowCount: number, columnCount: number, insertLocation: "Before" | "After" | "Start" | "End" | "Replace", values?: string[][]): Word.Table;
|
|
88982
|
-
/**
|
|
88983
|
-
* Inserts text at the specified location.
|
|
88984
|
-
*
|
|
88985
|
-
* @remarks
|
|
88986
|
-
* [Api set: WordApi 1.1]
|
|
88987
|
-
*
|
|
88988
|
-
* @param text Required. Text to be inserted.
|
|
88989
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
|
|
88990
|
-
*/
|
|
88991
|
-
insertText(text: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
88527
|
+
insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table;
|
|
88992
88528
|
/**
|
|
88993
88529
|
* Inserts text at the specified location.
|
|
88994
88530
|
*
|
|
@@ -88998,7 +88534,7 @@ declare namespace Word {
|
|
|
88998
88534
|
* @param text Required. Text to be inserted.
|
|
88999
88535
|
* @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
|
|
89000
88536
|
*/
|
|
89001
|
-
insertText(text: string, insertLocation:
|
|
88537
|
+
insertText(text: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;
|
|
89002
88538
|
/**
|
|
89003
88539
|
* Returns a new range as the intersection of this range with another range. This range is not changed. Throws an error if the two ranges are not overlapped or adjacent.
|
|
89004
88540
|
*
|
|
@@ -89828,29 +89364,7 @@ declare namespace Word {
|
|
|
89828
89364
|
* @param columnCount Required. Number of columns to add.
|
|
89829
89365
|
* @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
|
|
89830
89366
|
*/
|
|
89831
|
-
addColumns(insertLocation: Word.InsertLocation, columnCount: number, values?: string[][]): void;
|
|
89832
|
-
/**
|
|
89833
|
-
* Adds columns to the start or end of the table, using the first or last existing column as a template. This is applicable to uniform tables. The string values, if specified, are set in the newly inserted rows.
|
|
89834
|
-
*
|
|
89835
|
-
* @remarks
|
|
89836
|
-
* [Api set: WordApi 1.3]
|
|
89837
|
-
*
|
|
89838
|
-
* @param insertLocation Required. It must be 'Start' or 'End', corresponding to the appropriate side of the table.
|
|
89839
|
-
* @param columnCount Required. Number of columns to add.
|
|
89840
|
-
* @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
|
|
89841
|
-
*/
|
|
89842
|
-
addColumns(insertLocation: "Before" | "After" | "Start" | "End" | "Replace", columnCount: number, values?: string[][]): void;
|
|
89843
|
-
/**
|
|
89844
|
-
* Adds rows to the start or end of the table, using the first or last existing row as a template. The string values, if specified, are set in the newly inserted rows.
|
|
89845
|
-
*
|
|
89846
|
-
* @remarks
|
|
89847
|
-
* [Api set: WordApi 1.3]
|
|
89848
|
-
*
|
|
89849
|
-
* @param insertLocation Required. It must be 'Start' or 'End'.
|
|
89850
|
-
* @param rowCount Required. Number of rows to add.
|
|
89851
|
-
* @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
|
|
89852
|
-
*/
|
|
89853
|
-
addRows(insertLocation: Word.InsertLocation, rowCount: number, values?: string[][]): Word.TableRowCollection;
|
|
89367
|
+
addColumns(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", columnCount: number, values?: string[][]): void;
|
|
89854
89368
|
/**
|
|
89855
89369
|
* Adds rows to the start or end of the table, using the first or last existing row as a template. The string values, if specified, are set in the newly inserted rows.
|
|
89856
89370
|
*
|
|
@@ -89861,7 +89375,7 @@ declare namespace Word {
|
|
|
89861
89375
|
* @param rowCount Required. Number of rows to add.
|
|
89862
89376
|
* @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
|
|
89863
89377
|
*/
|
|
89864
|
-
addRows(insertLocation:
|
|
89378
|
+
addRows(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", rowCount: number, values?: string[][]): Word.TableRowCollection;
|
|
89865
89379
|
/**
|
|
89866
89380
|
* Autofits the table columns to the width of the window.
|
|
89867
89381
|
*
|
|
@@ -90016,16 +89530,7 @@ declare namespace Word {
|
|
|
90016
89530
|
*
|
|
90017
89531
|
* @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', or 'After'.
|
|
90018
89532
|
*/
|
|
90019
|
-
getRange(rangeLocation?: Word.RangeLocation): Word.Range;
|
|
90020
|
-
/**
|
|
90021
|
-
* Gets the range that contains this table, or the range at the start or end of the table.
|
|
90022
|
-
*
|
|
90023
|
-
* @remarks
|
|
90024
|
-
* [Api set: WordApi 1.3]
|
|
90025
|
-
*
|
|
90026
|
-
* @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', or 'After'.
|
|
90027
|
-
*/
|
|
90028
|
-
getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
|
|
89533
|
+
getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | "Whole" | "Start" | "End" | "After"): Word.Range;
|
|
90029
89534
|
/**
|
|
90030
89535
|
* Inserts a content control on the table.
|
|
90031
89536
|
*
|
|
@@ -90042,17 +89547,7 @@ declare namespace Word {
|
|
|
90042
89547
|
* @param paragraphText Required. The paragraph text to be inserted.
|
|
90043
89548
|
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
90044
89549
|
*/
|
|
90045
|
-
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
|
|
90046
|
-
/**
|
|
90047
|
-
* Inserts a paragraph at the specified location.
|
|
90048
|
-
*
|
|
90049
|
-
* @remarks
|
|
90050
|
-
* [Api set: WordApi 1.3]
|
|
90051
|
-
*
|
|
90052
|
-
* @param paragraphText Required. The paragraph text to be inserted.
|
|
90053
|
-
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
90054
|
-
*/
|
|
90055
|
-
insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph;
|
|
89550
|
+
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph;
|
|
90056
89551
|
/**
|
|
90057
89552
|
* Inserts a table with the specified number of rows and columns.
|
|
90058
89553
|
*
|
|
@@ -90064,19 +89559,7 @@ declare namespace Word {
|
|
|
90064
89559
|
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
90065
89560
|
* @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
|
|
90066
89561
|
*/
|
|
90067
|
-
insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table;
|
|
90068
|
-
/**
|
|
90069
|
-
* Inserts a table with the specified number of rows and columns.
|
|
90070
|
-
*
|
|
90071
|
-
* @remarks
|
|
90072
|
-
* [Api set: WordApi 1.3]
|
|
90073
|
-
*
|
|
90074
|
-
* @param rowCount Required. The number of rows in the table.
|
|
90075
|
-
* @param columnCount Required. The number of columns in the table.
|
|
90076
|
-
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
90077
|
-
* @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
|
|
90078
|
-
*/
|
|
90079
|
-
insertTable(rowCount: number, columnCount: number, insertLocation: "Before" | "After" | "Start" | "End" | "Replace", values?: string[][]): Word.Table;
|
|
89562
|
+
insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table;
|
|
90080
89563
|
/**
|
|
90081
89564
|
* Merges the cells bounded inclusively by a first and last cell.
|
|
90082
89565
|
*
|
|
@@ -90436,18 +89919,7 @@ declare namespace Word {
|
|
|
90436
89919
|
* @param rowCount Required. Number of rows to add
|
|
90437
89920
|
* @param values Optional. Strings to insert in the new rows, specified as a 2D array. The number of cells in each row must not exceed the number of cells in the existing row.
|
|
90438
89921
|
*/
|
|
90439
|
-
insertRows(insertLocation: Word.InsertLocation, rowCount: number, values?: string[][]): Word.TableRowCollection;
|
|
90440
|
-
/**
|
|
90441
|
-
* Inserts rows using this row as a template. If values are specified, inserts the values into the new rows.
|
|
90442
|
-
*
|
|
90443
|
-
* @remarks
|
|
90444
|
-
* [Api set: WordApi 1.3]
|
|
90445
|
-
*
|
|
90446
|
-
* @param insertLocation Required. Where the new rows should be inserted, relative to the current row. It must be 'Before' or 'After'.
|
|
90447
|
-
* @param rowCount Required. Number of rows to add
|
|
90448
|
-
* @param values Optional. Strings to insert in the new rows, specified as a 2D array. The number of cells in each row must not exceed the number of cells in the existing row.
|
|
90449
|
-
*/
|
|
90450
|
-
insertRows(insertLocation: "Before" | "After" | "Start" | "End" | "Replace", rowCount: number, values?: string[][]): Word.TableRowCollection;
|
|
89922
|
+
insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection;
|
|
90451
89923
|
/**
|
|
90452
89924
|
* Merges the row into one cell.
|
|
90453
89925
|
*
|
|
@@ -90772,29 +90244,7 @@ declare namespace Word {
|
|
|
90772
90244
|
* @param columnCount Required. Number of columns to add.
|
|
90773
90245
|
* @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
|
|
90774
90246
|
*/
|
|
90775
|
-
insertColumns(insertLocation: Word.InsertLocation, columnCount: number, values?: string[][]): void;
|
|
90776
|
-
/**
|
|
90777
|
-
* Adds columns to the left or right of the cell, using the cell's column as a template. This is applicable to uniform tables. The string values, if specified, are set in the newly inserted rows.
|
|
90778
|
-
*
|
|
90779
|
-
* @remarks
|
|
90780
|
-
* [Api set: WordApi 1.3]
|
|
90781
|
-
*
|
|
90782
|
-
* @param insertLocation Required. It must be 'Before' or 'After'.
|
|
90783
|
-
* @param columnCount Required. Number of columns to add.
|
|
90784
|
-
* @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
|
|
90785
|
-
*/
|
|
90786
|
-
insertColumns(insertLocation: "Before" | "After" | "Start" | "End" | "Replace", columnCount: number, values?: string[][]): void;
|
|
90787
|
-
/**
|
|
90788
|
-
* Inserts rows above or below the cell, using the cell's row as a template. The string values, if specified, are set in the newly inserted rows.
|
|
90789
|
-
*
|
|
90790
|
-
* @remarks
|
|
90791
|
-
* [Api set: WordApi 1.3]
|
|
90792
|
-
*
|
|
90793
|
-
* @param insertLocation Required. It must be 'Before' or 'After'.
|
|
90794
|
-
* @param rowCount Required. Number of rows to add.
|
|
90795
|
-
* @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
|
|
90796
|
-
*/
|
|
90797
|
-
insertRows(insertLocation: Word.InsertLocation, rowCount: number, values?: string[][]): Word.TableRowCollection;
|
|
90247
|
+
insertColumns(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", columnCount: number, values?: string[][]): void;
|
|
90798
90248
|
/**
|
|
90799
90249
|
* Inserts rows above or below the cell, using the cell's row as a template. The string values, if specified, are set in the newly inserted rows.
|
|
90800
90250
|
*
|
|
@@ -90805,7 +90255,7 @@ declare namespace Word {
|
|
|
90805
90255
|
* @param rowCount Required. Number of rows to add.
|
|
90806
90256
|
* @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
|
|
90807
90257
|
*/
|
|
90808
|
-
insertRows(insertLocation:
|
|
90258
|
+
insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection;
|
|
90809
90259
|
/**
|
|
90810
90260
|
* Sets cell padding in points.
|
|
90811
90261
|
*
|
|
@@ -91223,7 +90673,7 @@ declare namespace Word {
|
|
|
91223
90673
|
plainText = "PlainText",
|
|
91224
90674
|
}
|
|
91225
90675
|
/**
|
|
91226
|
-
* ContentControl appearance
|
|
90676
|
+
* ContentControl appearance.
|
|
91227
90677
|
*
|
|
91228
90678
|
* @remarks
|
|
91229
90679
|
* [Api set: WordApi 1.1]
|
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.332",
|
|
4
4
|
"description": "TypeScript definitions for Office.js",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
|
|
6
6
|
"license": "MIT",
|
|
@@ -45,6 +45,6 @@
|
|
|
45
45
|
},
|
|
46
46
|
"scripts": {},
|
|
47
47
|
"dependencies": {},
|
|
48
|
-
"typesPublisherContentHash": "
|
|
48
|
+
"typesPublisherContentHash": "29267df73c9abe3630aeb248a6956997cb0fdc27cd0f7fab6e2535a35790b3e5",
|
|
49
49
|
"typeScriptVersion": "4.1"
|
|
50
50
|
}
|