@types/office-js-preview 1.0.305 → 1.0.306
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- office-js-preview/README.md +1 -1
- office-js-preview/index.d.ts +192 -367
- office-js-preview/package.json +2 -2
office-js-preview/index.d.ts
CHANGED
|
@@ -83304,8 +83304,7 @@ declare namespace Word {
|
|
|
83304
83304
|
* Gets the collection of endnotes in the body. Read-only.
|
|
83305
83305
|
*
|
|
83306
83306
|
* @remarks
|
|
83307
|
-
* [Api set: WordApiOnline
|
|
83308
|
-
* @beta
|
|
83307
|
+
* [Api set: WordApiOnline 1.1]
|
|
83309
83308
|
*/
|
|
83310
83309
|
readonly endnotes: Word.NoteItemCollection;
|
|
83311
83310
|
/**
|
|
@@ -83327,8 +83326,7 @@ declare namespace Word {
|
|
|
83327
83326
|
* Gets the collection of footnotes in the body. Read-only.
|
|
83328
83327
|
*
|
|
83329
83328
|
* @remarks
|
|
83330
|
-
* [Api set: WordApiOnline
|
|
83331
|
-
* @beta
|
|
83329
|
+
* [Api set: WordApiOnline 1.1]
|
|
83332
83330
|
*/
|
|
83333
83331
|
readonly footnotes: Word.NoteItemCollection;
|
|
83334
83332
|
/**
|
|
@@ -83448,8 +83446,7 @@ declare namespace Word {
|
|
|
83448
83446
|
* Gets comments associated with the body.
|
|
83449
83447
|
*
|
|
83450
83448
|
* @remarks
|
|
83451
|
-
* [Api set: WordApiOnline
|
|
83452
|
-
* @beta
|
|
83449
|
+
* [Api set: WordApiOnline 1.1]
|
|
83453
83450
|
*/
|
|
83454
83451
|
getComments(): Word.CommentCollection;
|
|
83455
83452
|
/**
|
|
@@ -83488,8 +83485,7 @@ declare namespace Word {
|
|
|
83488
83485
|
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
83489
83486
|
*
|
|
83490
83487
|
* @remarks
|
|
83491
|
-
* [Api set: WordApiOnline
|
|
83492
|
-
* @beta
|
|
83488
|
+
* [Api set: WordApiOnline 1.1]
|
|
83493
83489
|
*
|
|
83494
83490
|
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
83495
83491
|
*/
|
|
@@ -83498,8 +83494,7 @@ declare namespace Word {
|
|
|
83498
83494
|
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
83499
83495
|
*
|
|
83500
83496
|
* @remarks
|
|
83501
|
-
* [Api set: WordApiOnline
|
|
83502
|
-
* @beta
|
|
83497
|
+
* [Api set: WordApiOnline 1.1]
|
|
83503
83498
|
*
|
|
83504
83499
|
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
83505
83500
|
*/
|
|
@@ -83750,74 +83745,65 @@ declare namespace Word {
|
|
|
83750
83745
|
* Represents a comment in the document.
|
|
83751
83746
|
*
|
|
83752
83747
|
* @remarks
|
|
83753
|
-
* [Api set: WordApiOnline
|
|
83754
|
-
* @beta
|
|
83748
|
+
* [Api set: WordApiOnline 1.1]
|
|
83755
83749
|
*/
|
|
83756
83750
|
class Comment extends OfficeExtension.ClientObject {
|
|
83757
83751
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
83758
83752
|
context: RequestContext;
|
|
83759
83753
|
/**
|
|
83760
|
-
* Gets or sets the comment
|
|
83754
|
+
* Gets or sets the comment's content range.
|
|
83761
83755
|
*
|
|
83762
83756
|
* @remarks
|
|
83763
|
-
* [Api set: WordApiOnline
|
|
83764
|
-
* @beta
|
|
83757
|
+
* [Api set: WordApiOnline 1.1]
|
|
83765
83758
|
*/
|
|
83766
83759
|
contentRange: Word.CommentContentRange;
|
|
83767
83760
|
/**
|
|
83768
83761
|
* Gets the collection of reply objects associated with the comment.
|
|
83769
83762
|
*
|
|
83770
83763
|
* @remarks
|
|
83771
|
-
* [Api set: WordApiOnline
|
|
83772
|
-
* @beta
|
|
83764
|
+
* [Api set: WordApiOnline 1.1]
|
|
83773
83765
|
*/
|
|
83774
83766
|
readonly replies: Word.CommentReplyCollection;
|
|
83775
83767
|
/**
|
|
83776
83768
|
* Gets the email of the comment's author.
|
|
83777
83769
|
*
|
|
83778
83770
|
* @remarks
|
|
83779
|
-
* [Api set: WordApiOnline
|
|
83780
|
-
* @beta
|
|
83771
|
+
* [Api set: WordApiOnline 1.1]
|
|
83781
83772
|
*/
|
|
83782
83773
|
readonly authorEmail: string;
|
|
83783
83774
|
/**
|
|
83784
83775
|
* Gets the name of the comment's author.
|
|
83785
83776
|
*
|
|
83786
83777
|
* @remarks
|
|
83787
|
-
* [Api set: WordApiOnline
|
|
83788
|
-
* @beta
|
|
83778
|
+
* [Api set: WordApiOnline 1.1]
|
|
83789
83779
|
*/
|
|
83790
83780
|
readonly authorName: string;
|
|
83791
83781
|
/**
|
|
83792
83782
|
* Gets or sets the comment's content as plain text.
|
|
83793
83783
|
*
|
|
83794
83784
|
* @remarks
|
|
83795
|
-
* [Api set: WordApiOnline
|
|
83796
|
-
* @beta
|
|
83785
|
+
* [Api set: WordApiOnline 1.1]
|
|
83797
83786
|
*/
|
|
83798
83787
|
content: string;
|
|
83799
83788
|
/**
|
|
83800
83789
|
* Gets the creation date of the comment.
|
|
83801
83790
|
*
|
|
83802
83791
|
* @remarks
|
|
83803
|
-
* [Api set: WordApiOnline
|
|
83804
|
-
* @beta
|
|
83792
|
+
* [Api set: WordApiOnline 1.1]
|
|
83805
83793
|
*/
|
|
83806
83794
|
readonly creationDate: Date;
|
|
83807
83795
|
/**
|
|
83808
83796
|
* Gets the ID of the comment. Read-only.
|
|
83809
83797
|
*
|
|
83810
83798
|
* @remarks
|
|
83811
|
-
* [Api set: WordApiOnline
|
|
83812
|
-
* @beta
|
|
83799
|
+
* [Api set: WordApiOnline 1.1]
|
|
83813
83800
|
*/
|
|
83814
83801
|
readonly id: string;
|
|
83815
83802
|
/**
|
|
83816
83803
|
* Gets or sets the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved.
|
|
83817
83804
|
*
|
|
83818
83805
|
* @remarks
|
|
83819
|
-
* [Api set: WordApiOnline
|
|
83820
|
-
* @beta
|
|
83806
|
+
* [Api set: WordApiOnline 1.1]
|
|
83821
83807
|
*/
|
|
83822
83808
|
resolved: boolean;
|
|
83823
83809
|
/**
|
|
@@ -83832,24 +83818,21 @@ declare namespace Word {
|
|
|
83832
83818
|
* Deletes the comment and its replies.
|
|
83833
83819
|
*
|
|
83834
83820
|
* @remarks
|
|
83835
|
-
* [Api set: WordApiOnline
|
|
83836
|
-
* @beta
|
|
83821
|
+
* [Api set: WordApiOnline 1.1]
|
|
83837
83822
|
*/
|
|
83838
83823
|
delete(): void;
|
|
83839
83824
|
/**
|
|
83840
83825
|
* Gets the range in the main document where the comment is on.
|
|
83841
83826
|
*
|
|
83842
83827
|
* @remarks
|
|
83843
|
-
* [Api set: WordApiOnline
|
|
83844
|
-
* @beta
|
|
83828
|
+
* [Api set: WordApiOnline 1.1]
|
|
83845
83829
|
*/
|
|
83846
83830
|
getRange(): Word.Range;
|
|
83847
83831
|
/**
|
|
83848
83832
|
* Adds a new reply to the end of the comment thread.
|
|
83849
83833
|
*
|
|
83850
83834
|
* @remarks
|
|
83851
|
-
* [Api set: WordApiOnline
|
|
83852
|
-
* @beta
|
|
83835
|
+
* [Api set: WordApiOnline 1.1]
|
|
83853
83836
|
*
|
|
83854
83837
|
* @param replyText Required. Reply text.
|
|
83855
83838
|
*/
|
|
@@ -83893,8 +83876,7 @@ declare namespace Word {
|
|
|
83893
83876
|
* Contains a collection of {@link Word.Comment} objects.
|
|
83894
83877
|
*
|
|
83895
83878
|
* @remarks
|
|
83896
|
-
* [Api set: WordApiOnline
|
|
83897
|
-
* @beta
|
|
83879
|
+
* [Api set: WordApiOnline 1.1]
|
|
83898
83880
|
*/
|
|
83899
83881
|
class CommentCollection extends OfficeExtension.ClientObject {
|
|
83900
83882
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -83905,24 +83887,21 @@ declare namespace Word {
|
|
|
83905
83887
|
* Gets the first comment in the collection. Throws an error if this collection is empty.
|
|
83906
83888
|
*
|
|
83907
83889
|
* @remarks
|
|
83908
|
-
* [Api set: WordApiOnline
|
|
83909
|
-
* @beta
|
|
83890
|
+
* [Api set: WordApiOnline 1.1]
|
|
83910
83891
|
*/
|
|
83911
83892
|
getFirst(): Word.Comment;
|
|
83912
83893
|
/**
|
|
83913
83894
|
* Gets the first comment in the collection. If the collection is empty, returns a null object.
|
|
83914
83895
|
*
|
|
83915
83896
|
* @remarks
|
|
83916
|
-
* [Api set: WordApiOnline
|
|
83917
|
-
* @beta
|
|
83897
|
+
* [Api set: WordApiOnline 1.1]
|
|
83918
83898
|
*/
|
|
83919
83899
|
getFirstOrNullObject(): Word.Comment;
|
|
83920
83900
|
/**
|
|
83921
83901
|
* Gets a comment object by its index in the collection.
|
|
83922
83902
|
*
|
|
83923
83903
|
* @remarks
|
|
83924
|
-
* [Api set: WordApiOnline
|
|
83925
|
-
* @beta
|
|
83904
|
+
* [Api set: WordApiOnline 1.1]
|
|
83926
83905
|
*
|
|
83927
83906
|
* @param index A number that identifies the index location of a comment object.
|
|
83928
83907
|
*/
|
|
@@ -83961,8 +83940,7 @@ declare namespace Word {
|
|
|
83961
83940
|
}
|
|
83962
83941
|
/**
|
|
83963
83942
|
* @remarks
|
|
83964
|
-
* [Api set: WordApiOnline
|
|
83965
|
-
* @beta
|
|
83943
|
+
* [Api set: WordApiOnline 1.1]
|
|
83966
83944
|
*/
|
|
83967
83945
|
class CommentContentRange extends OfficeExtension.ClientObject {
|
|
83968
83946
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -83971,56 +83949,49 @@ declare namespace Word {
|
|
|
83971
83949
|
* Gets or sets a value that indicates whether the comment text is bold.
|
|
83972
83950
|
*
|
|
83973
83951
|
* @remarks
|
|
83974
|
-
* [Api set: WordApiOnline
|
|
83975
|
-
* @beta
|
|
83952
|
+
* [Api set: WordApiOnline 1.1]
|
|
83976
83953
|
*/
|
|
83977
83954
|
bold: boolean;
|
|
83978
83955
|
/**
|
|
83979
83956
|
* Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range.
|
|
83980
83957
|
*
|
|
83981
83958
|
* @remarks
|
|
83982
|
-
* [Api set: WordApiOnline
|
|
83983
|
-
* @beta
|
|
83959
|
+
* [Api set: WordApiOnline 1.1]
|
|
83984
83960
|
*/
|
|
83985
83961
|
hyperlink: string;
|
|
83986
83962
|
/**
|
|
83987
83963
|
* Checks whether the range length is zero. Read-only.
|
|
83988
83964
|
*
|
|
83989
83965
|
* @remarks
|
|
83990
|
-
* [Api set: WordApiOnline
|
|
83991
|
-
* @beta
|
|
83966
|
+
* [Api set: WordApiOnline 1.1]
|
|
83992
83967
|
*/
|
|
83993
83968
|
readonly isEmpty: boolean;
|
|
83994
83969
|
/**
|
|
83995
83970
|
* Gets or sets a value that indicates whether the comment text is italicized.
|
|
83996
83971
|
*
|
|
83997
83972
|
* @remarks
|
|
83998
|
-
* [Api set: WordApiOnline
|
|
83999
|
-
* @beta
|
|
83973
|
+
* [Api set: WordApiOnline 1.1]
|
|
84000
83974
|
*/
|
|
84001
83975
|
italic: boolean;
|
|
84002
83976
|
/**
|
|
84003
83977
|
* Gets or sets a value that indicates whether the comment text has a strikethrough.
|
|
84004
83978
|
*
|
|
84005
83979
|
* @remarks
|
|
84006
|
-
* [Api set: WordApiOnline
|
|
84007
|
-
* @beta
|
|
83980
|
+
* [Api set: WordApiOnline 1.1]
|
|
84008
83981
|
*/
|
|
84009
83982
|
strikeThrough: boolean;
|
|
84010
83983
|
/**
|
|
84011
83984
|
* Gets the text of the comment range. Read-only.
|
|
84012
83985
|
*
|
|
84013
83986
|
* @remarks
|
|
84014
|
-
* [Api set: WordApiOnline
|
|
84015
|
-
* @beta
|
|
83987
|
+
* [Api set: WordApiOnline 1.1]
|
|
84016
83988
|
*/
|
|
84017
83989
|
readonly text: string;
|
|
84018
83990
|
/**
|
|
84019
83991
|
* Gets or sets a value that indicates the comment text's underline type. 'None' if the comment text is not underlined.
|
|
84020
83992
|
*
|
|
84021
83993
|
* @remarks
|
|
84022
|
-
* [Api set: WordApiOnline
|
|
84023
|
-
* @beta
|
|
83994
|
+
* [Api set: WordApiOnline 1.1]
|
|
84024
83995
|
*/
|
|
84025
83996
|
underline: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble";
|
|
84026
83997
|
/**
|
|
@@ -84035,8 +84006,7 @@ declare namespace Word {
|
|
|
84035
84006
|
* Inserts text into at the specified location.
|
|
84036
84007
|
*
|
|
84037
84008
|
* @remarks
|
|
84038
|
-
* [Api set: WordApiOnline
|
|
84039
|
-
* @beta
|
|
84009
|
+
* [Api set: WordApiOnline 1.1]
|
|
84040
84010
|
*
|
|
84041
84011
|
* @param text Required. The text to be inserted in to the CommentContentRange.
|
|
84042
84012
|
* @param insertLocation Required. The value must be 'After', 'Before', 'Replace', 'Start', or 'End'.
|
|
@@ -84046,8 +84016,7 @@ declare namespace Word {
|
|
|
84046
84016
|
* Inserts text into at the specified location.
|
|
84047
84017
|
*
|
|
84048
84018
|
* @remarks
|
|
84049
|
-
* [Api set: WordApiOnline
|
|
84050
|
-
* @beta
|
|
84019
|
+
* [Api set: WordApiOnline 1.1]
|
|
84051
84020
|
*
|
|
84052
84021
|
* @param text Required. The text to be inserted in to the CommentContentRange.
|
|
84053
84022
|
* @param insertLocation Required. The value must be 'After', 'Before', 'Replace', 'Start', or 'End'.
|
|
@@ -84092,8 +84061,7 @@ declare namespace Word {
|
|
|
84092
84061
|
* Represents a comment reply in the document.
|
|
84093
84062
|
*
|
|
84094
84063
|
* @remarks
|
|
84095
|
-
* [Api set: WordApiOnline
|
|
84096
|
-
* @beta
|
|
84064
|
+
* [Api set: WordApiOnline 1.1]
|
|
84097
84065
|
*/
|
|
84098
84066
|
class CommentReply extends OfficeExtension.ClientObject {
|
|
84099
84067
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -84102,56 +84070,49 @@ declare namespace Word {
|
|
|
84102
84070
|
* Gets or sets the commentReply's content range.
|
|
84103
84071
|
*
|
|
84104
84072
|
* @remarks
|
|
84105
|
-
* [Api set: WordApiOnline
|
|
84106
|
-
* @beta
|
|
84073
|
+
* [Api set: WordApiOnline 1.1]
|
|
84107
84074
|
*/
|
|
84108
84075
|
contentRange: Word.CommentContentRange;
|
|
84109
84076
|
/**
|
|
84110
84077
|
* Gets the parent comment of this reply.
|
|
84111
84078
|
*
|
|
84112
84079
|
* @remarks
|
|
84113
|
-
* [Api set: WordApiOnline
|
|
84114
|
-
* @beta
|
|
84080
|
+
* [Api set: WordApiOnline 1.1]
|
|
84115
84081
|
*/
|
|
84116
84082
|
readonly parentComment: Word.Comment;
|
|
84117
84083
|
/**
|
|
84118
84084
|
* Gets the email of the comment reply's author.
|
|
84119
84085
|
*
|
|
84120
84086
|
* @remarks
|
|
84121
|
-
* [Api set: WordApiOnline
|
|
84122
|
-
* @beta
|
|
84087
|
+
* [Api set: WordApiOnline 1.1]
|
|
84123
84088
|
*/
|
|
84124
84089
|
readonly authorEmail: string;
|
|
84125
84090
|
/**
|
|
84126
84091
|
* Gets the name of the comment reply's author.
|
|
84127
84092
|
*
|
|
84128
84093
|
* @remarks
|
|
84129
|
-
* [Api set: WordApiOnline
|
|
84130
|
-
* @beta
|
|
84094
|
+
* [Api set: WordApiOnline 1.1]
|
|
84131
84095
|
*/
|
|
84132
84096
|
readonly authorName: string;
|
|
84133
84097
|
/**
|
|
84134
84098
|
* Gets or sets the comment reply's content. The string is plain text.
|
|
84135
84099
|
*
|
|
84136
84100
|
* @remarks
|
|
84137
|
-
* [Api set: WordApiOnline
|
|
84138
|
-
* @beta
|
|
84101
|
+
* [Api set: WordApiOnline 1.1]
|
|
84139
84102
|
*/
|
|
84140
84103
|
content: string;
|
|
84141
84104
|
/**
|
|
84142
84105
|
* Gets the creation date of the comment reply.
|
|
84143
84106
|
*
|
|
84144
84107
|
* @remarks
|
|
84145
|
-
* [Api set: WordApiOnline
|
|
84146
|
-
* @beta
|
|
84108
|
+
* [Api set: WordApiOnline 1.1]
|
|
84147
84109
|
*/
|
|
84148
84110
|
readonly creationDate: Date;
|
|
84149
84111
|
/**
|
|
84150
84112
|
* Gets the ID of the comment reply. Read-only.
|
|
84151
84113
|
*
|
|
84152
84114
|
* @remarks
|
|
84153
|
-
* [Api set: WordApiOnline
|
|
84154
|
-
* @beta
|
|
84115
|
+
* [Api set: WordApiOnline 1.1]
|
|
84155
84116
|
*/
|
|
84156
84117
|
readonly id: string;
|
|
84157
84118
|
/**
|
|
@@ -84166,8 +84127,7 @@ declare namespace Word {
|
|
|
84166
84127
|
* Deletes the comment reply.
|
|
84167
84128
|
*
|
|
84168
84129
|
* @remarks
|
|
84169
|
-
* [Api set: WordApiOnline
|
|
84170
|
-
* @beta
|
|
84130
|
+
* [Api set: WordApiOnline 1.1]
|
|
84171
84131
|
*/
|
|
84172
84132
|
delete(): void;
|
|
84173
84133
|
/**
|
|
@@ -84209,8 +84169,7 @@ declare namespace Word {
|
|
|
84209
84169
|
* Contains a collection of {@link Word.CommentReply} objects. Represents all comment replies in one comment thread.
|
|
84210
84170
|
*
|
|
84211
84171
|
* @remarks
|
|
84212
|
-
* [Api set: WordApiOnline
|
|
84213
|
-
* @beta
|
|
84172
|
+
* [Api set: WordApiOnline 1.1]
|
|
84214
84173
|
*/
|
|
84215
84174
|
class CommentReplyCollection extends OfficeExtension.ClientObject {
|
|
84216
84175
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -84221,24 +84180,21 @@ declare namespace Word {
|
|
|
84221
84180
|
* Gets the first comment reply in the collection. Throws an error if this collection is empty.
|
|
84222
84181
|
*
|
|
84223
84182
|
* @remarks
|
|
84224
|
-
* [Api set: WordApiOnline
|
|
84225
|
-
* @beta
|
|
84183
|
+
* [Api set: WordApiOnline 1.1]
|
|
84226
84184
|
*/
|
|
84227
84185
|
getFirst(): Word.CommentReply;
|
|
84228
84186
|
/**
|
|
84229
84187
|
* Gets the first comment reply in the collection. If the collection is empty, returns a null object.
|
|
84230
84188
|
*
|
|
84231
84189
|
* @remarks
|
|
84232
|
-
* [Api set: WordApiOnline
|
|
84233
|
-
* @beta
|
|
84190
|
+
* [Api set: WordApiOnline 1.1]
|
|
84234
84191
|
*/
|
|
84235
84192
|
getFirstOrNullObject(): Word.CommentReply;
|
|
84236
84193
|
/**
|
|
84237
84194
|
* Gets a comment reply object by its index in the collection.
|
|
84238
84195
|
*
|
|
84239
84196
|
* @remarks
|
|
84240
|
-
* [Api set: WordApiOnline
|
|
84241
|
-
* @beta
|
|
84197
|
+
* [Api set: WordApiOnline 1.1]
|
|
84242
84198
|
*
|
|
84243
84199
|
* @param index A number that identifies the index location of a comment reply object.
|
|
84244
84200
|
*/
|
|
@@ -84295,8 +84251,7 @@ declare namespace Word {
|
|
|
84295
84251
|
* Gets the collection of endnotes in the contentcontrol. Read-only.
|
|
84296
84252
|
*
|
|
84297
84253
|
* @remarks
|
|
84298
|
-
* [Api set: WordApiOnline
|
|
84299
|
-
* @beta
|
|
84254
|
+
* [Api set: WordApiOnline 1.1]
|
|
84300
84255
|
*/
|
|
84301
84256
|
readonly endnotes: Word.NoteItemCollection;
|
|
84302
84257
|
/**
|
|
@@ -84318,8 +84273,7 @@ declare namespace Word {
|
|
|
84318
84273
|
* Gets the collection of footnotes in the contentcontrol. Read-only.
|
|
84319
84274
|
*
|
|
84320
84275
|
* @remarks
|
|
84321
|
-
* [Api set: WordApiOnline
|
|
84322
|
-
* @beta
|
|
84276
|
+
* [Api set: WordApiOnline 1.1]
|
|
84323
84277
|
*/
|
|
84324
84278
|
readonly footnotes: Word.NoteItemCollection;
|
|
84325
84279
|
/**
|
|
@@ -84526,8 +84480,7 @@ declare namespace Word {
|
|
|
84526
84480
|
* Gets comments associated with the body.
|
|
84527
84481
|
*
|
|
84528
84482
|
* @remarks
|
|
84529
|
-
* [Api set: WordApiOnline
|
|
84530
|
-
* @beta
|
|
84483
|
+
* [Api set: WordApiOnline 1.1]
|
|
84531
84484
|
*/
|
|
84532
84485
|
getComments(): Word.CommentCollection;
|
|
84533
84486
|
/**
|
|
@@ -84566,8 +84519,7 @@ declare namespace Word {
|
|
|
84566
84519
|
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
84567
84520
|
*
|
|
84568
84521
|
* @remarks
|
|
84569
|
-
* [Api set: WordApiOnline
|
|
84570
|
-
* @beta
|
|
84522
|
+
* [Api set: WordApiOnline 1.1]
|
|
84571
84523
|
*
|
|
84572
84524
|
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
84573
84525
|
*/
|
|
@@ -84576,8 +84528,7 @@ declare namespace Word {
|
|
|
84576
84528
|
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
84577
84529
|
*
|
|
84578
84530
|
* @remarks
|
|
84579
|
-
* [Api set: WordApiOnline
|
|
84580
|
-
* @beta
|
|
84531
|
+
* [Api set: WordApiOnline 1.1]
|
|
84581
84532
|
*
|
|
84582
84533
|
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
84583
84534
|
*/
|
|
@@ -85674,8 +85625,7 @@ declare namespace Word {
|
|
|
85674
85625
|
* Gets or sets the ChangeTracking mode.
|
|
85675
85626
|
*
|
|
85676
85627
|
* @remarks
|
|
85677
|
-
* [Api set: WordApiOnline
|
|
85678
|
-
* @beta
|
|
85628
|
+
* [Api set: WordApiOnline 1.1]
|
|
85679
85629
|
*/
|
|
85680
85630
|
changeTrackingMode: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly";
|
|
85681
85631
|
/**
|
|
@@ -85728,8 +85678,7 @@ declare namespace Word {
|
|
|
85728
85678
|
Not implemented in Word on the web.
|
|
85729
85679
|
*
|
|
85730
85680
|
* @remarks
|
|
85731
|
-
* [Api set: WordApiOnline
|
|
85732
|
-
* @beta
|
|
85681
|
+
* [Api set: WordApiOnline 1.1]
|
|
85733
85682
|
*/
|
|
85734
85683
|
getEndnoteBody(): Word.Body;
|
|
85735
85684
|
/**
|
|
@@ -85737,8 +85686,7 @@ declare namespace Word {
|
|
|
85737
85686
|
Not implemented in Word on the web.
|
|
85738
85687
|
*
|
|
85739
85688
|
* @remarks
|
|
85740
|
-
* [Api set: WordApiOnline
|
|
85741
|
-
* @beta
|
|
85689
|
+
* [Api set: WordApiOnline 1.1]
|
|
85742
85690
|
*/
|
|
85743
85691
|
getFootnoteBody(): Word.Body;
|
|
85744
85692
|
/**
|
|
@@ -85759,8 +85707,7 @@ declare namespace Word {
|
|
|
85759
85707
|
* Performs a search with the specified search options on the scope of the whole document. The search results are a collection of range objects.
|
|
85760
85708
|
*
|
|
85761
85709
|
* @remarks
|
|
85762
|
-
* [Api set:
|
|
85763
|
-
* @beta
|
|
85710
|
+
* [Api set: WordApiOnline 1.1]
|
|
85764
85711
|
*/
|
|
85765
85712
|
search(searchText: string, searchOptions?: Word.SearchOptions | {
|
|
85766
85713
|
ignorePunct?: boolean;
|
|
@@ -87326,34 +87273,30 @@ declare namespace Word {
|
|
|
87326
87273
|
* Represents a footnote or endnote.
|
|
87327
87274
|
*
|
|
87328
87275
|
* @remarks
|
|
87329
|
-
* [Api set: WordApiOnline
|
|
87330
|
-
* @beta
|
|
87276
|
+
* [Api set: WordApiOnline 1.1]
|
|
87331
87277
|
*/
|
|
87332
87278
|
class NoteItem extends OfficeExtension.ClientObject {
|
|
87333
87279
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
87334
87280
|
context: RequestContext;
|
|
87335
87281
|
/**
|
|
87336
|
-
* Represents the body object of the note item. It
|
|
87282
|
+
* Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
|
|
87337
87283
|
*
|
|
87338
87284
|
* @remarks
|
|
87339
|
-
* [Api set: WordApiOnline
|
|
87340
|
-
* @beta
|
|
87285
|
+
* [Api set: WordApiOnline 1.1]
|
|
87341
87286
|
*/
|
|
87342
87287
|
readonly body: Word.Body;
|
|
87343
87288
|
/**
|
|
87344
87289
|
* Represents a footnote or endnote reference in the main document.
|
|
87345
87290
|
*
|
|
87346
87291
|
* @remarks
|
|
87347
|
-
* [Api set: WordApiOnline
|
|
87348
|
-
* @beta
|
|
87292
|
+
* [Api set: WordApiOnline 1.1]
|
|
87349
87293
|
*/
|
|
87350
87294
|
readonly reference: Word.Range;
|
|
87351
87295
|
/**
|
|
87352
87296
|
* Represents the note item type: footnote or endnote.
|
|
87353
87297
|
*
|
|
87354
87298
|
* @remarks
|
|
87355
|
-
* [Api set: WordApiOnline
|
|
87356
|
-
* @beta
|
|
87299
|
+
* [Api set: WordApiOnline 1.1]
|
|
87357
87300
|
*/
|
|
87358
87301
|
readonly type: Word.NoteItemType | "Footnote" | "Endnote";
|
|
87359
87302
|
/**
|
|
@@ -87368,24 +87311,21 @@ declare namespace Word {
|
|
|
87368
87311
|
* Deletes the note item.
|
|
87369
87312
|
*
|
|
87370
87313
|
* @remarks
|
|
87371
|
-
* [Api set: WordApiOnline
|
|
87372
|
-
* @beta
|
|
87314
|
+
* [Api set: WordApiOnline 1.1]
|
|
87373
87315
|
*/
|
|
87374
87316
|
delete(): void;
|
|
87375
87317
|
/**
|
|
87376
87318
|
* Gets the next note item of the same type. Throws an error if this note item is the last one.
|
|
87377
87319
|
*
|
|
87378
87320
|
* @remarks
|
|
87379
|
-
* [Api set: WordApiOnline
|
|
87380
|
-
* @beta
|
|
87321
|
+
* [Api set: WordApiOnline 1.1]
|
|
87381
87322
|
*/
|
|
87382
87323
|
getNext(): Word.NoteItem;
|
|
87383
87324
|
/**
|
|
87384
87325
|
* Gets the next note item of the same type. Returns a null object if this note item is the last one.
|
|
87385
87326
|
*
|
|
87386
87327
|
* @remarks
|
|
87387
|
-
* [Api set: WordApiOnline
|
|
87388
|
-
* @beta
|
|
87328
|
+
* [Api set: WordApiOnline 1.1]
|
|
87389
87329
|
*/
|
|
87390
87330
|
getNextOrNullObject(): Word.NoteItem;
|
|
87391
87331
|
/**
|
|
@@ -87427,8 +87367,7 @@ declare namespace Word {
|
|
|
87427
87367
|
* Contains a collection of {@link Word.NoteItem} objects.
|
|
87428
87368
|
*
|
|
87429
87369
|
* @remarks
|
|
87430
|
-
* [Api set: WordApiOnline
|
|
87431
|
-
* @beta
|
|
87370
|
+
* [Api set: WordApiOnline 1.1]
|
|
87432
87371
|
*/
|
|
87433
87372
|
class NoteItemCollection extends OfficeExtension.ClientObject {
|
|
87434
87373
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -87439,16 +87378,14 @@ declare namespace Word {
|
|
|
87439
87378
|
* Gets the first note item in this collection. Throws an error if this collection is empty.
|
|
87440
87379
|
*
|
|
87441
87380
|
* @remarks
|
|
87442
|
-
* [Api set: WordApiOnline
|
|
87443
|
-
* @beta
|
|
87381
|
+
* [Api set: WordApiOnline 1.1]
|
|
87444
87382
|
*/
|
|
87445
87383
|
getFirst(): Word.NoteItem;
|
|
87446
87384
|
/**
|
|
87447
87385
|
* Gets the first note item in this collection. Returns a null object if this collection is empty.
|
|
87448
87386
|
*
|
|
87449
87387
|
* @remarks
|
|
87450
|
-
* [Api set: WordApiOnline
|
|
87451
|
-
* @beta
|
|
87388
|
+
* [Api set: WordApiOnline 1.1]
|
|
87452
87389
|
*/
|
|
87453
87390
|
getFirstOrNullObject(): Word.NoteItem;
|
|
87454
87391
|
/**
|
|
@@ -87503,8 +87440,7 @@ declare namespace Word {
|
|
|
87503
87440
|
* Gets the collection of endnotes in the paragraph. Read-only.
|
|
87504
87441
|
*
|
|
87505
87442
|
* @remarks
|
|
87506
|
-
* [Api set: WordApiOnline
|
|
87507
|
-
* @beta
|
|
87443
|
+
* [Api set: WordApiOnline 1.1]
|
|
87508
87444
|
*/
|
|
87509
87445
|
readonly endnotes: Word.NoteItemCollection;
|
|
87510
87446
|
/**
|
|
@@ -87526,8 +87462,7 @@ declare namespace Word {
|
|
|
87526
87462
|
* Gets the collection of footnotes in the paragraph. Read-only.
|
|
87527
87463
|
*
|
|
87528
87464
|
* @remarks
|
|
87529
|
-
* [Api set: WordApiOnline
|
|
87530
|
-
* @beta
|
|
87465
|
+
* [Api set: WordApiOnline 1.1]
|
|
87531
87466
|
*/
|
|
87532
87467
|
readonly footnotes: Word.NoteItemCollection;
|
|
87533
87468
|
/**
|
|
@@ -87769,8 +87704,7 @@ declare namespace Word {
|
|
|
87769
87704
|
* Gets comments associated with the paragraph.
|
|
87770
87705
|
*
|
|
87771
87706
|
* @remarks
|
|
87772
|
-
* [Api set: WordApiOnline
|
|
87773
|
-
* @beta
|
|
87707
|
+
* [Api set: WordApiOnline 1.1]
|
|
87774
87708
|
*/
|
|
87775
87709
|
getComments(): Word.CommentCollection;
|
|
87776
87710
|
/**
|
|
@@ -87837,8 +87771,7 @@ declare namespace Word {
|
|
|
87837
87771
|
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
87838
87772
|
*
|
|
87839
87773
|
* @remarks
|
|
87840
|
-
* [Api set: WordApiOnline
|
|
87841
|
-
* @beta
|
|
87774
|
+
* [Api set: WordApiOnline 1.1]
|
|
87842
87775
|
*
|
|
87843
87776
|
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
87844
87777
|
*/
|
|
@@ -87847,8 +87780,7 @@ declare namespace Word {
|
|
|
87847
87780
|
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
87848
87781
|
*
|
|
87849
87782
|
* @remarks
|
|
87850
|
-
* [Api set: WordApiOnline
|
|
87851
|
-
* @beta
|
|
87783
|
+
* [Api set: WordApiOnline 1.1]
|
|
87852
87784
|
*
|
|
87853
87785
|
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
87854
87786
|
*/
|
|
@@ -88214,8 +88146,7 @@ declare namespace Word {
|
|
|
88214
88146
|
* Gets the collection of endnotes in the range. Read-only.
|
|
88215
88147
|
*
|
|
88216
88148
|
* @remarks
|
|
88217
|
-
* [Api set: WordApiOnline
|
|
88218
|
-
* @beta
|
|
88149
|
+
* [Api set: WordApiOnline 1.1]
|
|
88219
88150
|
*/
|
|
88220
88151
|
readonly endnotes: Word.NoteItemCollection;
|
|
88221
88152
|
/**
|
|
@@ -88237,8 +88168,7 @@ declare namespace Word {
|
|
|
88237
88168
|
* Gets the collection of footnotes in the range. Read-only.
|
|
88238
88169
|
*
|
|
88239
88170
|
* @remarks
|
|
88240
|
-
* [Api set: WordApiOnline
|
|
88241
|
-
* @beta
|
|
88171
|
+
* [Api set: WordApiOnline 1.1]
|
|
88242
88172
|
*/
|
|
88243
88173
|
readonly footnotes: Word.NoteItemCollection;
|
|
88244
88174
|
/**
|
|
@@ -88417,8 +88347,7 @@ declare namespace Word {
|
|
|
88417
88347
|
* Gets comments associated with the range.
|
|
88418
88348
|
*
|
|
88419
88349
|
* @remarks
|
|
88420
|
-
* [Api set: WordApiOnline
|
|
88421
|
-
* @beta
|
|
88350
|
+
* [Api set: WordApiOnline 1.1]
|
|
88422
88351
|
* @returns
|
|
88423
88352
|
*/
|
|
88424
88353
|
getComments(): Word.CommentCollection;
|
|
@@ -88485,8 +88414,7 @@ declare namespace Word {
|
|
|
88485
88414
|
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
88486
88415
|
*
|
|
88487
88416
|
* @remarks
|
|
88488
|
-
* [Api set: WordApiOnline
|
|
88489
|
-
* @beta
|
|
88417
|
+
* [Api set: WordApiOnline 1.1]
|
|
88490
88418
|
*
|
|
88491
88419
|
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
88492
88420
|
*/
|
|
@@ -88495,8 +88423,7 @@ declare namespace Word {
|
|
|
88495
88423
|
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
88496
88424
|
*
|
|
88497
88425
|
* @remarks
|
|
88498
|
-
* [Api set: WordApiOnline
|
|
88499
|
-
* @beta
|
|
88426
|
+
* [Api set: WordApiOnline 1.1]
|
|
88500
88427
|
*
|
|
88501
88428
|
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
88502
88429
|
*/
|
|
@@ -88545,8 +88472,7 @@ declare namespace Word {
|
|
|
88545
88472
|
* Insert a comment on the range.
|
|
88546
88473
|
*
|
|
88547
88474
|
* @remarks
|
|
88548
|
-
* [Api set: WordApiOnline
|
|
88549
|
-
* @beta
|
|
88475
|
+
* [Api set: WordApiOnline 1.1]
|
|
88550
88476
|
*
|
|
88551
88477
|
* @param commentText Required. The comment text to be inserted.
|
|
88552
88478
|
* @returns comment object
|
|
@@ -88563,8 +88489,7 @@ declare namespace Word {
|
|
|
88563
88489
|
* Inserts an endnote. The endnote reference is placed after the range.
|
|
88564
88490
|
*
|
|
88565
88491
|
* @remarks
|
|
88566
|
-
* [Api set: WordApiOnline
|
|
88567
|
-
* @beta
|
|
88492
|
+
* [Api set: WordApiOnline 1.1]
|
|
88568
88493
|
*
|
|
88569
88494
|
* @param insertText Optional. Text to be inserted into the endnote body. The default is "".
|
|
88570
88495
|
*/
|
|
@@ -88593,8 +88518,7 @@ declare namespace Word {
|
|
|
88593
88518
|
* Inserts a footnote. The footnote reference is placed after the range.
|
|
88594
88519
|
*
|
|
88595
88520
|
* @remarks
|
|
88596
|
-
* [Api set: WordApiOnline
|
|
88597
|
-
* @beta
|
|
88521
|
+
* [Api set: WordApiOnline 1.1]
|
|
88598
88522
|
*
|
|
88599
88523
|
* @param insertText Optional. Text to be inserted into the footnote body. The default is "".
|
|
88600
88524
|
*/
|
|
@@ -89327,8 +89251,7 @@ declare namespace Word {
|
|
|
89327
89251
|
* Gets the collection of endnotes in the table. Read-only.
|
|
89328
89252
|
*
|
|
89329
89253
|
* @remarks
|
|
89330
|
-
* [Api set: WordApiOnline
|
|
89331
|
-
* @beta
|
|
89254
|
+
* [Api set: WordApiOnline 1.1]
|
|
89332
89255
|
*/
|
|
89333
89256
|
readonly endnotes: Word.NoteItemCollection;
|
|
89334
89257
|
/**
|
|
@@ -89350,8 +89273,7 @@ declare namespace Word {
|
|
|
89350
89273
|
* Gets the collection of footnotes in the table. Read-only.
|
|
89351
89274
|
*
|
|
89352
89275
|
* @remarks
|
|
89353
|
-
* [Api set: WordApiOnline
|
|
89354
|
-
* @beta
|
|
89276
|
+
* [Api set: WordApiOnline 1.1]
|
|
89355
89277
|
*/
|
|
89356
89278
|
readonly footnotes: Word.NoteItemCollection;
|
|
89357
89279
|
/**
|
|
@@ -89984,8 +89906,7 @@ declare namespace Word {
|
|
|
89984
89906
|
* Gets the collection of endnotes in the table row. Read-only.
|
|
89985
89907
|
*
|
|
89986
89908
|
* @remarks
|
|
89987
|
-
* [Api set: WordApiOnline
|
|
89988
|
-
* @beta
|
|
89909
|
+
* [Api set: WordApiOnline 1.1]
|
|
89989
89910
|
*/
|
|
89990
89911
|
readonly endnotes: Word.NoteItemCollection;
|
|
89991
89912
|
/**
|
|
@@ -90007,8 +89928,7 @@ declare namespace Word {
|
|
|
90007
89928
|
* Gets the collection of footnotes in the table row. Read-only.
|
|
90008
89929
|
*
|
|
90009
89930
|
* @remarks
|
|
90010
|
-
* [Api set: WordApiOnline
|
|
90011
|
-
* @beta
|
|
89931
|
+
* [Api set: WordApiOnline 1.1]
|
|
90012
89932
|
*/
|
|
90013
89933
|
readonly footnotes: Word.NoteItemCollection;
|
|
90014
89934
|
/**
|
|
@@ -90734,29 +90654,25 @@ declare namespace Word {
|
|
|
90734
90654
|
* ChangeTracking mode.
|
|
90735
90655
|
*
|
|
90736
90656
|
* @remarks
|
|
90737
|
-
* [Api set: WordApiOnline
|
|
90738
|
-
* @beta
|
|
90657
|
+
* [Api set: WordApiOnline 1.1]
|
|
90739
90658
|
*/
|
|
90740
90659
|
enum ChangeTrackingMode {
|
|
90741
90660
|
/**
|
|
90742
90661
|
* ChangeTracking is turned off.
|
|
90743
90662
|
* @remarks
|
|
90744
|
-
* [Api set: WordApiOnline
|
|
90745
|
-
* @beta
|
|
90663
|
+
* [Api set: WordApiOnline 1.1]
|
|
90746
90664
|
*/
|
|
90747
90665
|
off = "Off",
|
|
90748
90666
|
/**
|
|
90749
90667
|
* ChangeTracking is turned on for everyone.
|
|
90750
90668
|
* @remarks
|
|
90751
|
-
* [Api set: WordApiOnline
|
|
90752
|
-
* @beta
|
|
90669
|
+
* [Api set: WordApiOnline 1.1]
|
|
90753
90670
|
*/
|
|
90754
90671
|
trackAll = "TrackAll",
|
|
90755
90672
|
/**
|
|
90756
90673
|
* Tracking is turned on for my changes only.
|
|
90757
90674
|
* @remarks
|
|
90758
|
-
* [Api set: WordApiOnline
|
|
90759
|
-
* @beta
|
|
90675
|
+
* [Api set: WordApiOnline 1.1]
|
|
90760
90676
|
*/
|
|
90761
90677
|
trackMineOnly = "TrackMineOnly",
|
|
90762
90678
|
}
|
|
@@ -90764,18 +90680,17 @@ declare namespace Word {
|
|
|
90764
90680
|
* Specify the current version or the original version of the text.
|
|
90765
90681
|
*
|
|
90766
90682
|
* @remarks
|
|
90767
|
-
* [Api set: WordApiOnline
|
|
90768
|
-
* @beta
|
|
90683
|
+
* [Api set: WordApiOnline 1.1]
|
|
90769
90684
|
*/
|
|
90770
90685
|
enum ChangeTrackingVersion {
|
|
90771
90686
|
/**
|
|
90772
90687
|
* @remarks
|
|
90773
|
-
* [Api set: WordApiOnline
|
|
90688
|
+
* [Api set: WordApiOnline 1.1]
|
|
90774
90689
|
*/
|
|
90775
90690
|
original = "Original",
|
|
90776
90691
|
/**
|
|
90777
90692
|
* @remarks
|
|
90778
|
-
* [Api set: WordApiOnline
|
|
90693
|
+
* [Api set: WordApiOnline 1.1]
|
|
90779
90694
|
*/
|
|
90780
90695
|
current = "Current",
|
|
90781
90696
|
}
|
|
@@ -90783,18 +90698,17 @@ declare namespace Word {
|
|
|
90783
90698
|
* Note item type
|
|
90784
90699
|
*
|
|
90785
90700
|
* @remarks
|
|
90786
|
-
* [Api set: WordApiOnline
|
|
90787
|
-
* @beta
|
|
90701
|
+
* [Api set: WordApiOnline 1.1]
|
|
90788
90702
|
*/
|
|
90789
90703
|
enum NoteItemType {
|
|
90790
90704
|
/**
|
|
90791
90705
|
* @remarks
|
|
90792
|
-
* [Api set: WordApiOnline
|
|
90706
|
+
* [Api set: WordApiOnline 1.1]
|
|
90793
90707
|
*/
|
|
90794
90708
|
footnote = "Footnote",
|
|
90795
90709
|
/**
|
|
90796
90710
|
* @remarks
|
|
90797
|
-
* [Api set: WordApiOnline
|
|
90711
|
+
* [Api set: WordApiOnline 1.1]
|
|
90798
90712
|
*/
|
|
90799
90713
|
endnote = "Endnote",
|
|
90800
90714
|
}
|
|
@@ -91323,17 +91237,17 @@ declare namespace Word {
|
|
|
91323
91237
|
tableCell = "TableCell",
|
|
91324
91238
|
/**
|
|
91325
91239
|
* @remarks
|
|
91326
|
-
* [Api set:
|
|
91240
|
+
* [Api set: WordApiOnline 1.1]
|
|
91327
91241
|
*/
|
|
91328
91242
|
footnote = "Footnote",
|
|
91329
91243
|
/**
|
|
91330
91244
|
* @remarks
|
|
91331
|
-
* [Api set:
|
|
91245
|
+
* [Api set: WordApiOnline 1.1]
|
|
91332
91246
|
*/
|
|
91333
91247
|
endnote = "Endnote",
|
|
91334
91248
|
/**
|
|
91335
91249
|
* @remarks
|
|
91336
|
-
* [Api set:
|
|
91250
|
+
* [Api set: WordApiOnline 1.1]
|
|
91337
91251
|
*/
|
|
91338
91252
|
noteItem = "NoteItem",
|
|
91339
91253
|
}
|
|
@@ -92733,27 +92647,24 @@ declare namespace Word {
|
|
|
92733
92647
|
/** An interface for updating data on the Comment object, for use in `comment.set({ ... })`. */
|
|
92734
92648
|
interface CommentUpdateData {
|
|
92735
92649
|
/**
|
|
92736
|
-
* Gets or sets the comment
|
|
92650
|
+
* Gets or sets the comment's content range.
|
|
92737
92651
|
*
|
|
92738
92652
|
* @remarks
|
|
92739
|
-
* [Api set: WordApiOnline
|
|
92740
|
-
* @beta
|
|
92653
|
+
* [Api set: WordApiOnline 1.1]
|
|
92741
92654
|
*/
|
|
92742
92655
|
contentRange?: Word.Interfaces.CommentContentRangeUpdateData;
|
|
92743
92656
|
/**
|
|
92744
92657
|
* Gets or sets the comment's content as plain text.
|
|
92745
92658
|
*
|
|
92746
92659
|
* @remarks
|
|
92747
|
-
* [Api set: WordApiOnline
|
|
92748
|
-
* @beta
|
|
92660
|
+
* [Api set: WordApiOnline 1.1]
|
|
92749
92661
|
*/
|
|
92750
92662
|
content?: string;
|
|
92751
92663
|
/**
|
|
92752
92664
|
* Gets or sets the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved.
|
|
92753
92665
|
*
|
|
92754
92666
|
* @remarks
|
|
92755
|
-
* [Api set: WordApiOnline
|
|
92756
|
-
* @beta
|
|
92667
|
+
* [Api set: WordApiOnline 1.1]
|
|
92757
92668
|
*/
|
|
92758
92669
|
resolved?: boolean;
|
|
92759
92670
|
}
|
|
@@ -92767,40 +92678,35 @@ declare namespace Word {
|
|
|
92767
92678
|
* Gets or sets a value that indicates whether the comment text is bold.
|
|
92768
92679
|
*
|
|
92769
92680
|
* @remarks
|
|
92770
|
-
* [Api set: WordApiOnline
|
|
92771
|
-
* @beta
|
|
92681
|
+
* [Api set: WordApiOnline 1.1]
|
|
92772
92682
|
*/
|
|
92773
92683
|
bold?: boolean;
|
|
92774
92684
|
/**
|
|
92775
92685
|
* Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range.
|
|
92776
92686
|
*
|
|
92777
92687
|
* @remarks
|
|
92778
|
-
* [Api set: WordApiOnline
|
|
92779
|
-
* @beta
|
|
92688
|
+
* [Api set: WordApiOnline 1.1]
|
|
92780
92689
|
*/
|
|
92781
92690
|
hyperlink?: string;
|
|
92782
92691
|
/**
|
|
92783
92692
|
* Gets or sets a value that indicates whether the comment text is italicized.
|
|
92784
92693
|
*
|
|
92785
92694
|
* @remarks
|
|
92786
|
-
* [Api set: WordApiOnline
|
|
92787
|
-
* @beta
|
|
92695
|
+
* [Api set: WordApiOnline 1.1]
|
|
92788
92696
|
*/
|
|
92789
92697
|
italic?: boolean;
|
|
92790
92698
|
/**
|
|
92791
92699
|
* Gets or sets a value that indicates whether the comment text has a strikethrough.
|
|
92792
92700
|
*
|
|
92793
92701
|
* @remarks
|
|
92794
|
-
* [Api set: WordApiOnline
|
|
92795
|
-
* @beta
|
|
92702
|
+
* [Api set: WordApiOnline 1.1]
|
|
92796
92703
|
*/
|
|
92797
92704
|
strikeThrough?: boolean;
|
|
92798
92705
|
/**
|
|
92799
92706
|
* Gets or sets a value that indicates the comment text's underline type. 'None' if the comment text is not underlined.
|
|
92800
92707
|
*
|
|
92801
92708
|
* @remarks
|
|
92802
|
-
* [Api set: WordApiOnline
|
|
92803
|
-
* @beta
|
|
92709
|
+
* [Api set: WordApiOnline 1.1]
|
|
92804
92710
|
*/
|
|
92805
92711
|
underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble";
|
|
92806
92712
|
}
|
|
@@ -92810,24 +92716,21 @@ declare namespace Word {
|
|
|
92810
92716
|
* Gets or sets the commentReply's content range.
|
|
92811
92717
|
*
|
|
92812
92718
|
* @remarks
|
|
92813
|
-
* [Api set: WordApiOnline
|
|
92814
|
-
* @beta
|
|
92719
|
+
* [Api set: WordApiOnline 1.1]
|
|
92815
92720
|
*/
|
|
92816
92721
|
contentRange?: Word.Interfaces.CommentContentRangeUpdateData;
|
|
92817
92722
|
/**
|
|
92818
92723
|
* Gets the parent comment of this reply.
|
|
92819
92724
|
*
|
|
92820
92725
|
* @remarks
|
|
92821
|
-
* [Api set: WordApiOnline
|
|
92822
|
-
* @beta
|
|
92726
|
+
* [Api set: WordApiOnline 1.1]
|
|
92823
92727
|
*/
|
|
92824
92728
|
parentComment?: Word.Interfaces.CommentUpdateData;
|
|
92825
92729
|
/**
|
|
92826
92730
|
* Gets or sets the comment reply's content. The string is plain text.
|
|
92827
92731
|
*
|
|
92828
92732
|
* @remarks
|
|
92829
|
-
* [Api set: WordApiOnline
|
|
92830
|
-
* @beta
|
|
92733
|
+
* [Api set: WordApiOnline 1.1]
|
|
92831
92734
|
*/
|
|
92832
92735
|
content?: string;
|
|
92833
92736
|
}
|
|
@@ -92962,8 +92865,7 @@ declare namespace Word {
|
|
|
92962
92865
|
* Gets or sets the ChangeTracking mode.
|
|
92963
92866
|
*
|
|
92964
92867
|
* @remarks
|
|
92965
|
-
* [Api set: WordApiOnline
|
|
92966
|
-
* @beta
|
|
92868
|
+
* [Api set: WordApiOnline 1.1]
|
|
92967
92869
|
*/
|
|
92968
92870
|
changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly";
|
|
92969
92871
|
}
|
|
@@ -93201,19 +93103,17 @@ declare namespace Word {
|
|
|
93201
93103
|
/** An interface for updating data on the NoteItem object, for use in `noteItem.set({ ... })`. */
|
|
93202
93104
|
interface NoteItemUpdateData {
|
|
93203
93105
|
/**
|
|
93204
|
-
* Represents the body object of the note item. It
|
|
93106
|
+
* Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
|
|
93205
93107
|
*
|
|
93206
93108
|
* @remarks
|
|
93207
|
-
* [Api set: WordApiOnline
|
|
93208
|
-
* @beta
|
|
93109
|
+
* [Api set: WordApiOnline 1.1]
|
|
93209
93110
|
*/
|
|
93210
93111
|
body?: Word.Interfaces.BodyUpdateData;
|
|
93211
93112
|
/**
|
|
93212
93113
|
* Represents a footnote or endnote reference in the main document.
|
|
93213
93114
|
*
|
|
93214
93115
|
* @remarks
|
|
93215
|
-
* [Api set: WordApiOnline
|
|
93216
|
-
* @beta
|
|
93116
|
+
* [Api set: WordApiOnline 1.1]
|
|
93217
93117
|
*/
|
|
93218
93118
|
reference?: Word.Interfaces.RangeUpdateData;
|
|
93219
93119
|
}
|
|
@@ -93767,67 +93667,59 @@ declare namespace Word {
|
|
|
93767
93667
|
/** An interface describing the data returned by calling `comment.toJSON()`. */
|
|
93768
93668
|
interface CommentData {
|
|
93769
93669
|
/**
|
|
93770
|
-
* Gets or sets the comment
|
|
93670
|
+
* Gets or sets the comment's content range.
|
|
93771
93671
|
*
|
|
93772
93672
|
* @remarks
|
|
93773
|
-
* [Api set: WordApiOnline
|
|
93774
|
-
* @beta
|
|
93673
|
+
* [Api set: WordApiOnline 1.1]
|
|
93775
93674
|
*/
|
|
93776
93675
|
contentRange?: Word.Interfaces.CommentContentRangeData;
|
|
93777
93676
|
/**
|
|
93778
93677
|
* Gets the collection of reply objects associated with the comment.
|
|
93779
93678
|
*
|
|
93780
93679
|
* @remarks
|
|
93781
|
-
* [Api set: WordApiOnline
|
|
93782
|
-
* @beta
|
|
93680
|
+
* [Api set: WordApiOnline 1.1]
|
|
93783
93681
|
*/
|
|
93784
93682
|
replies?: Word.Interfaces.CommentReplyData[];
|
|
93785
93683
|
/**
|
|
93786
93684
|
* Gets the email of the comment's author.
|
|
93787
93685
|
*
|
|
93788
93686
|
* @remarks
|
|
93789
|
-
* [Api set: WordApiOnline
|
|
93790
|
-
* @beta
|
|
93687
|
+
* [Api set: WordApiOnline 1.1]
|
|
93791
93688
|
*/
|
|
93792
93689
|
authorEmail?: string;
|
|
93793
93690
|
/**
|
|
93794
93691
|
* Gets the name of the comment's author.
|
|
93795
93692
|
*
|
|
93796
93693
|
* @remarks
|
|
93797
|
-
* [Api set: WordApiOnline
|
|
93798
|
-
* @beta
|
|
93694
|
+
* [Api set: WordApiOnline 1.1]
|
|
93799
93695
|
*/
|
|
93800
93696
|
authorName?: string;
|
|
93801
93697
|
/**
|
|
93802
93698
|
* Gets or sets the comment's content as plain text.
|
|
93803
93699
|
*
|
|
93804
93700
|
* @remarks
|
|
93805
|
-
* [Api set: WordApiOnline
|
|
93806
|
-
* @beta
|
|
93701
|
+
* [Api set: WordApiOnline 1.1]
|
|
93807
93702
|
*/
|
|
93808
93703
|
content?: string;
|
|
93809
93704
|
/**
|
|
93810
93705
|
* Gets the creation date of the comment.
|
|
93811
93706
|
*
|
|
93812
93707
|
* @remarks
|
|
93813
|
-
* [Api set: WordApiOnline
|
|
93814
|
-
* @beta
|
|
93708
|
+
* [Api set: WordApiOnline 1.1]
|
|
93815
93709
|
*/
|
|
93816
93710
|
creationDate?: Date;
|
|
93817
93711
|
/**
|
|
93818
93712
|
* Gets the ID of the comment. Read-only.
|
|
93819
93713
|
*
|
|
93820
93714
|
* @remarks
|
|
93821
|
-
* [Api set: WordApiOnline
|
|
93822
|
-
* @beta
|
|
93715
|
+
* [Api set: WordApiOnline 1.1]
|
|
93823
93716
|
*/
|
|
93824
93717
|
id?: string;
|
|
93825
93718
|
/**
|
|
93826
93719
|
* Gets or sets the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved.
|
|
93827
93720
|
*
|
|
93828
93721
|
* @remarks
|
|
93829
|
-
* [Api set: WordApiOnline
|
|
93830
|
-
* @beta
|
|
93722
|
+
* [Api set: WordApiOnline 1.1]
|
|
93831
93723
|
*/
|
|
93832
93724
|
resolved?: boolean;
|
|
93833
93725
|
}
|
|
@@ -93841,56 +93733,49 @@ declare namespace Word {
|
|
|
93841
93733
|
* Gets or sets a value that indicates whether the comment text is bold.
|
|
93842
93734
|
*
|
|
93843
93735
|
* @remarks
|
|
93844
|
-
* [Api set: WordApiOnline
|
|
93845
|
-
* @beta
|
|
93736
|
+
* [Api set: WordApiOnline 1.1]
|
|
93846
93737
|
*/
|
|
93847
93738
|
bold?: boolean;
|
|
93848
93739
|
/**
|
|
93849
93740
|
* Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range.
|
|
93850
93741
|
*
|
|
93851
93742
|
* @remarks
|
|
93852
|
-
* [Api set: WordApiOnline
|
|
93853
|
-
* @beta
|
|
93743
|
+
* [Api set: WordApiOnline 1.1]
|
|
93854
93744
|
*/
|
|
93855
93745
|
hyperlink?: string;
|
|
93856
93746
|
/**
|
|
93857
93747
|
* Checks whether the range length is zero. Read-only.
|
|
93858
93748
|
*
|
|
93859
93749
|
* @remarks
|
|
93860
|
-
* [Api set: WordApiOnline
|
|
93861
|
-
* @beta
|
|
93750
|
+
* [Api set: WordApiOnline 1.1]
|
|
93862
93751
|
*/
|
|
93863
93752
|
isEmpty?: boolean;
|
|
93864
93753
|
/**
|
|
93865
93754
|
* Gets or sets a value that indicates whether the comment text is italicized.
|
|
93866
93755
|
*
|
|
93867
93756
|
* @remarks
|
|
93868
|
-
* [Api set: WordApiOnline
|
|
93869
|
-
* @beta
|
|
93757
|
+
* [Api set: WordApiOnline 1.1]
|
|
93870
93758
|
*/
|
|
93871
93759
|
italic?: boolean;
|
|
93872
93760
|
/**
|
|
93873
93761
|
* Gets or sets a value that indicates whether the comment text has a strikethrough.
|
|
93874
93762
|
*
|
|
93875
93763
|
* @remarks
|
|
93876
|
-
* [Api set: WordApiOnline
|
|
93877
|
-
* @beta
|
|
93764
|
+
* [Api set: WordApiOnline 1.1]
|
|
93878
93765
|
*/
|
|
93879
93766
|
strikeThrough?: boolean;
|
|
93880
93767
|
/**
|
|
93881
93768
|
* Gets the text of the comment range. Read-only.
|
|
93882
93769
|
*
|
|
93883
93770
|
* @remarks
|
|
93884
|
-
* [Api set: WordApiOnline
|
|
93885
|
-
* @beta
|
|
93771
|
+
* [Api set: WordApiOnline 1.1]
|
|
93886
93772
|
*/
|
|
93887
93773
|
text?: string;
|
|
93888
93774
|
/**
|
|
93889
93775
|
* Gets or sets a value that indicates the comment text's underline type. 'None' if the comment text is not underlined.
|
|
93890
93776
|
*
|
|
93891
93777
|
* @remarks
|
|
93892
|
-
* [Api set: WordApiOnline
|
|
93893
|
-
* @beta
|
|
93778
|
+
* [Api set: WordApiOnline 1.1]
|
|
93894
93779
|
*/
|
|
93895
93780
|
underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble";
|
|
93896
93781
|
}
|
|
@@ -93900,56 +93785,49 @@ declare namespace Word {
|
|
|
93900
93785
|
* Gets or sets the commentReply's content range.
|
|
93901
93786
|
*
|
|
93902
93787
|
* @remarks
|
|
93903
|
-
* [Api set: WordApiOnline
|
|
93904
|
-
* @beta
|
|
93788
|
+
* [Api set: WordApiOnline 1.1]
|
|
93905
93789
|
*/
|
|
93906
93790
|
contentRange?: Word.Interfaces.CommentContentRangeData;
|
|
93907
93791
|
/**
|
|
93908
93792
|
* Gets the parent comment of this reply.
|
|
93909
93793
|
*
|
|
93910
93794
|
* @remarks
|
|
93911
|
-
* [Api set: WordApiOnline
|
|
93912
|
-
* @beta
|
|
93795
|
+
* [Api set: WordApiOnline 1.1]
|
|
93913
93796
|
*/
|
|
93914
93797
|
parentComment?: Word.Interfaces.CommentData;
|
|
93915
93798
|
/**
|
|
93916
93799
|
* Gets the email of the comment reply's author.
|
|
93917
93800
|
*
|
|
93918
93801
|
* @remarks
|
|
93919
|
-
* [Api set: WordApiOnline
|
|
93920
|
-
* @beta
|
|
93802
|
+
* [Api set: WordApiOnline 1.1]
|
|
93921
93803
|
*/
|
|
93922
93804
|
authorEmail?: string;
|
|
93923
93805
|
/**
|
|
93924
93806
|
* Gets the name of the comment reply's author.
|
|
93925
93807
|
*
|
|
93926
93808
|
* @remarks
|
|
93927
|
-
* [Api set: WordApiOnline
|
|
93928
|
-
* @beta
|
|
93809
|
+
* [Api set: WordApiOnline 1.1]
|
|
93929
93810
|
*/
|
|
93930
93811
|
authorName?: string;
|
|
93931
93812
|
/**
|
|
93932
93813
|
* Gets or sets the comment reply's content. The string is plain text.
|
|
93933
93814
|
*
|
|
93934
93815
|
* @remarks
|
|
93935
|
-
* [Api set: WordApiOnline
|
|
93936
|
-
* @beta
|
|
93816
|
+
* [Api set: WordApiOnline 1.1]
|
|
93937
93817
|
*/
|
|
93938
93818
|
content?: string;
|
|
93939
93819
|
/**
|
|
93940
93820
|
* Gets the creation date of the comment reply.
|
|
93941
93821
|
*
|
|
93942
93822
|
* @remarks
|
|
93943
|
-
* [Api set: WordApiOnline
|
|
93944
|
-
* @beta
|
|
93823
|
+
* [Api set: WordApiOnline 1.1]
|
|
93945
93824
|
*/
|
|
93946
93825
|
creationDate?: Date;
|
|
93947
93826
|
/**
|
|
93948
93827
|
* Gets the ID of the comment reply. Read-only.
|
|
93949
93828
|
*
|
|
93950
93829
|
* @remarks
|
|
93951
|
-
* [Api set: WordApiOnline
|
|
93952
|
-
* @beta
|
|
93830
|
+
* [Api set: WordApiOnline 1.1]
|
|
93953
93831
|
*/
|
|
93954
93832
|
id?: string;
|
|
93955
93833
|
}
|
|
@@ -94218,8 +94096,7 @@ declare namespace Word {
|
|
|
94218
94096
|
* Gets or sets the ChangeTracking mode.
|
|
94219
94097
|
*
|
|
94220
94098
|
* @remarks
|
|
94221
|
-
* [Api set: WordApiOnline
|
|
94222
|
-
* @beta
|
|
94099
|
+
* [Api set: WordApiOnline 1.1]
|
|
94223
94100
|
*/
|
|
94224
94101
|
changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly";
|
|
94225
94102
|
/**
|
|
@@ -94636,27 +94513,24 @@ declare namespace Word {
|
|
|
94636
94513
|
/** An interface describing the data returned by calling `noteItem.toJSON()`. */
|
|
94637
94514
|
interface NoteItemData {
|
|
94638
94515
|
/**
|
|
94639
|
-
* Represents the body object of the note item. It
|
|
94516
|
+
* Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
|
|
94640
94517
|
*
|
|
94641
94518
|
* @remarks
|
|
94642
|
-
* [Api set: WordApiOnline
|
|
94643
|
-
* @beta
|
|
94519
|
+
* [Api set: WordApiOnline 1.1]
|
|
94644
94520
|
*/
|
|
94645
94521
|
body?: Word.Interfaces.BodyData;
|
|
94646
94522
|
/**
|
|
94647
94523
|
* Represents a footnote or endnote reference in the main document.
|
|
94648
94524
|
*
|
|
94649
94525
|
* @remarks
|
|
94650
|
-
* [Api set: WordApiOnline
|
|
94651
|
-
* @beta
|
|
94526
|
+
* [Api set: WordApiOnline 1.1]
|
|
94652
94527
|
*/
|
|
94653
94528
|
reference?: Word.Interfaces.RangeData;
|
|
94654
94529
|
/**
|
|
94655
94530
|
* Represents the note item type: footnote or endnote.
|
|
94656
94531
|
*
|
|
94657
94532
|
* @remarks
|
|
94658
|
-
* [Api set: WordApiOnline
|
|
94659
|
-
* @beta
|
|
94533
|
+
* [Api set: WordApiOnline 1.1]
|
|
94660
94534
|
*/
|
|
94661
94535
|
type?: Word.NoteItemType | "Footnote" | "Endnote";
|
|
94662
94536
|
}
|
|
@@ -95399,8 +95273,7 @@ declare namespace Word {
|
|
|
95399
95273
|
* Represents a comment in the document.
|
|
95400
95274
|
*
|
|
95401
95275
|
* @remarks
|
|
95402
|
-
* [Api set: WordApiOnline
|
|
95403
|
-
* @beta
|
|
95276
|
+
* [Api set: WordApiOnline 1.1]
|
|
95404
95277
|
*/
|
|
95405
95278
|
interface CommentLoadOptions {
|
|
95406
95279
|
/**
|
|
@@ -95408,59 +95281,52 @@ declare namespace Word {
|
|
|
95408
95281
|
*/
|
|
95409
95282
|
$all?: boolean;
|
|
95410
95283
|
/**
|
|
95411
|
-
* Gets or sets the comment
|
|
95284
|
+
* Gets or sets the comment's content range.
|
|
95412
95285
|
*
|
|
95413
95286
|
* @remarks
|
|
95414
|
-
* [Api set: WordApiOnline
|
|
95415
|
-
* @beta
|
|
95287
|
+
* [Api set: WordApiOnline 1.1]
|
|
95416
95288
|
*/
|
|
95417
95289
|
contentRange?: Word.Interfaces.CommentContentRangeLoadOptions;
|
|
95418
95290
|
/**
|
|
95419
95291
|
* Gets the email of the comment's author.
|
|
95420
95292
|
*
|
|
95421
95293
|
* @remarks
|
|
95422
|
-
* [Api set: WordApiOnline
|
|
95423
|
-
* @beta
|
|
95294
|
+
* [Api set: WordApiOnline 1.1]
|
|
95424
95295
|
*/
|
|
95425
95296
|
authorEmail?: boolean;
|
|
95426
95297
|
/**
|
|
95427
95298
|
* Gets the name of the comment's author.
|
|
95428
95299
|
*
|
|
95429
95300
|
* @remarks
|
|
95430
|
-
* [Api set: WordApiOnline
|
|
95431
|
-
* @beta
|
|
95301
|
+
* [Api set: WordApiOnline 1.1]
|
|
95432
95302
|
*/
|
|
95433
95303
|
authorName?: boolean;
|
|
95434
95304
|
/**
|
|
95435
95305
|
* Gets or sets the comment's content as plain text.
|
|
95436
95306
|
*
|
|
95437
95307
|
* @remarks
|
|
95438
|
-
* [Api set: WordApiOnline
|
|
95439
|
-
* @beta
|
|
95308
|
+
* [Api set: WordApiOnline 1.1]
|
|
95440
95309
|
*/
|
|
95441
95310
|
content?: boolean;
|
|
95442
95311
|
/**
|
|
95443
95312
|
* Gets the creation date of the comment.
|
|
95444
95313
|
*
|
|
95445
95314
|
* @remarks
|
|
95446
|
-
* [Api set: WordApiOnline
|
|
95447
|
-
* @beta
|
|
95315
|
+
* [Api set: WordApiOnline 1.1]
|
|
95448
95316
|
*/
|
|
95449
95317
|
creationDate?: boolean;
|
|
95450
95318
|
/**
|
|
95451
95319
|
* Gets the ID of the comment. Read-only.
|
|
95452
95320
|
*
|
|
95453
95321
|
* @remarks
|
|
95454
|
-
* [Api set: WordApiOnline
|
|
95455
|
-
* @beta
|
|
95322
|
+
* [Api set: WordApiOnline 1.1]
|
|
95456
95323
|
*/
|
|
95457
95324
|
id?: boolean;
|
|
95458
95325
|
/**
|
|
95459
95326
|
* Gets or sets the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved.
|
|
95460
95327
|
*
|
|
95461
95328
|
* @remarks
|
|
95462
|
-
* [Api set: WordApiOnline
|
|
95463
|
-
* @beta
|
|
95329
|
+
* [Api set: WordApiOnline 1.1]
|
|
95464
95330
|
*/
|
|
95465
95331
|
resolved?: boolean;
|
|
95466
95332
|
}
|
|
@@ -95468,8 +95334,7 @@ declare namespace Word {
|
|
|
95468
95334
|
* Contains a collection of {@link Word.Comment} objects.
|
|
95469
95335
|
*
|
|
95470
95336
|
* @remarks
|
|
95471
|
-
* [Api set: WordApiOnline
|
|
95472
|
-
* @beta
|
|
95337
|
+
* [Api set: WordApiOnline 1.1]
|
|
95473
95338
|
*/
|
|
95474
95339
|
interface CommentCollectionLoadOptions {
|
|
95475
95340
|
/**
|
|
@@ -95477,66 +95342,58 @@ declare namespace Word {
|
|
|
95477
95342
|
*/
|
|
95478
95343
|
$all?: boolean;
|
|
95479
95344
|
/**
|
|
95480
|
-
* For EACH ITEM in the collection: Gets or sets the comment
|
|
95345
|
+
* For EACH ITEM in the collection: Gets or sets the comment's content range.
|
|
95481
95346
|
*
|
|
95482
95347
|
* @remarks
|
|
95483
|
-
* [Api set: WordApiOnline
|
|
95484
|
-
* @beta
|
|
95348
|
+
* [Api set: WordApiOnline 1.1]
|
|
95485
95349
|
*/
|
|
95486
95350
|
contentRange?: Word.Interfaces.CommentContentRangeLoadOptions;
|
|
95487
95351
|
/**
|
|
95488
95352
|
* For EACH ITEM in the collection: Gets the email of the comment's author.
|
|
95489
95353
|
*
|
|
95490
95354
|
* @remarks
|
|
95491
|
-
* [Api set: WordApiOnline
|
|
95492
|
-
* @beta
|
|
95355
|
+
* [Api set: WordApiOnline 1.1]
|
|
95493
95356
|
*/
|
|
95494
95357
|
authorEmail?: boolean;
|
|
95495
95358
|
/**
|
|
95496
95359
|
* For EACH ITEM in the collection: Gets the name of the comment's author.
|
|
95497
95360
|
*
|
|
95498
95361
|
* @remarks
|
|
95499
|
-
* [Api set: WordApiOnline
|
|
95500
|
-
* @beta
|
|
95362
|
+
* [Api set: WordApiOnline 1.1]
|
|
95501
95363
|
*/
|
|
95502
95364
|
authorName?: boolean;
|
|
95503
95365
|
/**
|
|
95504
95366
|
* For EACH ITEM in the collection: Gets or sets the comment's content as plain text.
|
|
95505
95367
|
*
|
|
95506
95368
|
* @remarks
|
|
95507
|
-
* [Api set: WordApiOnline
|
|
95508
|
-
* @beta
|
|
95369
|
+
* [Api set: WordApiOnline 1.1]
|
|
95509
95370
|
*/
|
|
95510
95371
|
content?: boolean;
|
|
95511
95372
|
/**
|
|
95512
95373
|
* For EACH ITEM in the collection: Gets the creation date of the comment.
|
|
95513
95374
|
*
|
|
95514
95375
|
* @remarks
|
|
95515
|
-
* [Api set: WordApiOnline
|
|
95516
|
-
* @beta
|
|
95376
|
+
* [Api set: WordApiOnline 1.1]
|
|
95517
95377
|
*/
|
|
95518
95378
|
creationDate?: boolean;
|
|
95519
95379
|
/**
|
|
95520
95380
|
* For EACH ITEM in the collection: Gets the ID of the comment. Read-only.
|
|
95521
95381
|
*
|
|
95522
95382
|
* @remarks
|
|
95523
|
-
* [Api set: WordApiOnline
|
|
95524
|
-
* @beta
|
|
95383
|
+
* [Api set: WordApiOnline 1.1]
|
|
95525
95384
|
*/
|
|
95526
95385
|
id?: boolean;
|
|
95527
95386
|
/**
|
|
95528
95387
|
* For EACH ITEM in the collection: Gets or sets the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved.
|
|
95529
95388
|
*
|
|
95530
95389
|
* @remarks
|
|
95531
|
-
* [Api set: WordApiOnline
|
|
95532
|
-
* @beta
|
|
95390
|
+
* [Api set: WordApiOnline 1.1]
|
|
95533
95391
|
*/
|
|
95534
95392
|
resolved?: boolean;
|
|
95535
95393
|
}
|
|
95536
95394
|
/**
|
|
95537
95395
|
* @remarks
|
|
95538
|
-
* [Api set: WordApiOnline
|
|
95539
|
-
* @beta
|
|
95396
|
+
* [Api set: WordApiOnline 1.1]
|
|
95540
95397
|
*/
|
|
95541
95398
|
interface CommentContentRangeLoadOptions {
|
|
95542
95399
|
/**
|
|
@@ -95547,56 +95404,49 @@ declare namespace Word {
|
|
|
95547
95404
|
* Gets or sets a value that indicates whether the comment text is bold.
|
|
95548
95405
|
*
|
|
95549
95406
|
* @remarks
|
|
95550
|
-
* [Api set: WordApiOnline
|
|
95551
|
-
* @beta
|
|
95407
|
+
* [Api set: WordApiOnline 1.1]
|
|
95552
95408
|
*/
|
|
95553
95409
|
bold?: boolean;
|
|
95554
95410
|
/**
|
|
95555
95411
|
* Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range.
|
|
95556
95412
|
*
|
|
95557
95413
|
* @remarks
|
|
95558
|
-
* [Api set: WordApiOnline
|
|
95559
|
-
* @beta
|
|
95414
|
+
* [Api set: WordApiOnline 1.1]
|
|
95560
95415
|
*/
|
|
95561
95416
|
hyperlink?: boolean;
|
|
95562
95417
|
/**
|
|
95563
95418
|
* Checks whether the range length is zero. Read-only.
|
|
95564
95419
|
*
|
|
95565
95420
|
* @remarks
|
|
95566
|
-
* [Api set: WordApiOnline
|
|
95567
|
-
* @beta
|
|
95421
|
+
* [Api set: WordApiOnline 1.1]
|
|
95568
95422
|
*/
|
|
95569
95423
|
isEmpty?: boolean;
|
|
95570
95424
|
/**
|
|
95571
95425
|
* Gets or sets a value that indicates whether the comment text is italicized.
|
|
95572
95426
|
*
|
|
95573
95427
|
* @remarks
|
|
95574
|
-
* [Api set: WordApiOnline
|
|
95575
|
-
* @beta
|
|
95428
|
+
* [Api set: WordApiOnline 1.1]
|
|
95576
95429
|
*/
|
|
95577
95430
|
italic?: boolean;
|
|
95578
95431
|
/**
|
|
95579
95432
|
* Gets or sets a value that indicates whether the comment text has a strikethrough.
|
|
95580
95433
|
*
|
|
95581
95434
|
* @remarks
|
|
95582
|
-
* [Api set: WordApiOnline
|
|
95583
|
-
* @beta
|
|
95435
|
+
* [Api set: WordApiOnline 1.1]
|
|
95584
95436
|
*/
|
|
95585
95437
|
strikeThrough?: boolean;
|
|
95586
95438
|
/**
|
|
95587
95439
|
* Gets the text of the comment range. Read-only.
|
|
95588
95440
|
*
|
|
95589
95441
|
* @remarks
|
|
95590
|
-
* [Api set: WordApiOnline
|
|
95591
|
-
* @beta
|
|
95442
|
+
* [Api set: WordApiOnline 1.1]
|
|
95592
95443
|
*/
|
|
95593
95444
|
text?: boolean;
|
|
95594
95445
|
/**
|
|
95595
95446
|
* Gets or sets a value that indicates the comment text's underline type. 'None' if the comment text is not underlined.
|
|
95596
95447
|
*
|
|
95597
95448
|
* @remarks
|
|
95598
|
-
* [Api set: WordApiOnline
|
|
95599
|
-
* @beta
|
|
95449
|
+
* [Api set: WordApiOnline 1.1]
|
|
95600
95450
|
*/
|
|
95601
95451
|
underline?: boolean;
|
|
95602
95452
|
}
|
|
@@ -95604,8 +95454,7 @@ declare namespace Word {
|
|
|
95604
95454
|
* Represents a comment reply in the document.
|
|
95605
95455
|
*
|
|
95606
95456
|
* @remarks
|
|
95607
|
-
* [Api set: WordApiOnline
|
|
95608
|
-
* @beta
|
|
95457
|
+
* [Api set: WordApiOnline 1.1]
|
|
95609
95458
|
*/
|
|
95610
95459
|
interface CommentReplyLoadOptions {
|
|
95611
95460
|
/**
|
|
@@ -95616,56 +95465,49 @@ declare namespace Word {
|
|
|
95616
95465
|
* Gets or sets the commentReply's content range.
|
|
95617
95466
|
*
|
|
95618
95467
|
* @remarks
|
|
95619
|
-
* [Api set: WordApiOnline
|
|
95620
|
-
* @beta
|
|
95468
|
+
* [Api set: WordApiOnline 1.1]
|
|
95621
95469
|
*/
|
|
95622
95470
|
contentRange?: Word.Interfaces.CommentContentRangeLoadOptions;
|
|
95623
95471
|
/**
|
|
95624
95472
|
* Gets the parent comment of this reply.
|
|
95625
95473
|
*
|
|
95626
95474
|
* @remarks
|
|
95627
|
-
* [Api set: WordApiOnline
|
|
95628
|
-
* @beta
|
|
95475
|
+
* [Api set: WordApiOnline 1.1]
|
|
95629
95476
|
*/
|
|
95630
95477
|
parentComment?: Word.Interfaces.CommentLoadOptions;
|
|
95631
95478
|
/**
|
|
95632
95479
|
* Gets the email of the comment reply's author.
|
|
95633
95480
|
*
|
|
95634
95481
|
* @remarks
|
|
95635
|
-
* [Api set: WordApiOnline
|
|
95636
|
-
* @beta
|
|
95482
|
+
* [Api set: WordApiOnline 1.1]
|
|
95637
95483
|
*/
|
|
95638
95484
|
authorEmail?: boolean;
|
|
95639
95485
|
/**
|
|
95640
95486
|
* Gets the name of the comment reply's author.
|
|
95641
95487
|
*
|
|
95642
95488
|
* @remarks
|
|
95643
|
-
* [Api set: WordApiOnline
|
|
95644
|
-
* @beta
|
|
95489
|
+
* [Api set: WordApiOnline 1.1]
|
|
95645
95490
|
*/
|
|
95646
95491
|
authorName?: boolean;
|
|
95647
95492
|
/**
|
|
95648
95493
|
* Gets or sets the comment reply's content. The string is plain text.
|
|
95649
95494
|
*
|
|
95650
95495
|
* @remarks
|
|
95651
|
-
* [Api set: WordApiOnline
|
|
95652
|
-
* @beta
|
|
95496
|
+
* [Api set: WordApiOnline 1.1]
|
|
95653
95497
|
*/
|
|
95654
95498
|
content?: boolean;
|
|
95655
95499
|
/**
|
|
95656
95500
|
* Gets the creation date of the comment reply.
|
|
95657
95501
|
*
|
|
95658
95502
|
* @remarks
|
|
95659
|
-
* [Api set: WordApiOnline
|
|
95660
|
-
* @beta
|
|
95503
|
+
* [Api set: WordApiOnline 1.1]
|
|
95661
95504
|
*/
|
|
95662
95505
|
creationDate?: boolean;
|
|
95663
95506
|
/**
|
|
95664
95507
|
* Gets the ID of the comment reply. Read-only.
|
|
95665
95508
|
*
|
|
95666
95509
|
* @remarks
|
|
95667
|
-
* [Api set: WordApiOnline
|
|
95668
|
-
* @beta
|
|
95510
|
+
* [Api set: WordApiOnline 1.1]
|
|
95669
95511
|
*/
|
|
95670
95512
|
id?: boolean;
|
|
95671
95513
|
}
|
|
@@ -95673,8 +95515,7 @@ declare namespace Word {
|
|
|
95673
95515
|
* Contains a collection of {@link Word.CommentReply} objects. Represents all comment replies in one comment thread.
|
|
95674
95516
|
*
|
|
95675
95517
|
* @remarks
|
|
95676
|
-
* [Api set: WordApiOnline
|
|
95677
|
-
* @beta
|
|
95518
|
+
* [Api set: WordApiOnline 1.1]
|
|
95678
95519
|
*/
|
|
95679
95520
|
interface CommentReplyCollectionLoadOptions {
|
|
95680
95521
|
/**
|
|
@@ -95685,56 +95526,49 @@ declare namespace Word {
|
|
|
95685
95526
|
* For EACH ITEM in the collection: Gets or sets the commentReply's content range.
|
|
95686
95527
|
*
|
|
95687
95528
|
* @remarks
|
|
95688
|
-
* [Api set: WordApiOnline
|
|
95689
|
-
* @beta
|
|
95529
|
+
* [Api set: WordApiOnline 1.1]
|
|
95690
95530
|
*/
|
|
95691
95531
|
contentRange?: Word.Interfaces.CommentContentRangeLoadOptions;
|
|
95692
95532
|
/**
|
|
95693
95533
|
* For EACH ITEM in the collection: Gets the parent comment of this reply.
|
|
95694
95534
|
*
|
|
95695
95535
|
* @remarks
|
|
95696
|
-
* [Api set: WordApiOnline
|
|
95697
|
-
* @beta
|
|
95536
|
+
* [Api set: WordApiOnline 1.1]
|
|
95698
95537
|
*/
|
|
95699
95538
|
parentComment?: Word.Interfaces.CommentLoadOptions;
|
|
95700
95539
|
/**
|
|
95701
95540
|
* For EACH ITEM in the collection: Gets the email of the comment reply's author.
|
|
95702
95541
|
*
|
|
95703
95542
|
* @remarks
|
|
95704
|
-
* [Api set: WordApiOnline
|
|
95705
|
-
* @beta
|
|
95543
|
+
* [Api set: WordApiOnline 1.1]
|
|
95706
95544
|
*/
|
|
95707
95545
|
authorEmail?: boolean;
|
|
95708
95546
|
/**
|
|
95709
95547
|
* For EACH ITEM in the collection: Gets the name of the comment reply's author.
|
|
95710
95548
|
*
|
|
95711
95549
|
* @remarks
|
|
95712
|
-
* [Api set: WordApiOnline
|
|
95713
|
-
* @beta
|
|
95550
|
+
* [Api set: WordApiOnline 1.1]
|
|
95714
95551
|
*/
|
|
95715
95552
|
authorName?: boolean;
|
|
95716
95553
|
/**
|
|
95717
95554
|
* For EACH ITEM in the collection: Gets or sets the comment reply's content. The string is plain text.
|
|
95718
95555
|
*
|
|
95719
95556
|
* @remarks
|
|
95720
|
-
* [Api set: WordApiOnline
|
|
95721
|
-
* @beta
|
|
95557
|
+
* [Api set: WordApiOnline 1.1]
|
|
95722
95558
|
*/
|
|
95723
95559
|
content?: boolean;
|
|
95724
95560
|
/**
|
|
95725
95561
|
* For EACH ITEM in the collection: Gets the creation date of the comment reply.
|
|
95726
95562
|
*
|
|
95727
95563
|
* @remarks
|
|
95728
|
-
* [Api set: WordApiOnline
|
|
95729
|
-
* @beta
|
|
95564
|
+
* [Api set: WordApiOnline 1.1]
|
|
95730
95565
|
*/
|
|
95731
95566
|
creationDate?: boolean;
|
|
95732
95567
|
/**
|
|
95733
95568
|
* For EACH ITEM in the collection: Gets the ID of the comment reply. Read-only.
|
|
95734
95569
|
*
|
|
95735
95570
|
* @remarks
|
|
95736
|
-
* [Api set: WordApiOnline
|
|
95737
|
-
* @beta
|
|
95571
|
+
* [Api set: WordApiOnline 1.1]
|
|
95738
95572
|
*/
|
|
95739
95573
|
id?: boolean;
|
|
95740
95574
|
}
|
|
@@ -96254,8 +96088,7 @@ declare namespace Word {
|
|
|
96254
96088
|
* Gets or sets the ChangeTracking mode.
|
|
96255
96089
|
*
|
|
96256
96090
|
* @remarks
|
|
96257
|
-
* [Api set: WordApiOnline
|
|
96258
|
-
* @beta
|
|
96091
|
+
* [Api set: WordApiOnline 1.1]
|
|
96259
96092
|
*/
|
|
96260
96093
|
changeTrackingMode?: boolean;
|
|
96261
96094
|
/**
|
|
@@ -97015,8 +96848,7 @@ declare namespace Word {
|
|
|
97015
96848
|
* Represents a footnote or endnote.
|
|
97016
96849
|
*
|
|
97017
96850
|
* @remarks
|
|
97018
|
-
* [Api set: WordApiOnline
|
|
97019
|
-
* @beta
|
|
96851
|
+
* [Api set: WordApiOnline 1.1]
|
|
97020
96852
|
*/
|
|
97021
96853
|
interface NoteItemLoadOptions {
|
|
97022
96854
|
/**
|
|
@@ -97024,27 +96856,24 @@ declare namespace Word {
|
|
|
97024
96856
|
*/
|
|
97025
96857
|
$all?: boolean;
|
|
97026
96858
|
/**
|
|
97027
|
-
* Represents the body object of the note item. It
|
|
96859
|
+
* Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
|
|
97028
96860
|
*
|
|
97029
96861
|
* @remarks
|
|
97030
|
-
* [Api set: WordApiOnline
|
|
97031
|
-
* @beta
|
|
96862
|
+
* [Api set: WordApiOnline 1.1]
|
|
97032
96863
|
*/
|
|
97033
96864
|
body?: Word.Interfaces.BodyLoadOptions;
|
|
97034
96865
|
/**
|
|
97035
96866
|
* Represents a footnote or endnote reference in the main document.
|
|
97036
96867
|
*
|
|
97037
96868
|
* @remarks
|
|
97038
|
-
* [Api set: WordApiOnline
|
|
97039
|
-
* @beta
|
|
96869
|
+
* [Api set: WordApiOnline 1.1]
|
|
97040
96870
|
*/
|
|
97041
96871
|
reference?: Word.Interfaces.RangeLoadOptions;
|
|
97042
96872
|
/**
|
|
97043
96873
|
* Represents the note item type: footnote or endnote.
|
|
97044
96874
|
*
|
|
97045
96875
|
* @remarks
|
|
97046
|
-
* [Api set: WordApiOnline
|
|
97047
|
-
* @beta
|
|
96876
|
+
* [Api set: WordApiOnline 1.1]
|
|
97048
96877
|
*/
|
|
97049
96878
|
type?: boolean;
|
|
97050
96879
|
}
|
|
@@ -97052,8 +96881,7 @@ declare namespace Word {
|
|
|
97052
96881
|
* Contains a collection of {@link Word.NoteItem} objects.
|
|
97053
96882
|
*
|
|
97054
96883
|
* @remarks
|
|
97055
|
-
* [Api set: WordApiOnline
|
|
97056
|
-
* @beta
|
|
96884
|
+
* [Api set: WordApiOnline 1.1]
|
|
97057
96885
|
*/
|
|
97058
96886
|
interface NoteItemCollectionLoadOptions {
|
|
97059
96887
|
/**
|
|
@@ -97061,27 +96889,24 @@ declare namespace Word {
|
|
|
97061
96889
|
*/
|
|
97062
96890
|
$all?: boolean;
|
|
97063
96891
|
/**
|
|
97064
|
-
* For EACH ITEM in the collection: Represents the body object of the note item. It
|
|
96892
|
+
* For EACH ITEM in the collection: Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
|
|
97065
96893
|
*
|
|
97066
96894
|
* @remarks
|
|
97067
|
-
* [Api set: WordApiOnline
|
|
97068
|
-
* @beta
|
|
96895
|
+
* [Api set: WordApiOnline 1.1]
|
|
97069
96896
|
*/
|
|
97070
96897
|
body?: Word.Interfaces.BodyLoadOptions;
|
|
97071
96898
|
/**
|
|
97072
96899
|
* For EACH ITEM in the collection: Represents a footnote or endnote reference in the main document.
|
|
97073
96900
|
*
|
|
97074
96901
|
* @remarks
|
|
97075
|
-
* [Api set: WordApiOnline
|
|
97076
|
-
* @beta
|
|
96902
|
+
* [Api set: WordApiOnline 1.1]
|
|
97077
96903
|
*/
|
|
97078
96904
|
reference?: Word.Interfaces.RangeLoadOptions;
|
|
97079
96905
|
/**
|
|
97080
96906
|
* For EACH ITEM in the collection: Represents the note item type: footnote or endnote.
|
|
97081
96907
|
*
|
|
97082
96908
|
* @remarks
|
|
97083
|
-
* [Api set: WordApiOnline
|
|
97084
|
-
* @beta
|
|
96909
|
+
* [Api set: WordApiOnline 1.1]
|
|
97085
96910
|
*/
|
|
97086
96911
|
type?: boolean;
|
|
97087
96912
|
}
|