@types/office-js 1.0.278 → 1.0.279

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
office-js/README.md CHANGED
@@ -8,7 +8,7 @@ This package contains type definitions for Office.js (https://github.com/OfficeD
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Mon, 12 Sep 2022 21:02:42 GMT
11
+ * Last updated: Tue, 13 Sep 2022 18:26:26 GMT
12
12
  * Dependencies: none
13
13
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
14
14
 
office-js/index.d.ts CHANGED
@@ -75698,16 +75698,7 @@ declare namespace Word {
75698
75698
  *
75699
75699
  * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
75700
75700
  */
75701
- getRange(rangeLocation?: Word.RangeLocation): Word.Range;
75702
- /**
75703
- * Gets the whole body, or the starting or ending point of the body, as a range.
75704
- *
75705
- * @remarks
75706
- * [Api set: WordApi 1.3]
75707
- *
75708
- * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
75709
- */
75710
- getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
75701
+ getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | Word.RangeLocation.content | "Whole" | "Start" | "End" | "After" | "Content"): Word.Range;
75711
75702
  /**
75712
75703
  * Gets reviewed text based on ChangeTrackingVersion selection.
75713
75704
  *
@@ -75735,17 +75726,7 @@ declare namespace Word {
75735
75726
  * @param breakType Required. The break type to add to the body.
75736
75727
  * @param insertLocation Required. The value must be 'Start' or 'End'.
75737
75728
  */
75738
- insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void;
75739
- /**
75740
- * Inserts a break at the specified location in the main document.
75741
- *
75742
- * @remarks
75743
- * [Api set: WordApi 1.1]
75744
- *
75745
- * @param breakType Required. The break type to add to the body.
75746
- * @param insertLocation Required. The value must be 'Start' or 'End'.
75747
- */
75748
- insertBreak(breakType: "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): void;
75729
+ insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End"): void;
75749
75730
  /**
75750
75731
  * Wraps the body object with a Rich Text content control.
75751
75732
  *
@@ -75762,27 +75743,7 @@ declare namespace Word {
75762
75743
  * @param base64File Required. The base64 encoded content of a .docx file.
75763
75744
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
75764
75745
  */
75765
- insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range;
75766
- /**
75767
- * Inserts a document into the body at the specified location.
75768
- *
75769
- * @remarks
75770
- * [Api set: WordApi 1.1]
75771
- *
75772
- * @param base64File Required. The base64 encoded content of a .docx file.
75773
- * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
75774
- */
75775
- insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
75776
- /**
75777
- * Inserts HTML at the specified location.
75778
- *
75779
- * @remarks
75780
- * [Api set: WordApi 1.1]
75781
- *
75782
- * @param html Required. The HTML to be inserted in the document.
75783
- * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
75784
- */
75785
- insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range;
75746
+ insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
75786
75747
  /**
75787
75748
  * Inserts HTML at the specified location.
75788
75749
  *
@@ -75792,17 +75753,7 @@ declare namespace Word {
75792
75753
  * @param html Required. The HTML to be inserted in the document.
75793
75754
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
75794
75755
  */
75795
- insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
75796
- /**
75797
- * Inserts a picture into the body at the specified location.
75798
- *
75799
- * @remarks
75800
- * [Api set: WordApi 1.2]
75801
- *
75802
- * @param base64EncodedImage Required. The base64 encoded image to be inserted in the body.
75803
- * @param insertLocation Required. The value must be 'Start' or 'End'.
75804
- */
75805
- insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture;
75756
+ insertHtml(html: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
75806
75757
  /**
75807
75758
  * Inserts a picture into the body at the specified location.
75808
75759
  *
@@ -75812,17 +75763,7 @@ declare namespace Word {
75812
75763
  * @param base64EncodedImage Required. The base64 encoded image to be inserted in the body.
75813
75764
  * @param insertLocation Required. The value must be 'Start' or 'End'.
75814
75765
  */
75815
- insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.InlinePicture;
75816
- /**
75817
- * Inserts OOXML at the specified location.
75818
- *
75819
- * @remarks
75820
- * [Api set: WordApi 1.1]
75821
- *
75822
- * @param ooxml Required. The OOXML to be inserted.
75823
- * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
75824
- */
75825
- insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range;
75766
+ insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End"): Word.InlinePicture;
75826
75767
  /**
75827
75768
  * Inserts OOXML at the specified location.
75828
75769
  *
@@ -75832,17 +75773,7 @@ declare namespace Word {
75832
75773
  * @param ooxml Required. The OOXML to be inserted.
75833
75774
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
75834
75775
  */
75835
- insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
75836
- /**
75837
- * Inserts a paragraph at the specified location.
75838
- *
75839
- * @remarks
75840
- * [Api set: WordApi 1.1]
75841
- *
75842
- * @param paragraphText Required. The paragraph text to be inserted.
75843
- * @param insertLocation Required. The value must be 'Start' or 'End'.
75844
- */
75845
- insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
75776
+ insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
75846
75777
  /**
75847
75778
  * Inserts a paragraph at the specified location.
75848
75779
  *
@@ -75852,7 +75783,7 @@ declare namespace Word {
75852
75783
  * @param paragraphText Required. The paragraph text to be inserted.
75853
75784
  * @param insertLocation Required. The value must be 'Start' or 'End'.
75854
75785
  */
75855
- insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph;
75786
+ insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End"): Word.Paragraph;
75856
75787
  /**
75857
75788
  * Inserts a table with the specified number of rows and columns.
75858
75789
  *
@@ -75864,29 +75795,7 @@ declare namespace Word {
75864
75795
  * @param insertLocation Required. The value must be 'Start' or 'End'.
75865
75796
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
75866
75797
  */
75867
- insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table;
75868
- /**
75869
- * Inserts a table with the specified number of rows and columns.
75870
- *
75871
- * @remarks
75872
- * [Api set: WordApi 1.3]
75873
- *
75874
- * @param rowCount Required. The number of rows in the table.
75875
- * @param columnCount Required. The number of columns in the table.
75876
- * @param insertLocation Required. The value must be 'Start' or 'End'.
75877
- * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
75878
- */
75879
- insertTable(rowCount: number, columnCount: number, insertLocation: "Before" | "After" | "Start" | "End" | "Replace", values?: string[][]): Word.Table;
75880
- /**
75881
- * Inserts text into the body at the specified location.
75882
- *
75883
- * @remarks
75884
- * [Api set: WordApi 1.1]
75885
- *
75886
- * @param text Required. Text to be inserted.
75887
- * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
75888
- */
75889
- insertText(text: string, insertLocation: Word.InsertLocation): Word.Range;
75798
+ insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", values?: string[][]): Word.Table;
75890
75799
  /**
75891
75800
  * Inserts text into the body at the specified location.
75892
75801
  *
@@ -75896,7 +75805,7 @@ declare namespace Word {
75896
75805
  * @param text Required. Text to be inserted.
75897
75806
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
75898
75807
  */
75899
- insertText(text: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
75808
+ insertText(text: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
75900
75809
  /**
75901
75810
  * Performs a search with the specified SearchOptions on the scope of the body object. The search results are a collection of range objects.
75902
75811
  *
@@ -76124,15 +76033,6 @@ declare namespace Word {
76124
76033
  * [Api set: WordApiOnline 1.1]
76125
76034
  */
76126
76035
  getFirstOrNullObject(): Word.Comment;
76127
- /**
76128
- * Gets a comment object by its index in the collection.
76129
- *
76130
- * @remarks
76131
- * [Api set: WordApiOnline 1.1]
76132
- *
76133
- * @param index A number that identifies the index location of a comment object.
76134
- */
76135
- getItem(index: number): Word.Comment;
76136
76036
  /**
76137
76037
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
76138
76038
  *
@@ -76236,19 +76136,9 @@ declare namespace Word {
76236
76136
  * [Api set: WordApiOnline 1.1]
76237
76137
  *
76238
76138
  * @param text Required. The text to be inserted in to the CommentContentRange.
76239
- * @param insertLocation Required. The value must be 'After', 'Before', 'Replace', 'Start', or 'End'.
76240
- */
76241
- insertText(text: string, insertLocation: Word.InsertLocation): Word.CommentContentRange;
76242
- /**
76243
- * 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.
76244
- *
76245
- * @remarks
76246
- * [Api set: WordApiOnline 1.1]
76247
- *
76248
- * @param text Required. The text to be inserted in to the CommentContentRange.
76249
- * @param insertLocation Required. The value must be 'After', 'Before', 'Replace', 'Start', or 'End'.
76139
+ * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
76250
76140
  */
76251
- insertText(text: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.CommentContentRange;
76141
+ insertText(text: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.CommentContentRange;
76252
76142
  /**
76253
76143
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
76254
76144
  *
@@ -76417,15 +76307,6 @@ declare namespace Word {
76417
76307
  * [Api set: WordApiOnline 1.1]
76418
76308
  */
76419
76309
  getFirstOrNullObject(): Word.CommentReply;
76420
- /**
76421
- * Gets a comment reply object by its index in the collection.
76422
- *
76423
- * @remarks
76424
- * [Api set: WordApiOnline 1.1]
76425
- *
76426
- * @param index A number that identifies the index location of a comment reply object.
76427
- */
76428
- getItem(index: number): Word.CommentReply;
76429
76310
  /**
76430
76311
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
76431
76312
  *
@@ -76722,18 +76603,9 @@ declare namespace Word {
76722
76603
  * @remarks
76723
76604
  * [Api set: WordApi 1.3]
76724
76605
  *
76725
- * @param rangeLocation Optional. The range location must be 'Whole', 'Before', 'Start', 'End', 'After', or 'Content'.
76726
- */
76727
- getRange(rangeLocation?: Word.RangeLocation): Word.Range;
76728
- /**
76729
- * Gets the whole content control, or the starting or ending point of the content control, as a range.
76730
- *
76731
- * @remarks
76732
- * [Api set: WordApi 1.3]
76733
- *
76734
- * @param rangeLocation Optional. The range location must be 'Whole', 'Before', 'Start', 'End', 'After', or 'Content'.
76606
+ * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'Before', 'After', or 'Content'.
76735
76607
  */
76736
- getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
76608
+ getRange(rangeLocation?: Word.RangeLocation | "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
76737
76609
  /**
76738
76610
  * Gets reviewed text based on ChangeTrackingVersion selection.
76739
76611
  *
@@ -76771,17 +76643,7 @@ declare namespace Word {
76771
76643
  * @param breakType Required. Type of break.
76772
76644
  * @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'.
76773
76645
  */
76774
- insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void;
76775
- /**
76776
- * Inserts a break at the specified location in the main document. This method cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls.
76777
- *
76778
- * @remarks
76779
- * [Api set: WordApi 1.1]
76780
- *
76781
- * @param breakType Required. Type of break.
76782
- * @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'.
76783
- */
76784
- insertBreak(breakType: "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): void;
76646
+ 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;
76785
76647
  /**
76786
76648
  * Inserts a document into the content control at the specified location.
76787
76649
  *
@@ -76791,27 +76653,7 @@ declare namespace Word {
76791
76653
  * @param base64File Required. The base64 encoded content of a .docx file.
76792
76654
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
76793
76655
  */
76794
- insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range;
76795
- /**
76796
- * Inserts a document into the content control at the specified location.
76797
- *
76798
- * @remarks
76799
- * [Api set: WordApi 1.1]
76800
- *
76801
- * @param base64File Required. The base64 encoded content of a .docx file.
76802
- * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
76803
- */
76804
- insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
76805
- /**
76806
- * Inserts HTML into the content control at the specified location.
76807
- *
76808
- * @remarks
76809
- * [Api set: WordApi 1.1]
76810
- *
76811
- * @param html Required. The HTML to be inserted in to the content control.
76812
- * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
76813
- */
76814
- insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range;
76656
+ insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
76815
76657
  /**
76816
76658
  * Inserts HTML into the content control at the specified location.
76817
76659
  *
@@ -76821,17 +76663,7 @@ declare namespace Word {
76821
76663
  * @param html Required. The HTML to be inserted in to the content control.
76822
76664
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
76823
76665
  */
76824
- insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
76825
- /**
76826
- * Inserts an inline picture into the content control at the specified location.
76827
- *
76828
- * @remarks
76829
- * [Api set: WordApi 1.2]
76830
- *
76831
- * @param base64EncodedImage Required. The base64 encoded image to be inserted in the content control.
76832
- * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
76833
- */
76834
- insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture;
76666
+ insertHtml(html: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
76835
76667
  /**
76836
76668
  * Inserts an inline picture into the content control at the specified location.
76837
76669
  *
@@ -76841,17 +76673,7 @@ declare namespace Word {
76841
76673
  * @param base64EncodedImage Required. The base64 encoded image to be inserted in the content control.
76842
76674
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
76843
76675
  */
76844
- insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.InlinePicture;
76845
- /**
76846
- * Inserts OOXML into the content control at the specified location.
76847
- *
76848
- * @remarks
76849
- * [Api set: WordApi 1.1]
76850
- *
76851
- * @param ooxml Required. The OOXML to be inserted in to the content control.
76852
- * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
76853
- */
76854
- insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range;
76676
+ insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.InlinePicture;
76855
76677
  /**
76856
76678
  * Inserts OOXML into the content control at the specified location.
76857
76679
  *
@@ -76861,7 +76683,7 @@ declare namespace Word {
76861
76683
  * @param ooxml Required. The OOXML to be inserted in to the content control.
76862
76684
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
76863
76685
  */
76864
- insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
76686
+ insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
76865
76687
  /**
76866
76688
  * Inserts a paragraph at the specified location.
76867
76689
  *
@@ -76871,29 +76693,7 @@ declare namespace Word {
76871
76693
  * @param paragraphText Required. The paragraph text to be inserted.
76872
76694
  * @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.
76873
76695
  */
76874
- insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
76875
- /**
76876
- * Inserts a paragraph at the specified location.
76877
- *
76878
- * @remarks
76879
- * [Api set: WordApi 1.1]
76880
- *
76881
- * @param paragraphText Required. The paragraph text to be inserted.
76882
- * @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.
76883
- */
76884
- insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph;
76885
- /**
76886
- * Inserts a table with the specified number of rows and columns into, or next to, a content control.
76887
- *
76888
- * @remarks
76889
- * [Api set: WordApi 1.3]
76890
- *
76891
- * @param rowCount Required. The number of rows in the table.
76892
- * @param columnCount Required. The number of columns in the table.
76893
- * @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.
76894
- * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
76895
- */
76896
- insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table;
76696
+ insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After"): Word.Paragraph;
76897
76697
  /**
76898
76698
  * Inserts a table with the specified number of rows and columns into, or next to, a content control.
76899
76699
  *
@@ -76905,7 +76705,7 @@ declare namespace Word {
76905
76705
  * @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.
76906
76706
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
76907
76707
  */
76908
- insertTable(rowCount: number, columnCount: number, insertLocation: "Before" | "After" | "Start" | "End" | "Replace", values?: string[][]): Word.Table;
76708
+ 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;
76909
76709
  /**
76910
76710
  * Inserts text into the content control at the specified location.
76911
76711
  *
@@ -76915,17 +76715,7 @@ declare namespace Word {
76915
76715
  * @param text Required. The text to be inserted in to the content control.
76916
76716
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
76917
76717
  */
76918
- insertText(text: string, insertLocation: Word.InsertLocation): Word.Range;
76919
- /**
76920
- * Inserts text into the content control at the specified location.
76921
- *
76922
- * @remarks
76923
- * [Api set: WordApi 1.1]
76924
- *
76925
- * @param text Required. The text to be inserted in to the content control.
76926
- * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
76927
- */
76928
- insertText(text: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
76718
+ insertText(text: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
76929
76719
  /**
76930
76720
  * Performs a search with the specified SearchOptions on the scope of the content control object. The search results are a collection of range objects.
76931
76721
  *
@@ -77080,14 +76870,14 @@ declare namespace Word {
77080
76870
  */
77081
76871
  getFirstOrNullObject(): Word.ContentControl;
77082
76872
  /**
77083
- * Gets a content control by its index in the collection.
76873
+ * Gets a content control by its ID.
77084
76874
  *
77085
76875
  * @remarks
77086
76876
  * [Api set: WordApi 1.1]
77087
76877
  *
77088
- * @param index The index.
76878
+ * @param id The content control's ID.
77089
76879
  */
77090
- getItem(index: number): Word.ContentControl;
76880
+ getItem(id: number): Word.ContentControl;
77091
76881
  /**
77092
76882
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
77093
76883
  *
@@ -77977,26 +77767,7 @@ declare namespace Word {
77977
77767
  *
77978
77768
  * @param rangeLocation Optional. The range location must be 'Whole', 'Start', or 'End'.
77979
77769
  */
77980
- getRange(rangeLocation?: Word.RangeLocation): Word.Range;
77981
- /**
77982
- * Gets the picture, or the starting or ending point of the picture, as a range.
77983
- *
77984
- * @remarks
77985
- * [Api set: WordApi 1.3]
77986
- *
77987
- * @param rangeLocation Optional. The range location must be 'Whole', 'Start', or 'End'.
77988
- */
77989
- getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
77990
- /**
77991
- * Inserts a break at the specified location in the main document.
77992
- *
77993
- * @remarks
77994
- * [Api set: WordApi 1.2]
77995
- *
77996
- * @param breakType Required. The break type to add.
77997
- * @param insertLocation Required. The value must be 'Before' or 'After'.
77998
- */
77999
- insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void;
77770
+ getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range;
78000
77771
  /**
78001
77772
  * Inserts a break at the specified location in the main document.
78002
77773
  *
@@ -78006,7 +77777,7 @@ declare namespace Word {
78006
77777
  * @param breakType Required. The break type to add.
78007
77778
  * @param insertLocation Required. The value must be 'Before' or 'After'.
78008
77779
  */
78009
- insertBreak(breakType: "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): void;
77780
+ insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void;
78010
77781
  /**
78011
77782
  * Wraps the inline picture with a rich text content control.
78012
77783
  *
@@ -78023,27 +77794,7 @@ declare namespace Word {
78023
77794
  * @param base64File Required. The base64 encoded content of a .docx file.
78024
77795
  * @param insertLocation Required. The value must be 'Before' or 'After'.
78025
77796
  */
78026
- insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range;
78027
- /**
78028
- * Inserts a document at the specified location.
78029
- *
78030
- * @remarks
78031
- * [Api set: WordApi 1.2]
78032
- *
78033
- * @param base64File Required. The base64 encoded content of a .docx file.
78034
- * @param insertLocation Required. The value must be 'Before' or 'After'.
78035
- */
78036
- insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
78037
- /**
78038
- * Inserts HTML at the specified location.
78039
- *
78040
- * @remarks
78041
- * [Api set: WordApi 1.2]
78042
- *
78043
- * @param html Required. The HTML to be inserted.
78044
- * @param insertLocation Required. The value must be 'Before' or 'After'.
78045
- */
78046
- insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range;
77797
+ insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;
78047
77798
  /**
78048
77799
  * Inserts HTML at the specified location.
78049
77800
  *
@@ -78053,7 +77804,7 @@ declare namespace Word {
78053
77804
  * @param html Required. The HTML to be inserted.
78054
77805
  * @param insertLocation Required. The value must be 'Before' or 'After'.
78055
77806
  */
78056
- insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
77807
+ insertHtml(html: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;
78057
77808
  /**
78058
77809
  * Inserts an inline picture at the specified location.
78059
77810
  *
@@ -78063,27 +77814,7 @@ declare namespace Word {
78063
77814
  * @param base64EncodedImage Required. The base64 encoded image to be inserted.
78064
77815
  * @param insertLocation Required. The value must be 'Replace', 'Before', or 'After'.
78065
77816
  */
78066
- insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture;
78067
- /**
78068
- * Inserts an inline picture at the specified location.
78069
- *
78070
- * @remarks
78071
- * [Api set: WordApi 1.2]
78072
- *
78073
- * @param base64EncodedImage Required. The base64 encoded image to be inserted.
78074
- * @param insertLocation Required. The value must be 'Replace', 'Before', or 'After'.
78075
- */
78076
- insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.InlinePicture;
78077
- /**
78078
- * Inserts OOXML at the specified location.
78079
- *
78080
- * @remarks
78081
- * [Api set: WordApi 1.2]
78082
- *
78083
- * @param ooxml Required. The OOXML to be inserted.
78084
- * @param insertLocation Required. The value must be 'Before' or 'After'.
78085
- */
78086
- insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range;
77817
+ insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.before | Word.InsertLocation.after | "Replace" | "Before" | "After"): Word.InlinePicture;
78087
77818
  /**
78088
77819
  * Inserts OOXML at the specified location.
78089
77820
  *
@@ -78093,7 +77824,7 @@ declare namespace Word {
78093
77824
  * @param ooxml Required. The OOXML to be inserted.
78094
77825
  * @param insertLocation Required. The value must be 'Before' or 'After'.
78095
77826
  */
78096
- insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
77827
+ insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;
78097
77828
  /**
78098
77829
  * Inserts a paragraph at the specified location.
78099
77830
  *
@@ -78103,27 +77834,7 @@ declare namespace Word {
78103
77834
  * @param paragraphText Required. The paragraph text to be inserted.
78104
77835
  * @param insertLocation Required. The value must be 'Before' or 'After'.
78105
77836
  */
78106
- insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
78107
- /**
78108
- * Inserts a paragraph at the specified location.
78109
- *
78110
- * @remarks
78111
- * [Api set: WordApi 1.2]
78112
- *
78113
- * @param paragraphText Required. The paragraph text to be inserted.
78114
- * @param insertLocation Required. The value must be 'Before' or 'After'.
78115
- */
78116
- insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph;
78117
- /**
78118
- * Inserts text at the specified location.
78119
- *
78120
- * @remarks
78121
- * [Api set: WordApi 1.2]
78122
- *
78123
- * @param text Required. Text to be inserted.
78124
- * @param insertLocation Required. The value must be 'Before' or 'After'.
78125
- */
78126
- insertText(text: string, insertLocation: Word.InsertLocation): Word.Range;
77837
+ insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph;
78127
77838
  /**
78128
77839
  * Inserts text at the specified location.
78129
77840
  *
@@ -78133,7 +77844,7 @@ declare namespace Word {
78133
77844
  * @param text Required. Text to be inserted.
78134
77845
  * @param insertLocation Required. The value must be 'Before' or 'After'.
78135
77846
  */
78136
- insertText(text: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
77847
+ insertText(text: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;
78137
77848
  /**
78138
77849
  * Selects the inline picture. This causes Word to scroll to the selection.
78139
77850
  *
@@ -78308,17 +78019,7 @@ declare namespace Word {
78308
78019
  * @param paragraphText Required. The paragraph text to be inserted.
78309
78020
  * @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'.
78310
78021
  */
78311
- insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
78312
- /**
78313
- * Inserts a paragraph at the specified location.
78314
- *
78315
- * @remarks
78316
- * [Api set: WordApi 1.3]
78317
- *
78318
- * @param paragraphText Required. The paragraph text to be inserted.
78319
- * @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'.
78320
- */
78321
- insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph;
78022
+ insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After"): Word.Paragraph;
78322
78023
  /**
78323
78024
  * Sets the alignment of the bullet, number, or picture at the specified level in the list.
78324
78025
  *
@@ -78485,14 +78186,14 @@ declare namespace Word {
78485
78186
  */
78486
78187
  getFirstOrNullObject(): Word.List;
78487
78188
  /**
78488
- * Gets a list object by its index in the collection.
78189
+ * Gets a list object by its ID.
78489
78190
  *
78490
78191
  * @remarks
78491
78192
  * [Api set: WordApi 1.3]
78492
78193
  *
78493
- * @param index A number that identifies the index location of a list object.
78194
+ * @param id The list's ID.
78494
78195
  */
78495
- getItem(index: number): Word.List;
78196
+ getItem(id: number): Word.List;
78496
78197
  /**
78497
78198
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
78498
78199
  *
@@ -79105,16 +78806,7 @@ declare namespace Word {
79105
78806
  *
79106
78807
  * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
79107
78808
  */
79108
- getRange(rangeLocation?: Word.RangeLocation): Word.Range;
79109
- /**
79110
- * Gets the whole paragraph, or the starting or ending point of the paragraph, as a range.
79111
- *
79112
- * @remarks
79113
- * [Api set: WordApi 1.3]
79114
- *
79115
- * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
79116
- */
79117
- getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
78809
+ getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | Word.RangeLocation.content | "Whole" | "Start" | "End" | "After" | "Content"): Word.Range;
79118
78810
  /**
79119
78811
  * Gets reviewed text based on ChangeTrackingVersion selection.
79120
78812
  *
@@ -79152,17 +78844,7 @@ declare namespace Word {
79152
78844
  * @param breakType Required. The break type to add to the document.
79153
78845
  * @param insertLocation Required. The value must be 'Before' or 'After'.
79154
78846
  */
79155
- insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void;
79156
- /**
79157
- * Inserts a break at the specified location in the main document.
79158
- *
79159
- * @remarks
79160
- * [Api set: WordApi 1.1]
79161
- *
79162
- * @param breakType Required. The break type to add to the document.
79163
- * @param insertLocation Required. The value must be 'Before' or 'After'.
79164
- */
79165
- insertBreak(breakType: "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): void;
78847
+ insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void;
79166
78848
  /**
79167
78849
  * Wraps the paragraph object with a rich text content control.
79168
78850
  *
@@ -79179,27 +78861,7 @@ declare namespace Word {
79179
78861
  * @param base64File Required. The base64 encoded content of a .docx file.
79180
78862
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
79181
78863
  */
79182
- insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range;
79183
- /**
79184
- * Inserts a document into the paragraph at the specified location.
79185
- *
79186
- * @remarks
79187
- * [Api set: WordApi 1.1]
79188
- *
79189
- * @param base64File Required. The base64 encoded content of a .docx file.
79190
- * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
79191
- */
79192
- insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
79193
- /**
79194
- * Inserts HTML into the paragraph at the specified location.
79195
- *
79196
- * @remarks
79197
- * [Api set: WordApi 1.1]
79198
- *
79199
- * @param html Required. The HTML to be inserted in the paragraph.
79200
- * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
79201
- */
79202
- insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range;
78864
+ insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
79203
78865
  /**
79204
78866
  * Inserts HTML into the paragraph at the specified location.
79205
78867
  *
@@ -79209,17 +78871,7 @@ declare namespace Word {
79209
78871
  * @param html Required. The HTML to be inserted in the paragraph.
79210
78872
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
79211
78873
  */
79212
- insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
79213
- /**
79214
- * Inserts a picture into the paragraph at the specified location.
79215
- *
79216
- * @remarks
79217
- * [Api set: WordApi 1.1]
79218
- *
79219
- * @param base64EncodedImage Required. The base64 encoded image to be inserted.
79220
- * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
79221
- */
79222
- insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture;
78874
+ insertHtml(html: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
79223
78875
  /**
79224
78876
  * Inserts a picture into the paragraph at the specified location.
79225
78877
  *
@@ -79229,17 +78881,7 @@ declare namespace Word {
79229
78881
  * @param base64EncodedImage Required. The base64 encoded image to be inserted.
79230
78882
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
79231
78883
  */
79232
- insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.InlinePicture;
79233
- /**
79234
- * Inserts OOXML into the paragraph at the specified location.
79235
- *
79236
- * @remarks
79237
- * [Api set: WordApi 1.1]
79238
- *
79239
- * @param ooxml Required. The OOXML to be inserted in the paragraph.
79240
- * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
79241
- */
79242
- insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range;
78884
+ insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.InlinePicture;
79243
78885
  /**
79244
78886
  * Inserts OOXML into the paragraph at the specified location.
79245
78887
  *
@@ -79249,7 +78891,7 @@ declare namespace Word {
79249
78891
  * @param ooxml Required. The OOXML to be inserted in the paragraph.
79250
78892
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
79251
78893
  */
79252
- insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
78894
+ insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
79253
78895
  /**
79254
78896
  * Inserts a paragraph at the specified location.
79255
78897
  *
@@ -79259,29 +78901,7 @@ declare namespace Word {
79259
78901
  * @param paragraphText Required. The paragraph text to be inserted.
79260
78902
  * @param insertLocation Required. The value must be 'Before' or 'After'.
79261
78903
  */
79262
- insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
79263
- /**
79264
- * Inserts a paragraph at the specified location.
79265
- *
79266
- * @remarks
79267
- * [Api set: WordApi 1.1]
79268
- *
79269
- * @param paragraphText Required. The paragraph text to be inserted.
79270
- * @param insertLocation Required. The value must be 'Before' or 'After'.
79271
- */
79272
- insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph;
79273
- /**
79274
- * Inserts a table with the specified number of rows and columns.
79275
- *
79276
- * @remarks
79277
- * [Api set: WordApi 1.3]
79278
- *
79279
- * @param rowCount Required. The number of rows in the table.
79280
- * @param columnCount Required. The number of columns in the table.
79281
- * @param insertLocation Required. The value must be 'Before' or 'After'.
79282
- * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
79283
- */
79284
- insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table;
78904
+ insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph;
79285
78905
  /**
79286
78906
  * Inserts a table with the specified number of rows and columns.
79287
78907
  *
@@ -79293,17 +78913,7 @@ declare namespace Word {
79293
78913
  * @param insertLocation Required. The value must be 'Before' or 'After'.
79294
78914
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
79295
78915
  */
79296
- insertTable(rowCount: number, columnCount: number, insertLocation: "Before" | "After" | "Start" | "End" | "Replace", values?: string[][]): Word.Table;
79297
- /**
79298
- * Inserts text into the paragraph at the specified location.
79299
- *
79300
- * @remarks
79301
- * [Api set: WordApi 1.1]
79302
- *
79303
- * @param text Required. Text to be inserted.
79304
- * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
79305
- */
79306
- insertText(text: string, insertLocation: Word.InsertLocation): Word.Range;
78916
+ insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table;
79307
78917
  /**
79308
78918
  * Inserts text into the paragraph at the specified location.
79309
78919
  *
@@ -79313,7 +78923,7 @@ declare namespace Word {
79313
78923
  * @param text Required. Text to be inserted.
79314
78924
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
79315
78925
  */
79316
- insertText(text: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
78926
+ insertText(text: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
79317
78927
  /**
79318
78928
  * Performs a search with the specified SearchOptions on the scope of the paragraph object. The search results are a collection of range objects.
79319
78929
  *
@@ -79729,16 +79339,7 @@ declare namespace Word {
79729
79339
  *
79730
79340
  * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
79731
79341
  */
79732
- getRange(rangeLocation?: Word.RangeLocation): Word.Range;
79733
- /**
79734
- * Clones the range, or gets the starting or ending point of the range as a new range.
79735
- *
79736
- * @remarks
79737
- * [Api set: WordApi 1.3]
79738
- *
79739
- * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
79740
- */
79741
- getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
79342
+ getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | Word.RangeLocation.content | "Whole" | "Start" | "End" | "After" | "Content"): Word.Range;
79742
79343
  /**
79743
79344
  * Gets reviewed text based on ChangeTrackingVersion selection.
79744
79345
  *
@@ -79776,17 +79377,7 @@ declare namespace Word {
79776
79377
  * @param breakType Required. The break type to add.
79777
79378
  * @param insertLocation Required. The value must be 'Before' or 'After'.
79778
79379
  */
79779
- insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void;
79780
- /**
79781
- * Inserts a break at the specified location in the main document.
79782
- *
79783
- * @remarks
79784
- * [Api set: WordApi 1.1]
79785
- *
79786
- * @param breakType Required. The break type to add.
79787
- * @param insertLocation Required. The value must be 'Before' or 'After'.
79788
- */
79789
- insertBreak(breakType: "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): void;
79380
+ insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void;
79790
79381
  /**
79791
79382
  * Insert a comment on the range.
79792
79383
  *
@@ -79822,17 +79413,7 @@ declare namespace Word {
79822
79413
  * @param base64File Required. The base64 encoded content of a .docx file.
79823
79414
  * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
79824
79415
  */
79825
- insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range;
79826
- /**
79827
- * Inserts a document at the specified location.
79828
- *
79829
- * @remarks
79830
- * [Api set: WordApi 1.1]
79831
- *
79832
- * @param base64File Required. The base64 encoded content of a .docx file.
79833
- * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
79834
- */
79835
- insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
79416
+ insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;
79836
79417
  /**
79837
79418
  * Inserts a footnote. The footnote reference is placed after the range.
79838
79419
  *
@@ -79851,27 +79432,7 @@ declare namespace Word {
79851
79432
  * @param html Required. The HTML to be inserted.
79852
79433
  * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
79853
79434
  */
79854
- insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range;
79855
- /**
79856
- * Inserts HTML at the specified location.
79857
- *
79858
- * @remarks
79859
- * [Api set: WordApi 1.1]
79860
- *
79861
- * @param html Required. The HTML to be inserted.
79862
- * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
79863
- */
79864
- insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
79865
- /**
79866
- * Inserts a picture at the specified location.
79867
- *
79868
- * @remarks
79869
- * [Api set: WordApi 1.2]
79870
- *
79871
- * @param base64EncodedImage Required. The base64 encoded image to be inserted.
79872
- * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
79873
- */
79874
- insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture;
79435
+ insertHtml(html: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;
79875
79436
  /**
79876
79437
  * Inserts a picture at the specified location.
79877
79438
  *
@@ -79881,17 +79442,7 @@ declare namespace Word {
79881
79442
  * @param base64EncodedImage Required. The base64 encoded image to be inserted.
79882
79443
  * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
79883
79444
  */
79884
- insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.InlinePicture;
79885
- /**
79886
- * Inserts OOXML at the specified location.
79887
- *
79888
- * @remarks
79889
- * [Api set: WordApi 1.1]
79890
- *
79891
- * @param ooxml Required. The OOXML to be inserted.
79892
- * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
79893
- */
79894
- insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range;
79445
+ insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.InlinePicture;
79895
79446
  /**
79896
79447
  * Inserts OOXML at the specified location.
79897
79448
  *
@@ -79901,17 +79452,7 @@ declare namespace Word {
79901
79452
  * @param ooxml Required. The OOXML to be inserted.
79902
79453
  * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
79903
79454
  */
79904
- insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
79905
- /**
79906
- * Inserts a paragraph at the specified location.
79907
- *
79908
- * @remarks
79909
- * [Api set: WordApi 1.1]
79910
- *
79911
- * @param paragraphText Required. The paragraph text to be inserted.
79912
- * @param insertLocation Required. The value must be 'Before' or 'After'.
79913
- */
79914
- insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
79455
+ insertOoxml(ooxml: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;
79915
79456
  /**
79916
79457
  * Inserts a paragraph at the specified location.
79917
79458
  *
@@ -79921,7 +79462,7 @@ declare namespace Word {
79921
79462
  * @param paragraphText Required. The paragraph text to be inserted.
79922
79463
  * @param insertLocation Required. The value must be 'Before' or 'After'.
79923
79464
  */
79924
- insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph;
79465
+ insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph;
79925
79466
  /**
79926
79467
  * Inserts a table with the specified number of rows and columns.
79927
79468
  *
@@ -79933,29 +79474,7 @@ declare namespace Word {
79933
79474
  * @param insertLocation Required. The value must be 'Before' or 'After'.
79934
79475
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
79935
79476
  */
79936
- insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table;
79937
- /**
79938
- * Inserts a table with the specified number of rows and columns.
79939
- *
79940
- * @remarks
79941
- * [Api set: WordApi 1.3]
79942
- *
79943
- * @param rowCount Required. The number of rows in the table.
79944
- * @param columnCount Required. The number of columns in the table.
79945
- * @param insertLocation Required. The value must be 'Before' or 'After'.
79946
- * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
79947
- */
79948
- insertTable(rowCount: number, columnCount: number, insertLocation: "Before" | "After" | "Start" | "End" | "Replace", values?: string[][]): Word.Table;
79949
- /**
79950
- * Inserts text at the specified location.
79951
- *
79952
- * @remarks
79953
- * [Api set: WordApi 1.1]
79954
- *
79955
- * @param text Required. Text to be inserted.
79956
- * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
79957
- */
79958
- insertText(text: string, insertLocation: Word.InsertLocation): Word.Range;
79477
+ insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table;
79959
79478
  /**
79960
79479
  * Inserts text at the specified location.
79961
79480
  *
@@ -79965,7 +79484,7 @@ declare namespace Word {
79965
79484
  * @param text Required. Text to be inserted.
79966
79485
  * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
79967
79486
  */
79968
- insertText(text: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
79487
+ insertText(text: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;
79969
79488
  /**
79970
79489
  * 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.
79971
79490
  *
@@ -80619,29 +80138,7 @@ declare namespace Word {
80619
80138
  * @param columnCount Required. Number of columns to add.
80620
80139
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
80621
80140
  */
80622
- addColumns(insertLocation: Word.InsertLocation, columnCount: number, values?: string[][]): void;
80623
- /**
80624
- * 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.
80625
- *
80626
- * @remarks
80627
- * [Api set: WordApi 1.3]
80628
- *
80629
- * @param insertLocation Required. It must be 'Start' or 'End', corresponding to the appropriate side of the table.
80630
- * @param columnCount Required. Number of columns to add.
80631
- * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
80632
- */
80633
- addColumns(insertLocation: "Before" | "After" | "Start" | "End" | "Replace", columnCount: number, values?: string[][]): void;
80634
- /**
80635
- * 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.
80636
- *
80637
- * @remarks
80638
- * [Api set: WordApi 1.3]
80639
- *
80640
- * @param insertLocation Required. It must be 'Start' or 'End'.
80641
- * @param rowCount Required. Number of rows to add.
80642
- * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
80643
- */
80644
- addRows(insertLocation: Word.InsertLocation, rowCount: number, values?: string[][]): Word.TableRowCollection;
80141
+ addColumns(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", columnCount: number, values?: string[][]): void;
80645
80142
  /**
80646
80143
  * 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.
80647
80144
  *
@@ -80652,7 +80149,7 @@ declare namespace Word {
80652
80149
  * @param rowCount Required. Number of rows to add.
80653
80150
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
80654
80151
  */
80655
- addRows(insertLocation: "Before" | "After" | "Start" | "End" | "Replace", rowCount: number, values?: string[][]): Word.TableRowCollection;
80152
+ addRows(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", rowCount: number, values?: string[][]): Word.TableRowCollection;
80656
80153
  /**
80657
80154
  * Autofits the table columns to the width of the window.
80658
80155
  *
@@ -80807,16 +80304,7 @@ declare namespace Word {
80807
80304
  *
80808
80305
  * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', or 'After'.
80809
80306
  */
80810
- getRange(rangeLocation?: Word.RangeLocation): Word.Range;
80811
- /**
80812
- * Gets the range that contains this table, or the range at the start or end of the table.
80813
- *
80814
- * @remarks
80815
- * [Api set: WordApi 1.3]
80816
- *
80817
- * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', or 'After'.
80818
- */
80819
- getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
80307
+ getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | "Whole" | "Start" | "End" | "After"): Word.Range;
80820
80308
  /**
80821
80309
  * Inserts a content control on the table.
80822
80310
  *
@@ -80833,17 +80321,7 @@ declare namespace Word {
80833
80321
  * @param paragraphText Required. The paragraph text to be inserted.
80834
80322
  * @param insertLocation Required. The value must be 'Before' or 'After'.
80835
80323
  */
80836
- insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
80837
- /**
80838
- * Inserts a paragraph at the specified location.
80839
- *
80840
- * @remarks
80841
- * [Api set: WordApi 1.3]
80842
- *
80843
- * @param paragraphText Required. The paragraph text to be inserted.
80844
- * @param insertLocation Required. The value must be 'Before' or 'After'.
80845
- */
80846
- insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph;
80324
+ insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph;
80847
80325
  /**
80848
80326
  * Inserts a table with the specified number of rows and columns.
80849
80327
  *
@@ -80855,19 +80333,7 @@ declare namespace Word {
80855
80333
  * @param insertLocation Required. The value must be 'Before' or 'After'.
80856
80334
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
80857
80335
  */
80858
- insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table;
80859
- /**
80860
- * Inserts a table with the specified number of rows and columns.
80861
- *
80862
- * @remarks
80863
- * [Api set: WordApi 1.3]
80864
- *
80865
- * @param rowCount Required. The number of rows in the table.
80866
- * @param columnCount Required. The number of columns in the table.
80867
- * @param insertLocation Required. The value must be 'Before' or 'After'.
80868
- * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
80869
- */
80870
- insertTable(rowCount: number, columnCount: number, insertLocation: "Before" | "After" | "Start" | "End" | "Replace", values?: string[][]): Word.Table;
80336
+ insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table;
80871
80337
  /**
80872
80338
  * Performs a search with the specified SearchOptions on the scope of the table object. The search results are a collection of range objects.
80873
80339
  *
@@ -81198,18 +80664,7 @@ declare namespace Word {
81198
80664
  * @param rowCount Required. Number of rows to add
81199
80665
  * @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.
81200
80666
  */
81201
- insertRows(insertLocation: Word.InsertLocation, rowCount: number, values?: string[][]): Word.TableRowCollection;
81202
- /**
81203
- * Inserts rows using this row as a template. If values are specified, inserts the values into the new rows.
81204
- *
81205
- * @remarks
81206
- * [Api set: WordApi 1.3]
81207
- *
81208
- * @param insertLocation Required. Where the new rows should be inserted, relative to the current row. It must be 'Before' or 'After'.
81209
- * @param rowCount Required. Number of rows to add
81210
- * @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.
81211
- */
81212
- insertRows(insertLocation: "Before" | "After" | "Start" | "End" | "Replace", rowCount: number, values?: string[][]): Word.TableRowCollection;
80667
+ insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection;
81213
80668
  /**
81214
80669
  * Performs a search with the specified SearchOptions on the scope of the row. The search results are a collection of range objects.
81215
80670
  *
@@ -81526,29 +80981,7 @@ declare namespace Word {
81526
80981
  * @param columnCount Required. Number of columns to add.
81527
80982
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
81528
80983
  */
81529
- insertColumns(insertLocation: Word.InsertLocation, columnCount: number, values?: string[][]): void;
81530
- /**
81531
- * 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.
81532
- *
81533
- * @remarks
81534
- * [Api set: WordApi 1.3]
81535
- *
81536
- * @param insertLocation Required. It must be 'Before' or 'After'.
81537
- * @param columnCount Required. Number of columns to add.
81538
- * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
81539
- */
81540
- insertColumns(insertLocation: "Before" | "After" | "Start" | "End" | "Replace", columnCount: number, values?: string[][]): void;
81541
- /**
81542
- * 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.
81543
- *
81544
- * @remarks
81545
- * [Api set: WordApi 1.3]
81546
- *
81547
- * @param insertLocation Required. It must be 'Before' or 'After'.
81548
- * @param rowCount Required. Number of rows to add.
81549
- * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
81550
- */
81551
- insertRows(insertLocation: Word.InsertLocation, rowCount: number, values?: string[][]): Word.TableRowCollection;
80984
+ insertColumns(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", columnCount: number, values?: string[][]): void;
81552
80985
  /**
81553
80986
  * 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.
81554
80987
  *
@@ -81559,7 +80992,7 @@ declare namespace Word {
81559
80992
  * @param rowCount Required. Number of rows to add.
81560
80993
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
81561
80994
  */
81562
- insertRows(insertLocation: "Before" | "After" | "Start" | "End" | "Replace", rowCount: number, values?: string[][]): Word.TableRowCollection;
80995
+ insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection;
81563
80996
  /**
81564
80997
  * Sets cell padding in points.
81565
80998
  *
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.278",
3
+ "version": "1.0.279",
4
4
  "description": "TypeScript definitions for Office.js",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
6
6
  "license": "MIT",
@@ -45,6 +45,6 @@
45
45
  },
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
- "typesPublisherContentHash": "88bfe3f560a440576b09e3f5a5b1ec26c79f29fc6b73b8e77281dc5ed35ae7d9",
48
+ "typesPublisherContentHash": "bf1b3bf96b5b4a27c7b0286bf61f4cfdd10d9e8a42f64a9651cb4a2b5a59d2c3",
49
49
  "typeScriptVersion": "4.1"
50
50
  }