@types/office-js-preview 1.0.331 → 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.
@@ -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: Mon, 12 Sep 2022 21:02:43 GMT
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
 
@@ -83840,16 +83840,7 @@ declare namespace Word {
83840
83840
  *
83841
83841
  * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
83842
83842
  */
83843
- getRange(rangeLocation?: Word.RangeLocation): Word.Range;
83844
- /**
83845
- * Gets the whole body, or the starting or ending point of the body, as a range.
83846
- *
83847
- * @remarks
83848
- * [Api set: WordApi 1.3]
83849
- *
83850
- * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
83851
- */
83852
- 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;
83853
83844
  /**
83854
83845
  * Gets reviewed text based on ChangeTrackingVersion selection.
83855
83846
  *
@@ -83877,17 +83868,7 @@ declare namespace Word {
83877
83868
  * @param breakType Required. The break type to add to the body.
83878
83869
  * @param insertLocation Required. The value must be 'Start' or 'End'.
83879
83870
  */
83880
- insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void;
83881
- /**
83882
- * Inserts a break at the specified location in the main document.
83883
- *
83884
- * @remarks
83885
- * [Api set: WordApi 1.1]
83886
- *
83887
- * @param breakType Required. The break type to add to the body.
83888
- * @param insertLocation Required. The value must be 'Start' or 'End'.
83889
- */
83890
- 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;
83891
83872
  /**
83892
83873
  * Wraps the body object with a Rich Text content control.
83893
83874
  *
@@ -83904,27 +83885,7 @@ declare namespace Word {
83904
83885
  * @param base64File Required. The base64 encoded content of a .docx file.
83905
83886
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
83906
83887
  */
83907
- insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range;
83908
- /**
83909
- * Inserts a document into the body at the specified location.
83910
- *
83911
- * @remarks
83912
- * [Api set: WordApi 1.1]
83913
- *
83914
- * @param base64File Required. The base64 encoded content of a .docx file.
83915
- * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
83916
- */
83917
- insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
83918
- /**
83919
- * Inserts HTML at the specified location.
83920
- *
83921
- * @remarks
83922
- * [Api set: WordApi 1.1]
83923
- *
83924
- * @param html Required. The HTML to be inserted in the document.
83925
- * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
83926
- */
83927
- insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range;
83888
+ insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
83928
83889
  /**
83929
83890
  * Inserts HTML at the specified location.
83930
83891
  *
@@ -83934,17 +83895,7 @@ declare namespace Word {
83934
83895
  * @param html Required. The HTML to be inserted in the document.
83935
83896
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
83936
83897
  */
83937
- insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
83938
- /**
83939
- * Inserts a picture into the body at the specified location.
83940
- *
83941
- * @remarks
83942
- * [Api set: WordApi 1.2]
83943
- *
83944
- * @param base64EncodedImage Required. The base64 encoded image to be inserted in the body.
83945
- * @param insertLocation Required. The value must be 'Start' or 'End'.
83946
- */
83947
- 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;
83948
83899
  /**
83949
83900
  * Inserts a picture into the body at the specified location.
83950
83901
  *
@@ -83954,17 +83905,7 @@ declare namespace Word {
83954
83905
  * @param base64EncodedImage Required. The base64 encoded image to be inserted in the body.
83955
83906
  * @param insertLocation Required. The value must be 'Start' or 'End'.
83956
83907
  */
83957
- insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.InlinePicture;
83958
- /**
83959
- * Inserts OOXML at the specified location.
83960
- *
83961
- * @remarks
83962
- * [Api set: WordApi 1.1]
83963
- *
83964
- * @param ooxml Required. The OOXML to be inserted.
83965
- * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
83966
- */
83967
- insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range;
83908
+ insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End"): Word.InlinePicture;
83968
83909
  /**
83969
83910
  * Inserts OOXML at the specified location.
83970
83911
  *
@@ -83974,17 +83915,7 @@ declare namespace Word {
83974
83915
  * @param ooxml Required. The OOXML to be inserted.
83975
83916
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
83976
83917
  */
83977
- insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
83978
- /**
83979
- * Inserts a paragraph at the specified location.
83980
- *
83981
- * @remarks
83982
- * [Api set: WordApi 1.1]
83983
- *
83984
- * @param paragraphText Required. The paragraph text to be inserted.
83985
- * @param insertLocation Required. The value must be 'Start' or 'End'.
83986
- */
83987
- insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
83918
+ insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
83988
83919
  /**
83989
83920
  * Inserts a paragraph at the specified location.
83990
83921
  *
@@ -83994,7 +83925,7 @@ declare namespace Word {
83994
83925
  * @param paragraphText Required. The paragraph text to be inserted.
83995
83926
  * @param insertLocation Required. The value must be 'Start' or 'End'.
83996
83927
  */
83997
- 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;
83998
83929
  /**
83999
83930
  * Inserts a table with the specified number of rows and columns.
84000
83931
  *
@@ -84006,29 +83937,7 @@ declare namespace Word {
84006
83937
  * @param insertLocation Required. The value must be 'Start' or 'End'.
84007
83938
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
84008
83939
  */
84009
- insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table;
84010
- /**
84011
- * Inserts a table with the specified number of rows and columns.
84012
- *
84013
- * @remarks
84014
- * [Api set: WordApi 1.3]
84015
- *
84016
- * @param rowCount Required. The number of rows in the table.
84017
- * @param columnCount Required. The number of columns in the table.
84018
- * @param insertLocation Required. The value must be 'Start' or 'End'.
84019
- * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
84020
- */
84021
- insertTable(rowCount: number, columnCount: number, insertLocation: "Before" | "After" | "Start" | "End" | "Replace", values?: string[][]): Word.Table;
84022
- /**
84023
- * Inserts text into the body at the specified location.
84024
- *
84025
- * @remarks
84026
- * [Api set: WordApi 1.1]
84027
- *
84028
- * @param text Required. Text to be inserted.
84029
- * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
84030
- */
84031
- 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;
84032
83941
  /**
84033
83942
  * Inserts text into the body at the specified location.
84034
83943
  *
@@ -84038,7 +83947,7 @@ declare namespace Word {
84038
83947
  * @param text Required. Text to be inserted.
84039
83948
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
84040
83949
  */
84041
- insertText(text: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
83950
+ insertText(text: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
84042
83951
  /**
84043
83952
  * Performs a search with the specified SearchOptions on the scope of the body object. The search results are a collection of range objects.
84044
83953
  *
@@ -84266,15 +84175,6 @@ declare namespace Word {
84266
84175
  * [Api set: WordApiOnline 1.1]
84267
84176
  */
84268
84177
  getFirstOrNullObject(): Word.Comment;
84269
- /**
84270
- * Gets a comment object by its index in the collection.
84271
- *
84272
- * @remarks
84273
- * [Api set: WordApiOnline 1.1]
84274
- *
84275
- * @param index A number that identifies the index location of a comment object.
84276
- */
84277
- getItem(index: number): Word.Comment;
84278
84178
  /**
84279
84179
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
84280
84180
  *
@@ -84378,19 +84278,9 @@ declare namespace Word {
84378
84278
  * [Api set: WordApiOnline 1.1]
84379
84279
  *
84380
84280
  * @param text Required. The text to be inserted in to the CommentContentRange.
84381
- * @param insertLocation Required. The value must be 'After', 'Before', 'Replace', 'Start', or 'End'.
84382
- */
84383
- insertText(text: string, insertLocation: Word.InsertLocation): Word.CommentContentRange;
84384
- /**
84385
- * 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.
84386
- *
84387
- * @remarks
84388
- * [Api set: WordApiOnline 1.1]
84389
- *
84390
- * @param text Required. The text to be inserted in to the CommentContentRange.
84391
- * @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'.
84392
84282
  */
84393
- insertText(text: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.CommentContentRange;
84283
+ insertText(text: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.CommentContentRange;
84394
84284
  /**
84395
84285
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
84396
84286
  *
@@ -84559,15 +84449,6 @@ declare namespace Word {
84559
84449
  * [Api set: WordApiOnline 1.1]
84560
84450
  */
84561
84451
  getFirstOrNullObject(): Word.CommentReply;
84562
- /**
84563
- * Gets a comment reply object by its index in the collection.
84564
- *
84565
- * @remarks
84566
- * [Api set: WordApiOnline 1.1]
84567
- *
84568
- * @param index A number that identifies the index location of a comment reply object.
84569
- */
84570
- getItem(index: number): Word.CommentReply;
84571
84452
  /**
84572
84453
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
84573
84454
  *
@@ -84872,18 +84753,9 @@ declare namespace Word {
84872
84753
  * @remarks
84873
84754
  * [Api set: WordApi 1.3]
84874
84755
  *
84875
- * @param rangeLocation Optional. The range location must be 'Whole', 'Before', 'Start', 'End', 'After', or 'Content'.
84876
- */
84877
- getRange(rangeLocation?: Word.RangeLocation): Word.Range;
84878
- /**
84879
- * Gets the whole content control, or the starting or ending point of the content control, as a range.
84880
- *
84881
- * @remarks
84882
- * [Api set: WordApi 1.3]
84883
- *
84884
- * @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'.
84885
84757
  */
84886
- getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
84758
+ getRange(rangeLocation?: Word.RangeLocation | "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
84887
84759
  /**
84888
84760
  * Gets reviewed text based on ChangeTrackingVersion selection.
84889
84761
  *
@@ -84921,17 +84793,7 @@ declare namespace Word {
84921
84793
  * @param breakType Required. Type of break.
84922
84794
  * @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'.
84923
84795
  */
84924
- insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void;
84925
- /**
84926
- * Inserts a break at the specified location in the main document. This method cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls.
84927
- *
84928
- * @remarks
84929
- * [Api set: WordApi 1.1]
84930
- *
84931
- * @param breakType Required. Type of break.
84932
- * @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'.
84933
- */
84934
- 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;
84935
84797
  /**
84936
84798
  * Inserts a document into the content control at the specified location.
84937
84799
  *
@@ -84941,27 +84803,7 @@ declare namespace Word {
84941
84803
  * @param base64File Required. The base64 encoded content of a .docx file.
84942
84804
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84943
84805
  */
84944
- insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range;
84945
- /**
84946
- * Inserts a document into the content control at the specified location.
84947
- *
84948
- * @remarks
84949
- * [Api set: WordApi 1.1]
84950
- *
84951
- * @param base64File Required. The base64 encoded content of a .docx file.
84952
- * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84953
- */
84954
- insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
84955
- /**
84956
- * Inserts HTML into the content control at the specified location.
84957
- *
84958
- * @remarks
84959
- * [Api set: WordApi 1.1]
84960
- *
84961
- * @param html Required. The HTML to be inserted in to the content control.
84962
- * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84963
- */
84964
- insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range;
84806
+ insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
84965
84807
  /**
84966
84808
  * Inserts HTML into the content control at the specified location.
84967
84809
  *
@@ -84971,17 +84813,7 @@ declare namespace Word {
84971
84813
  * @param html Required. The HTML to be inserted in to the content control.
84972
84814
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84973
84815
  */
84974
- insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
84975
- /**
84976
- * Inserts an inline picture into the content control at the specified location.
84977
- *
84978
- * @remarks
84979
- * [Api set: WordApi 1.2]
84980
- *
84981
- * @param base64EncodedImage Required. The base64 encoded image to be inserted in the content control.
84982
- * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84983
- */
84984
- 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;
84985
84817
  /**
84986
84818
  * Inserts an inline picture into the content control at the specified location.
84987
84819
  *
@@ -84991,17 +84823,7 @@ declare namespace Word {
84991
84823
  * @param base64EncodedImage Required. The base64 encoded image to be inserted in the content control.
84992
84824
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84993
84825
  */
84994
- insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.InlinePicture;
84995
- /**
84996
- * Inserts OOXML into the content control at the specified location.
84997
- *
84998
- * @remarks
84999
- * [Api set: WordApi 1.1]
85000
- *
85001
- * @param ooxml Required. The OOXML to be inserted in to the content control.
85002
- * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
85003
- */
85004
- insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range;
84826
+ insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.InlinePicture;
85005
84827
  /**
85006
84828
  * Inserts OOXML into the content control at the specified location.
85007
84829
  *
@@ -85011,7 +84833,7 @@ declare namespace Word {
85011
84833
  * @param ooxml Required. The OOXML to be inserted in to the content control.
85012
84834
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
85013
84835
  */
85014
- insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
84836
+ insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
85015
84837
  /**
85016
84838
  * Inserts a paragraph at the specified location.
85017
84839
  *
@@ -85021,29 +84843,7 @@ declare namespace Word {
85021
84843
  * @param paragraphText Required. The paragraph text to be inserted.
85022
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.
85023
84845
  */
85024
- insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
85025
- /**
85026
- * Inserts a paragraph at the specified location.
85027
- *
85028
- * @remarks
85029
- * [Api set: WordApi 1.1]
85030
- *
85031
- * @param paragraphText Required. The paragraph text to be inserted.
85032
- * @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.
85033
- */
85034
- insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph;
85035
- /**
85036
- * Inserts a table with the specified number of rows and columns into, or next to, a content control.
85037
- *
85038
- * @remarks
85039
- * [Api set: WordApi 1.3]
85040
- *
85041
- * @param rowCount Required. The number of rows in the table.
85042
- * @param columnCount Required. The number of columns in the table.
85043
- * @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.
85044
- * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
85045
- */
85046
- insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table;
84846
+ insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After"): Word.Paragraph;
85047
84847
  /**
85048
84848
  * Inserts a table with the specified number of rows and columns into, or next to, a content control.
85049
84849
  *
@@ -85055,7 +84855,7 @@ declare namespace Word {
85055
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.
85056
84856
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
85057
84857
  */
85058
- insertTable(rowCount: number, columnCount: number, insertLocation: "Before" | "After" | "Start" | "End" | "Replace", values?: string[][]): Word.Table;
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;
85059
84859
  /**
85060
84860
  * Inserts text into the content control at the specified location.
85061
84861
  *
@@ -85065,17 +84865,7 @@ declare namespace Word {
85065
84865
  * @param text Required. The text to be inserted in to the content control.
85066
84866
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
85067
84867
  */
85068
- insertText(text: string, insertLocation: Word.InsertLocation): Word.Range;
85069
- /**
85070
- * Inserts text into the content control at the specified location.
85071
- *
85072
- * @remarks
85073
- * [Api set: WordApi 1.1]
85074
- *
85075
- * @param text Required. The text to be inserted in to the content control.
85076
- * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
85077
- */
85078
- insertText(text: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
84868
+ insertText(text: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
85079
84869
  /**
85080
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.
85081
84871
  *
@@ -85260,14 +85050,14 @@ declare namespace Word {
85260
85050
  */
85261
85051
  getFirstOrNullObject(): Word.ContentControl;
85262
85052
  /**
85263
- * Gets a content control by its index in the collection.
85053
+ * Gets a content control by its ID.
85264
85054
  *
85265
85055
  * @remarks
85266
85056
  * [Api set: WordApi 1.1]
85267
85057
  *
85268
- * @param index The index.
85058
+ * @param id The content control's ID.
85269
85059
  */
85270
- getItem(index: number): Word.ContentControl;
85060
+ getItem(id: number): Word.ContentControl;
85271
85061
  /**
85272
85062
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
85273
85063
  *
@@ -86948,26 +86738,7 @@ declare namespace Word {
86948
86738
  *
86949
86739
  * @param rangeLocation Optional. The range location must be 'Whole', 'Start', or 'End'.
86950
86740
  */
86951
- getRange(rangeLocation?: Word.RangeLocation): Word.Range;
86952
- /**
86953
- * Gets the picture, or the starting or ending point of the picture, as a range.
86954
- *
86955
- * @remarks
86956
- * [Api set: WordApi 1.3]
86957
- *
86958
- * @param rangeLocation Optional. The range location must be 'Whole', 'Start', or 'End'.
86959
- */
86960
- getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
86961
- /**
86962
- * Inserts a break at the specified location in the main document.
86963
- *
86964
- * @remarks
86965
- * [Api set: WordApi 1.2]
86966
- *
86967
- * @param breakType Required. The break type to add.
86968
- * @param insertLocation Required. The value must be 'Before' or 'After'.
86969
- */
86970
- insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void;
86741
+ getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range;
86971
86742
  /**
86972
86743
  * Inserts a break at the specified location in the main document.
86973
86744
  *
@@ -86977,7 +86748,7 @@ declare namespace Word {
86977
86748
  * @param breakType Required. The break type to add.
86978
86749
  * @param insertLocation Required. The value must be 'Before' or 'After'.
86979
86750
  */
86980
- 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;
86981
86752
  /**
86982
86753
  * Wraps the inline picture with a rich text content control.
86983
86754
  *
@@ -86994,27 +86765,7 @@ declare namespace Word {
86994
86765
  * @param base64File Required. The base64 encoded content of a .docx file.
86995
86766
  * @param insertLocation Required. The value must be 'Before' or 'After'.
86996
86767
  */
86997
- insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range;
86998
- /**
86999
- * Inserts a document at the specified location.
87000
- *
87001
- * @remarks
87002
- * [Api set: WordApi 1.2]
87003
- *
87004
- * @param base64File Required. The base64 encoded content of a .docx file.
87005
- * @param insertLocation Required. The value must be 'Before' or 'After'.
87006
- */
87007
- insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
87008
- /**
87009
- * Inserts HTML at the specified location.
87010
- *
87011
- * @remarks
87012
- * [Api set: WordApi 1.2]
87013
- *
87014
- * @param html Required. The HTML to be inserted.
87015
- * @param insertLocation Required. The value must be 'Before' or 'After'.
87016
- */
87017
- insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range;
86768
+ insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;
87018
86769
  /**
87019
86770
  * Inserts HTML at the specified location.
87020
86771
  *
@@ -87024,7 +86775,7 @@ declare namespace Word {
87024
86775
  * @param html Required. The HTML to be inserted.
87025
86776
  * @param insertLocation Required. The value must be 'Before' or 'After'.
87026
86777
  */
87027
- insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
86778
+ insertHtml(html: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;
87028
86779
  /**
87029
86780
  * Inserts an inline picture at the specified location.
87030
86781
  *
@@ -87034,27 +86785,7 @@ declare namespace Word {
87034
86785
  * @param base64EncodedImage Required. The base64 encoded image to be inserted.
87035
86786
  * @param insertLocation Required. The value must be 'Replace', 'Before', or 'After'.
87036
86787
  */
87037
- insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture;
87038
- /**
87039
- * Inserts an inline picture at the specified location.
87040
- *
87041
- * @remarks
87042
- * [Api set: WordApi 1.2]
87043
- *
87044
- * @param base64EncodedImage Required. The base64 encoded image to be inserted.
87045
- * @param insertLocation Required. The value must be 'Replace', 'Before', or 'After'.
87046
- */
87047
- insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.InlinePicture;
87048
- /**
87049
- * Inserts OOXML at the specified location.
87050
- *
87051
- * @remarks
87052
- * [Api set: WordApi 1.2]
87053
- *
87054
- * @param ooxml Required. The OOXML to be inserted.
87055
- * @param insertLocation Required. The value must be 'Before' or 'After'.
87056
- */
87057
- 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;
87058
86789
  /**
87059
86790
  * Inserts OOXML at the specified location.
87060
86791
  *
@@ -87064,7 +86795,7 @@ declare namespace Word {
87064
86795
  * @param ooxml Required. The OOXML to be inserted.
87065
86796
  * @param insertLocation Required. The value must be 'Before' or 'After'.
87066
86797
  */
87067
- insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
86798
+ insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;
87068
86799
  /**
87069
86800
  * Inserts a paragraph at the specified location.
87070
86801
  *
@@ -87074,27 +86805,7 @@ declare namespace Word {
87074
86805
  * @param paragraphText Required. The paragraph text to be inserted.
87075
86806
  * @param insertLocation Required. The value must be 'Before' or 'After'.
87076
86807
  */
87077
- insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
87078
- /**
87079
- * Inserts a paragraph at the specified location.
87080
- *
87081
- * @remarks
87082
- * [Api set: WordApi 1.2]
87083
- *
87084
- * @param paragraphText Required. The paragraph text to be inserted.
87085
- * @param insertLocation Required. The value must be 'Before' or 'After'.
87086
- */
87087
- insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph;
87088
- /**
87089
- * Inserts text at the specified location.
87090
- *
87091
- * @remarks
87092
- * [Api set: WordApi 1.2]
87093
- *
87094
- * @param text Required. Text to be inserted.
87095
- * @param insertLocation Required. The value must be 'Before' or 'After'.
87096
- */
87097
- insertText(text: string, insertLocation: Word.InsertLocation): Word.Range;
86808
+ insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph;
87098
86809
  /**
87099
86810
  * Inserts text at the specified location.
87100
86811
  *
@@ -87104,7 +86815,7 @@ declare namespace Word {
87104
86815
  * @param text Required. Text to be inserted.
87105
86816
  * @param insertLocation Required. The value must be 'Before' or 'After'.
87106
86817
  */
87107
- 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;
87108
86819
  /**
87109
86820
  * Selects the inline picture. This causes Word to scroll to the selection.
87110
86821
  *
@@ -87299,17 +87010,7 @@ declare namespace Word {
87299
87010
  * @param paragraphText Required. The paragraph text to be inserted.
87300
87011
  * @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'.
87301
87012
  */
87302
- insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
87303
- /**
87304
- * Inserts a paragraph at the specified location.
87305
- *
87306
- * @remarks
87307
- * [Api set: WordApi 1.3]
87308
- *
87309
- * @param paragraphText Required. The paragraph text to be inserted.
87310
- * @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'.
87311
- */
87312
- 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;
87313
87014
  /**
87314
87015
  * Resets the font of the bullet, number, or picture at the specified level in the list.
87315
87016
  *
@@ -87498,14 +87199,14 @@ declare namespace Word {
87498
87199
  */
87499
87200
  getFirstOrNullObject(): Word.List;
87500
87201
  /**
87501
- * Gets a list object by its index in the collection.
87202
+ * Gets a list object by its ID.
87502
87203
  *
87503
87204
  * @remarks
87504
87205
  * [Api set: WordApi 1.3]
87505
87206
  *
87506
- * @param index A number that identifies the index location of a list object.
87207
+ * @param id The list's ID.
87507
87208
  */
87508
- getItem(index: number): Word.List;
87209
+ getItem(id: number): Word.List;
87509
87210
  /**
87510
87211
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
87511
87212
  *
@@ -88126,16 +87827,7 @@ declare namespace Word {
88126
87827
  *
88127
87828
  * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
88128
87829
  */
88129
- getRange(rangeLocation?: Word.RangeLocation): Word.Range;
88130
- /**
88131
- * Gets the whole paragraph, or the starting or ending point of the paragraph, as a range.
88132
- *
88133
- * @remarks
88134
- * [Api set: WordApi 1.3]
88135
- *
88136
- * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
88137
- */
88138
- 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;
88139
87831
  /**
88140
87832
  * Gets reviewed text based on ChangeTrackingVersion selection.
88141
87833
  *
@@ -88173,17 +87865,7 @@ declare namespace Word {
88173
87865
  * @param breakType Required. The break type to add to the document.
88174
87866
  * @param insertLocation Required. The value must be 'Before' or 'After'.
88175
87867
  */
88176
- insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void;
88177
- /**
88178
- * Inserts a break at the specified location in the main document.
88179
- *
88180
- * @remarks
88181
- * [Api set: WordApi 1.1]
88182
- *
88183
- * @param breakType Required. The break type to add to the document.
88184
- * @param insertLocation Required. The value must be 'Before' or 'After'.
88185
- */
88186
- 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;
88187
87869
  /**
88188
87870
  * Wraps the paragraph object with a rich text content control.
88189
87871
  *
@@ -88200,27 +87882,7 @@ declare namespace Word {
88200
87882
  * @param base64File Required. The base64 encoded content of a .docx file.
88201
87883
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
88202
87884
  */
88203
- insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range;
88204
- /**
88205
- * Inserts a document into the paragraph at the specified location.
88206
- *
88207
- * @remarks
88208
- * [Api set: WordApi 1.1]
88209
- *
88210
- * @param base64File Required. The base64 encoded content of a .docx file.
88211
- * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
88212
- */
88213
- insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
88214
- /**
88215
- * Inserts HTML into the paragraph at the specified location.
88216
- *
88217
- * @remarks
88218
- * [Api set: WordApi 1.1]
88219
- *
88220
- * @param html Required. The HTML to be inserted in the paragraph.
88221
- * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
88222
- */
88223
- insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range;
87885
+ insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
88224
87886
  /**
88225
87887
  * Inserts HTML into the paragraph at the specified location.
88226
87888
  *
@@ -88230,17 +87892,7 @@ declare namespace Word {
88230
87892
  * @param html Required. The HTML to be inserted in the paragraph.
88231
87893
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
88232
87894
  */
88233
- insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
88234
- /**
88235
- * Inserts a picture into the paragraph at the specified location.
88236
- *
88237
- * @remarks
88238
- * [Api set: WordApi 1.1]
88239
- *
88240
- * @param base64EncodedImage Required. The base64 encoded image to be inserted.
88241
- * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
88242
- */
88243
- 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;
88244
87896
  /**
88245
87897
  * Inserts a picture into the paragraph at the specified location.
88246
87898
  *
@@ -88250,17 +87902,7 @@ declare namespace Word {
88250
87902
  * @param base64EncodedImage Required. The base64 encoded image to be inserted.
88251
87903
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
88252
87904
  */
88253
- insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.InlinePicture;
88254
- /**
88255
- * Inserts OOXML into the paragraph at the specified location.
88256
- *
88257
- * @remarks
88258
- * [Api set: WordApi 1.1]
88259
- *
88260
- * @param ooxml Required. The OOXML to be inserted in the paragraph.
88261
- * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
88262
- */
88263
- insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range;
87905
+ insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.InlinePicture;
88264
87906
  /**
88265
87907
  * Inserts OOXML into the paragraph at the specified location.
88266
87908
  *
@@ -88270,7 +87912,7 @@ declare namespace Word {
88270
87912
  * @param ooxml Required. The OOXML to be inserted in the paragraph.
88271
87913
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
88272
87914
  */
88273
- 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;
88274
87916
  /**
88275
87917
  * Inserts a paragraph at the specified location.
88276
87918
  *
@@ -88280,29 +87922,7 @@ declare namespace Word {
88280
87922
  * @param paragraphText Required. The paragraph text to be inserted.
88281
87923
  * @param insertLocation Required. The value must be 'Before' or 'After'.
88282
87924
  */
88283
- insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
88284
- /**
88285
- * Inserts a paragraph at the specified location.
88286
- *
88287
- * @remarks
88288
- * [Api set: WordApi 1.1]
88289
- *
88290
- * @param paragraphText Required. The paragraph text to be inserted.
88291
- * @param insertLocation Required. The value must be 'Before' or 'After'.
88292
- */
88293
- insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph;
88294
- /**
88295
- * Inserts a table with the specified number of rows and columns.
88296
- *
88297
- * @remarks
88298
- * [Api set: WordApi 1.3]
88299
- *
88300
- * @param rowCount Required. The number of rows in the table.
88301
- * @param columnCount Required. The number of columns in the table.
88302
- * @param insertLocation Required. The value must be 'Before' or 'After'.
88303
- * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
88304
- */
88305
- insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table;
87925
+ insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph;
88306
87926
  /**
88307
87927
  * Inserts a table with the specified number of rows and columns.
88308
87928
  *
@@ -88314,17 +87934,7 @@ declare namespace Word {
88314
87934
  * @param insertLocation Required. The value must be 'Before' or 'After'.
88315
87935
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
88316
87936
  */
88317
- insertTable(rowCount: number, columnCount: number, insertLocation: "Before" | "After" | "Start" | "End" | "Replace", values?: string[][]): Word.Table;
88318
- /**
88319
- * Inserts text into the paragraph at the specified location.
88320
- *
88321
- * @remarks
88322
- * [Api set: WordApi 1.1]
88323
- *
88324
- * @param text Required. Text to be inserted.
88325
- * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
88326
- */
88327
- insertText(text: string, insertLocation: Word.InsertLocation): Word.Range;
87937
+ insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table;
88328
87938
  /**
88329
87939
  * Inserts text into the paragraph at the specified location.
88330
87940
  *
@@ -88334,7 +87944,7 @@ declare namespace Word {
88334
87944
  * @param text Required. Text to be inserted.
88335
87945
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
88336
87946
  */
88337
- 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;
88338
87948
  /**
88339
87949
  * Performs a search with the specified SearchOptions on the scope of the paragraph object. The search results are a collection of range objects.
88340
87950
  *
@@ -88769,16 +88379,7 @@ declare namespace Word {
88769
88379
  *
88770
88380
  * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
88771
88381
  */
88772
- getRange(rangeLocation?: Word.RangeLocation): Word.Range;
88773
- /**
88774
- * Clones the range, or gets the starting or ending point of the range as a new range.
88775
- *
88776
- * @remarks
88777
- * [Api set: WordApi 1.3]
88778
- *
88779
- * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
88780
- */
88781
- 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;
88782
88383
  /**
88783
88384
  * Gets reviewed text based on ChangeTrackingVersion selection.
88784
88385
  *
@@ -88826,17 +88427,7 @@ declare namespace Word {
88826
88427
  * @param breakType Required. The break type to add.
88827
88428
  * @param insertLocation Required. The value must be 'Before' or 'After'.
88828
88429
  */
88829
- insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void;
88830
- /**
88831
- * Inserts a break at the specified location in the main document.
88832
- *
88833
- * @remarks
88834
- * [Api set: WordApi 1.1]
88835
- *
88836
- * @param breakType Required. The break type to add.
88837
- * @param insertLocation Required. The value must be 'Before' or 'After'.
88838
- */
88839
- 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;
88840
88431
  /**
88841
88432
  * Insert a comment on the range.
88842
88433
  *
@@ -88872,17 +88463,7 @@ declare namespace Word {
88872
88463
  * @param base64File Required. The base64 encoded content of a .docx file.
88873
88464
  * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
88874
88465
  */
88875
- insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range;
88876
- /**
88877
- * Inserts a document at the specified location.
88878
- *
88879
- * @remarks
88880
- * [Api set: WordApi 1.1]
88881
- *
88882
- * @param base64File Required. The base64 encoded content of a .docx file.
88883
- * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
88884
- */
88885
- 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;
88886
88467
  /**
88887
88468
  * Inserts a footnote. The footnote reference is placed after the range.
88888
88469
  *
@@ -88901,27 +88482,7 @@ declare namespace Word {
88901
88482
  * @param html Required. The HTML to be inserted.
88902
88483
  * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
88903
88484
  */
88904
- insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range;
88905
- /**
88906
- * Inserts HTML at the specified location.
88907
- *
88908
- * @remarks
88909
- * [Api set: WordApi 1.1]
88910
- *
88911
- * @param html Required. The HTML to be inserted.
88912
- * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
88913
- */
88914
- insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
88915
- /**
88916
- * Inserts a picture at the specified location.
88917
- *
88918
- * @remarks
88919
- * [Api set: WordApi 1.2]
88920
- *
88921
- * @param base64EncodedImage Required. The base64 encoded image to be inserted.
88922
- * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
88923
- */
88924
- insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture;
88485
+ insertHtml(html: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;
88925
88486
  /**
88926
88487
  * Inserts a picture at the specified location.
88927
88488
  *
@@ -88931,17 +88492,7 @@ declare namespace Word {
88931
88492
  * @param base64EncodedImage Required. The base64 encoded image to be inserted.
88932
88493
  * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
88933
88494
  */
88934
- insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.InlinePicture;
88935
- /**
88936
- * Inserts OOXML at the specified location.
88937
- *
88938
- * @remarks
88939
- * [Api set: WordApi 1.1]
88940
- *
88941
- * @param ooxml Required. The OOXML to be inserted.
88942
- * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
88943
- */
88944
- insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range;
88495
+ insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.InlinePicture;
88945
88496
  /**
88946
88497
  * Inserts OOXML at the specified location.
88947
88498
  *
@@ -88951,17 +88502,7 @@ declare namespace Word {
88951
88502
  * @param ooxml Required. The OOXML to be inserted.
88952
88503
  * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
88953
88504
  */
88954
- insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
88955
- /**
88956
- * Inserts a paragraph at the specified location.
88957
- *
88958
- * @remarks
88959
- * [Api set: WordApi 1.1]
88960
- *
88961
- * @param paragraphText Required. The paragraph text to be inserted.
88962
- * @param insertLocation Required. The value must be 'Before' or 'After'.
88963
- */
88964
- insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
88505
+ insertOoxml(ooxml: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;
88965
88506
  /**
88966
88507
  * Inserts a paragraph at the specified location.
88967
88508
  *
@@ -88971,7 +88512,7 @@ declare namespace Word {
88971
88512
  * @param paragraphText Required. The paragraph text to be inserted.
88972
88513
  * @param insertLocation Required. The value must be 'Before' or 'After'.
88973
88514
  */
88974
- insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph;
88515
+ insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph;
88975
88516
  /**
88976
88517
  * Inserts a table with the specified number of rows and columns.
88977
88518
  *
@@ -88983,29 +88524,7 @@ declare namespace Word {
88983
88524
  * @param insertLocation Required. The value must be 'Before' or 'After'.
88984
88525
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
88985
88526
  */
88986
- insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table;
88987
- /**
88988
- * Inserts a table with the specified number of rows and columns.
88989
- *
88990
- * @remarks
88991
- * [Api set: WordApi 1.3]
88992
- *
88993
- * @param rowCount Required. The number of rows in the table.
88994
- * @param columnCount Required. The number of columns in the table.
88995
- * @param insertLocation Required. The value must be 'Before' or 'After'.
88996
- * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
88997
- */
88998
- insertTable(rowCount: number, columnCount: number, insertLocation: "Before" | "After" | "Start" | "End" | "Replace", values?: string[][]): Word.Table;
88999
- /**
89000
- * Inserts text at the specified location.
89001
- *
89002
- * @remarks
89003
- * [Api set: WordApi 1.1]
89004
- *
89005
- * @param text Required. Text to be inserted.
89006
- * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
89007
- */
89008
- 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;
89009
88528
  /**
89010
88529
  * Inserts text at the specified location.
89011
88530
  *
@@ -89015,7 +88534,7 @@ declare namespace Word {
89015
88534
  * @param text Required. Text to be inserted.
89016
88535
  * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
89017
88536
  */
89018
- insertText(text: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
88537
+ insertText(text: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;
89019
88538
  /**
89020
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.
89021
88540
  *
@@ -89845,29 +89364,7 @@ declare namespace Word {
89845
89364
  * @param columnCount Required. Number of columns to add.
89846
89365
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
89847
89366
  */
89848
- addColumns(insertLocation: Word.InsertLocation, columnCount: number, values?: string[][]): void;
89849
- /**
89850
- * 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.
89851
- *
89852
- * @remarks
89853
- * [Api set: WordApi 1.3]
89854
- *
89855
- * @param insertLocation Required. It must be 'Start' or 'End', corresponding to the appropriate side of the table.
89856
- * @param columnCount Required. Number of columns to add.
89857
- * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
89858
- */
89859
- addColumns(insertLocation: "Before" | "After" | "Start" | "End" | "Replace", columnCount: number, values?: string[][]): void;
89860
- /**
89861
- * 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.
89862
- *
89863
- * @remarks
89864
- * [Api set: WordApi 1.3]
89865
- *
89866
- * @param insertLocation Required. It must be 'Start' or 'End'.
89867
- * @param rowCount Required. Number of rows to add.
89868
- * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
89869
- */
89870
- 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;
89871
89368
  /**
89872
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.
89873
89370
  *
@@ -89878,7 +89375,7 @@ declare namespace Word {
89878
89375
  * @param rowCount Required. Number of rows to add.
89879
89376
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
89880
89377
  */
89881
- addRows(insertLocation: "Before" | "After" | "Start" | "End" | "Replace", rowCount: number, values?: string[][]): Word.TableRowCollection;
89378
+ addRows(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", rowCount: number, values?: string[][]): Word.TableRowCollection;
89882
89379
  /**
89883
89380
  * Autofits the table columns to the width of the window.
89884
89381
  *
@@ -90033,16 +89530,7 @@ declare namespace Word {
90033
89530
  *
90034
89531
  * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', or 'After'.
90035
89532
  */
90036
- getRange(rangeLocation?: Word.RangeLocation): Word.Range;
90037
- /**
90038
- * Gets the range that contains this table, or the range at the start or end of the table.
90039
- *
90040
- * @remarks
90041
- * [Api set: WordApi 1.3]
90042
- *
90043
- * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', or 'After'.
90044
- */
90045
- 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;
90046
89534
  /**
90047
89535
  * Inserts a content control on the table.
90048
89536
  *
@@ -90059,17 +89547,7 @@ declare namespace Word {
90059
89547
  * @param paragraphText Required. The paragraph text to be inserted.
90060
89548
  * @param insertLocation Required. The value must be 'Before' or 'After'.
90061
89549
  */
90062
- insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
90063
- /**
90064
- * Inserts a paragraph at the specified location.
90065
- *
90066
- * @remarks
90067
- * [Api set: WordApi 1.3]
90068
- *
90069
- * @param paragraphText Required. The paragraph text to be inserted.
90070
- * @param insertLocation Required. The value must be 'Before' or 'After'.
90071
- */
90072
- 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;
90073
89551
  /**
90074
89552
  * Inserts a table with the specified number of rows and columns.
90075
89553
  *
@@ -90081,19 +89559,7 @@ declare namespace Word {
90081
89559
  * @param insertLocation Required. The value must be 'Before' or 'After'.
90082
89560
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
90083
89561
  */
90084
- insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table;
90085
- /**
90086
- * Inserts a table with the specified number of rows and columns.
90087
- *
90088
- * @remarks
90089
- * [Api set: WordApi 1.3]
90090
- *
90091
- * @param rowCount Required. The number of rows in the table.
90092
- * @param columnCount Required. The number of columns in the table.
90093
- * @param insertLocation Required. The value must be 'Before' or 'After'.
90094
- * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
90095
- */
90096
- 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;
90097
89563
  /**
90098
89564
  * Merges the cells bounded inclusively by a first and last cell.
90099
89565
  *
@@ -90453,18 +89919,7 @@ declare namespace Word {
90453
89919
  * @param rowCount Required. Number of rows to add
90454
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.
90455
89921
  */
90456
- insertRows(insertLocation: Word.InsertLocation, rowCount: number, values?: string[][]): Word.TableRowCollection;
90457
- /**
90458
- * Inserts rows using this row as a template. If values are specified, inserts the values into the new rows.
90459
- *
90460
- * @remarks
90461
- * [Api set: WordApi 1.3]
90462
- *
90463
- * @param insertLocation Required. Where the new rows should be inserted, relative to the current row. It must be 'Before' or 'After'.
90464
- * @param rowCount Required. Number of rows to add
90465
- * @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.
90466
- */
90467
- 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;
90468
89923
  /**
90469
89924
  * Merges the row into one cell.
90470
89925
  *
@@ -90789,29 +90244,7 @@ declare namespace Word {
90789
90244
  * @param columnCount Required. Number of columns to add.
90790
90245
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
90791
90246
  */
90792
- insertColumns(insertLocation: Word.InsertLocation, columnCount: number, values?: string[][]): void;
90793
- /**
90794
- * 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.
90795
- *
90796
- * @remarks
90797
- * [Api set: WordApi 1.3]
90798
- *
90799
- * @param insertLocation Required. It must be 'Before' or 'After'.
90800
- * @param columnCount Required. Number of columns to add.
90801
- * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
90802
- */
90803
- insertColumns(insertLocation: "Before" | "After" | "Start" | "End" | "Replace", columnCount: number, values?: string[][]): void;
90804
- /**
90805
- * 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.
90806
- *
90807
- * @remarks
90808
- * [Api set: WordApi 1.3]
90809
- *
90810
- * @param insertLocation Required. It must be 'Before' or 'After'.
90811
- * @param rowCount Required. Number of rows to add.
90812
- * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
90813
- */
90814
- 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;
90815
90248
  /**
90816
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.
90817
90250
  *
@@ -90822,7 +90255,7 @@ declare namespace Word {
90822
90255
  * @param rowCount Required. Number of rows to add.
90823
90256
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
90824
90257
  */
90825
- insertRows(insertLocation: "Before" | "After" | "Start" | "End" | "Replace", rowCount: number, values?: string[][]): Word.TableRowCollection;
90258
+ insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection;
90826
90259
  /**
90827
90260
  * Sets cell padding in points.
90828
90261
  *
@@ -91240,7 +90673,7 @@ declare namespace Word {
91240
90673
  plainText = "PlainText",
91241
90674
  }
91242
90675
  /**
91243
- * ContentControl appearance
90676
+ * ContentControl appearance.
91244
90677
  *
91245
90678
  * @remarks
91246
90679
  * [Api set: WordApi 1.1]
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js-preview",
3
- "version": "1.0.331",
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": "70d011d63461712003d9ef8b6dc17144de655cab40981c06f84e050214a1b5ba",
48
+ "typesPublisherContentHash": "29267df73c9abe3630aeb248a6956997cb0fdc27cd0f7fab6e2535a35790b3e5",
49
49
  "typeScriptVersion": "4.1"
50
50
  }