@types/office-js 1.0.254 → 1.0.255
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 +1 -1
- office-js/index.d.ts +1933 -260
- office-js/package.json +2 -2
office-js/index.d.ts
CHANGED
|
@@ -74829,6 +74829,13 @@ declare namespace Word {
|
|
|
74829
74829
|
* [Api set: WordApi 1.1]
|
|
74830
74830
|
*/
|
|
74831
74831
|
readonly contentControls: Word.ContentControlCollection;
|
|
74832
|
+
/**
|
|
74833
|
+
* Gets the collection of endnotes in the body. Read-only.
|
|
74834
|
+
*
|
|
74835
|
+
* @remarks
|
|
74836
|
+
* [Api set: WordApiOnline 1.1]
|
|
74837
|
+
*/
|
|
74838
|
+
readonly endnotes: Word.NoteItemCollection;
|
|
74832
74839
|
/**
|
|
74833
74840
|
* Gets the text format of the body. Use this to get and set font name, size, color and other properties. Read-only.
|
|
74834
74841
|
*
|
|
@@ -74836,6 +74843,13 @@ declare namespace Word {
|
|
|
74836
74843
|
* [Api set: WordApi 1.1]
|
|
74837
74844
|
*/
|
|
74838
74845
|
readonly font: Word.Font;
|
|
74846
|
+
/**
|
|
74847
|
+
* Gets the collection of footnotes in the body. Read-only.
|
|
74848
|
+
*
|
|
74849
|
+
* @remarks
|
|
74850
|
+
* [Api set: WordApiOnline 1.1]
|
|
74851
|
+
*/
|
|
74852
|
+
readonly footnotes: Word.NoteItemCollection;
|
|
74839
74853
|
/**
|
|
74840
74854
|
* Gets the collection of InlinePicture objects in the body. The collection does not include floating images. Read-only.
|
|
74841
74855
|
*
|
|
@@ -74933,7 +74947,7 @@ declare namespace Word {
|
|
|
74933
74947
|
* @remarks
|
|
74934
74948
|
* [Api set: WordApi 1.3]
|
|
74935
74949
|
*/
|
|
74936
|
-
readonly type: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell";
|
|
74950
|
+
readonly type: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" | "Footnote" | "Endnote" | "NoteItem";
|
|
74937
74951
|
/**
|
|
74938
74952
|
* Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
|
|
74939
74953
|
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
@@ -74949,6 +74963,13 @@ declare namespace Word {
|
|
|
74949
74963
|
* [Api set: WordApi 1.1]
|
|
74950
74964
|
*/
|
|
74951
74965
|
clear(): void;
|
|
74966
|
+
/**
|
|
74967
|
+
* Gets comments associated with the body.
|
|
74968
|
+
*
|
|
74969
|
+
* @remarks
|
|
74970
|
+
* [Api set: WordApiOnline 1.1]
|
|
74971
|
+
*/
|
|
74972
|
+
getComments(): Word.CommentCollection;
|
|
74952
74973
|
/**
|
|
74953
74974
|
* Gets an HTML representation of the body object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Body.getOoxml()` and convert the returned XML to HTML.
|
|
74954
74975
|
*
|
|
@@ -74981,6 +75002,24 @@ declare namespace Word {
|
|
|
74981
75002
|
* @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
|
|
74982
75003
|
*/
|
|
74983
75004
|
getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
|
|
75005
|
+
/**
|
|
75006
|
+
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
75007
|
+
*
|
|
75008
|
+
* @remarks
|
|
75009
|
+
* [Api set: WordApiOnline 1.1]
|
|
75010
|
+
*
|
|
75011
|
+
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
75012
|
+
*/
|
|
75013
|
+
getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;
|
|
75014
|
+
/**
|
|
75015
|
+
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
75016
|
+
*
|
|
75017
|
+
* @remarks
|
|
75018
|
+
* [Api set: WordApiOnline 1.1]
|
|
75019
|
+
*
|
|
75020
|
+
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
75021
|
+
*/
|
|
75022
|
+
getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
|
|
74984
75023
|
/**
|
|
74985
75024
|
* Inserts a break at the specified location in the main document.
|
|
74986
75025
|
*
|
|
@@ -75224,278 +75263,807 @@ declare namespace Word {
|
|
|
75224
75263
|
toJSON(): Word.Interfaces.BodyData;
|
|
75225
75264
|
}
|
|
75226
75265
|
/**
|
|
75227
|
-
* Represents a
|
|
75266
|
+
* Represents a comment in the document.
|
|
75228
75267
|
*
|
|
75229
75268
|
* @remarks
|
|
75230
|
-
* [Api set:
|
|
75269
|
+
* [Api set: WordApiOnline 1.1]
|
|
75231
75270
|
*/
|
|
75232
|
-
class
|
|
75271
|
+
class Comment extends OfficeExtension.ClientObject {
|
|
75233
75272
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
75234
75273
|
context: RequestContext;
|
|
75235
75274
|
/**
|
|
75236
|
-
* Gets
|
|
75275
|
+
* Gets or sets the comment's content range.
|
|
75237
75276
|
*
|
|
75238
75277
|
* @remarks
|
|
75239
|
-
* [Api set:
|
|
75278
|
+
* [Api set: WordApiOnline 1.1]
|
|
75240
75279
|
*/
|
|
75241
|
-
|
|
75280
|
+
contentRange: Word.CommentContentRange;
|
|
75242
75281
|
/**
|
|
75243
|
-
* Gets the
|
|
75282
|
+
* Gets the collection of reply objects associated with the comment.
|
|
75244
75283
|
*
|
|
75245
75284
|
* @remarks
|
|
75246
|
-
* [Api set:
|
|
75285
|
+
* [Api set: WordApiOnline 1.1]
|
|
75247
75286
|
*/
|
|
75248
|
-
readonly
|
|
75287
|
+
readonly replies: Word.CommentReplyCollection;
|
|
75249
75288
|
/**
|
|
75250
|
-
* Gets the
|
|
75289
|
+
* Gets the email of the comment's author.
|
|
75251
75290
|
*
|
|
75252
75291
|
* @remarks
|
|
75253
|
-
* [Api set:
|
|
75292
|
+
* [Api set: WordApiOnline 1.1]
|
|
75254
75293
|
*/
|
|
75255
|
-
readonly
|
|
75294
|
+
readonly authorEmail: string;
|
|
75256
75295
|
/**
|
|
75257
|
-
* Gets the
|
|
75296
|
+
* Gets the name of the comment's author.
|
|
75258
75297
|
*
|
|
75259
75298
|
* @remarks
|
|
75260
|
-
* [Api set:
|
|
75299
|
+
* [Api set: WordApiOnline 1.1]
|
|
75261
75300
|
*/
|
|
75262
|
-
readonly
|
|
75301
|
+
readonly authorName: string;
|
|
75263
75302
|
/**
|
|
75264
|
-
* Gets
|
|
75303
|
+
* Gets or sets the comment's content as plain text.
|
|
75265
75304
|
*
|
|
75266
75305
|
* @remarks
|
|
75267
|
-
* [Api set:
|
|
75306
|
+
* [Api set: WordApiOnline 1.1]
|
|
75268
75307
|
*/
|
|
75269
|
-
|
|
75308
|
+
content: string;
|
|
75270
75309
|
/**
|
|
75271
|
-
* Gets the
|
|
75310
|
+
* Gets the creation date of the comment.
|
|
75272
75311
|
*
|
|
75273
75312
|
* @remarks
|
|
75274
|
-
* [Api set:
|
|
75313
|
+
* [Api set: WordApiOnline 1.1]
|
|
75275
75314
|
*/
|
|
75276
|
-
readonly
|
|
75315
|
+
readonly creationDate: Date;
|
|
75277
75316
|
/**
|
|
75278
|
-
* Gets the
|
|
75317
|
+
* Gets the Id of the comment. Read-only.
|
|
75279
75318
|
*
|
|
75280
75319
|
* @remarks
|
|
75281
|
-
* [Api set:
|
|
75320
|
+
* [Api set: WordApiOnline 1.1]
|
|
75282
75321
|
*/
|
|
75283
|
-
readonly
|
|
75322
|
+
readonly id: string;
|
|
75284
75323
|
/**
|
|
75285
|
-
* Gets the
|
|
75324
|
+
* 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.
|
|
75286
75325
|
*
|
|
75287
75326
|
* @remarks
|
|
75288
|
-
* [Api set:
|
|
75327
|
+
* [Api set: WordApiOnline 1.1]
|
|
75289
75328
|
*/
|
|
75290
|
-
|
|
75329
|
+
resolved: boolean;
|
|
75291
75330
|
/**
|
|
75292
|
-
*
|
|
75331
|
+
* Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
|
|
75332
|
+
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
75333
|
+
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
75334
|
+
*/
|
|
75335
|
+
set(properties: Interfaces.CommentUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
75336
|
+
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
75337
|
+
set(properties: Word.Comment): void;
|
|
75338
|
+
/**
|
|
75339
|
+
* Deletes the comment and its replies.
|
|
75293
75340
|
*
|
|
75294
75341
|
* @remarks
|
|
75295
|
-
* [Api set:
|
|
75342
|
+
* [Api set: WordApiOnline 1.1]
|
|
75296
75343
|
*/
|
|
75297
|
-
|
|
75344
|
+
delete(): void;
|
|
75298
75345
|
/**
|
|
75299
|
-
* Gets the
|
|
75346
|
+
* Gets the range in the main document where the comment is on.
|
|
75300
75347
|
*
|
|
75301
75348
|
* @remarks
|
|
75302
|
-
* [Api set:
|
|
75349
|
+
* [Api set: WordApiOnline 1.1]
|
|
75303
75350
|
*/
|
|
75304
|
-
|
|
75351
|
+
getRange(): Word.Range;
|
|
75305
75352
|
/**
|
|
75306
|
-
*
|
|
75353
|
+
* Adds a new reply to the end of the comment thread.
|
|
75307
75354
|
*
|
|
75308
75355
|
* @remarks
|
|
75309
|
-
* [Api set:
|
|
75356
|
+
* [Api set: WordApiOnline 1.1]
|
|
75357
|
+
*
|
|
75358
|
+
* @param replyText Required. Reply text.
|
|
75310
75359
|
*/
|
|
75311
|
-
|
|
75360
|
+
reply(replyText: string): Word.CommentReply;
|
|
75312
75361
|
/**
|
|
75313
|
-
*
|
|
75362
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75314
75363
|
*
|
|
75315
|
-
* @
|
|
75316
|
-
* [Api set: WordApi 1.3]
|
|
75364
|
+
* @param options Provides options for which properties of the object to load.
|
|
75317
75365
|
*/
|
|
75318
|
-
|
|
75366
|
+
load(options?: Word.Interfaces.CommentLoadOptions): Word.Comment;
|
|
75319
75367
|
/**
|
|
75320
|
-
*
|
|
75368
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75321
75369
|
*
|
|
75322
|
-
* @
|
|
75323
|
-
* [Api set: WordApi 1.3]
|
|
75370
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
75324
75371
|
*/
|
|
75325
|
-
|
|
75372
|
+
load(propertyNames?: string | string[]): Word.Comment;
|
|
75326
75373
|
/**
|
|
75327
|
-
*
|
|
75374
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75328
75375
|
*
|
|
75329
|
-
* @
|
|
75330
|
-
* [Api set: WordApi 1.1]
|
|
75376
|
+
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
75331
75377
|
*/
|
|
75332
|
-
|
|
75378
|
+
load(propertyNamesAndPaths?: {
|
|
75379
|
+
select?: string;
|
|
75380
|
+
expand?: string;
|
|
75381
|
+
}): Word.Comment;
|
|
75333
75382
|
/**
|
|
75334
|
-
*
|
|
75383
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
|
|
75384
|
+
*/
|
|
75385
|
+
track(): Word.Comment;
|
|
75386
|
+
/**
|
|
75387
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `context.trackedObjects.remove(thisObject)`. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
75388
|
+
*/
|
|
75389
|
+
untrack(): Word.Comment;
|
|
75390
|
+
/**
|
|
75391
|
+
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
75392
|
+
* Whereas the original Word.Comment object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentData`) that contains shallow copies of any loaded child properties from the original object.
|
|
75393
|
+
*/
|
|
75394
|
+
toJSON(): Word.Interfaces.CommentData;
|
|
75395
|
+
}
|
|
75396
|
+
/**
|
|
75397
|
+
* Contains a collection of {@link Word.Comment} objects.
|
|
75398
|
+
*
|
|
75399
|
+
* @remarks
|
|
75400
|
+
* [Api set: WordApiOnline 1.1]
|
|
75401
|
+
*/
|
|
75402
|
+
class CommentCollection extends OfficeExtension.ClientObject {
|
|
75403
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
75404
|
+
context: RequestContext;
|
|
75405
|
+
/** Gets the loaded child items in this collection. */
|
|
75406
|
+
readonly items: Word.Comment[];
|
|
75407
|
+
/**
|
|
75408
|
+
* Gets the first comment in the collection. Throws an error if this collection is empty.
|
|
75335
75409
|
*
|
|
75336
75410
|
* @remarks
|
|
75337
|
-
* [Api set:
|
|
75411
|
+
* [Api set: WordApiOnline 1.1]
|
|
75338
75412
|
*/
|
|
75339
|
-
|
|
75413
|
+
getFirst(): Word.Comment;
|
|
75340
75414
|
/**
|
|
75341
|
-
* Gets
|
|
75415
|
+
* Gets the first comment in the collection. If the collection is empty, returns a null object.
|
|
75342
75416
|
*
|
|
75343
75417
|
* @remarks
|
|
75344
|
-
* [Api set:
|
|
75418
|
+
* [Api set: WordApiOnline 1.1]
|
|
75345
75419
|
*/
|
|
75346
|
-
|
|
75420
|
+
getFirstOrNullObject(): Word.Comment;
|
|
75347
75421
|
/**
|
|
75348
|
-
* Gets
|
|
75422
|
+
* Gets a comment object by its index in the collection.
|
|
75349
75423
|
*
|
|
75350
75424
|
* @remarks
|
|
75351
|
-
* [Api set:
|
|
75425
|
+
* [Api set: WordApiOnline 1.1]
|
|
75426
|
+
*
|
|
75427
|
+
* @param index A number that identifies the index location of a comment object.
|
|
75352
75428
|
*/
|
|
75353
|
-
|
|
75429
|
+
getItem(index: number): Word.Comment;
|
|
75354
75430
|
/**
|
|
75355
|
-
*
|
|
75431
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75356
75432
|
*
|
|
75357
|
-
* @
|
|
75358
|
-
* [Api set: WordApi 1.1]
|
|
75433
|
+
* @param options Provides options for which properties of the object to load.
|
|
75359
75434
|
*/
|
|
75360
|
-
|
|
75435
|
+
load(options?: Word.Interfaces.CommentCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CommentCollection;
|
|
75361
75436
|
/**
|
|
75362
|
-
*
|
|
75363
|
-
* **Note**: The set operation for this property is not supported in Word on the web.
|
|
75437
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75364
75438
|
*
|
|
75365
|
-
* @
|
|
75366
|
-
* [Api set: WordApi 1.1]
|
|
75439
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
75367
75440
|
*/
|
|
75368
|
-
|
|
75441
|
+
load(propertyNames?: string | string[]): Word.CommentCollection;
|
|
75369
75442
|
/**
|
|
75370
|
-
*
|
|
75443
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75371
75444
|
*
|
|
75372
|
-
* @
|
|
75373
|
-
* [Api set: WordApi 1.1]
|
|
75445
|
+
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
75374
75446
|
*/
|
|
75375
|
-
|
|
75447
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CommentCollection;
|
|
75376
75448
|
/**
|
|
75377
|
-
*
|
|
75449
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
|
|
75450
|
+
*/
|
|
75451
|
+
track(): Word.CommentCollection;
|
|
75452
|
+
/**
|
|
75453
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `context.trackedObjects.remove(thisObject)`. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
75454
|
+
*/
|
|
75455
|
+
untrack(): Word.CommentCollection;
|
|
75456
|
+
/**
|
|
75457
|
+
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
75458
|
+
* Whereas the original `Word.CommentCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
75459
|
+
*/
|
|
75460
|
+
toJSON(): Word.Interfaces.CommentCollectionData;
|
|
75461
|
+
}
|
|
75462
|
+
/**
|
|
75463
|
+
* @remarks
|
|
75464
|
+
* [Api set: WordApiOnline 1.1]
|
|
75465
|
+
*/
|
|
75466
|
+
class CommentContentRange extends OfficeExtension.ClientObject {
|
|
75467
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
75468
|
+
context: RequestContext;
|
|
75469
|
+
/**
|
|
75470
|
+
* Gets or sets a value that indicates whether the comment text is bold.
|
|
75378
75471
|
*
|
|
75379
75472
|
* @remarks
|
|
75380
|
-
* [Api set:
|
|
75473
|
+
* [Api set: WordApiOnline 1.1]
|
|
75381
75474
|
*/
|
|
75382
|
-
|
|
75475
|
+
bold: boolean;
|
|
75383
75476
|
/**
|
|
75384
|
-
* Gets
|
|
75477
|
+
* 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.
|
|
75385
75478
|
*
|
|
75386
75479
|
* @remarks
|
|
75387
|
-
* [Api set:
|
|
75480
|
+
* [Api set: WordApiOnline 1.1]
|
|
75388
75481
|
*/
|
|
75389
|
-
|
|
75482
|
+
hyperlink: string;
|
|
75390
75483
|
/**
|
|
75391
|
-
*
|
|
75484
|
+
* Checks whether the range length is zero. Read-only.
|
|
75392
75485
|
*
|
|
75393
75486
|
* @remarks
|
|
75394
|
-
* [Api set:
|
|
75487
|
+
* [Api set: WordApiOnline 1.1]
|
|
75395
75488
|
*/
|
|
75396
|
-
readonly
|
|
75489
|
+
readonly isEmpty: boolean;
|
|
75397
75490
|
/**
|
|
75398
|
-
* Gets or sets a
|
|
75491
|
+
* Gets or sets a value that indicates whether the comment text is italicized.
|
|
75399
75492
|
*
|
|
75400
75493
|
* @remarks
|
|
75401
|
-
* [Api set:
|
|
75494
|
+
* [Api set: WordApiOnline 1.1]
|
|
75402
75495
|
*/
|
|
75403
|
-
|
|
75496
|
+
italic: boolean;
|
|
75404
75497
|
/**
|
|
75405
|
-
* Gets
|
|
75498
|
+
* Gets or sets a value that indicates whether the comment text has a strikethrough.
|
|
75406
75499
|
*
|
|
75407
75500
|
* @remarks
|
|
75408
|
-
* [Api set:
|
|
75501
|
+
* [Api set: WordApiOnline 1.1]
|
|
75409
75502
|
*/
|
|
75410
|
-
|
|
75503
|
+
strikeThrough: boolean;
|
|
75411
75504
|
/**
|
|
75412
|
-
* Gets
|
|
75505
|
+
* Gets the text of the comment range. Read-only.
|
|
75413
75506
|
*
|
|
75414
75507
|
* @remarks
|
|
75415
|
-
* [Api set:
|
|
75508
|
+
* [Api set: WordApiOnline 1.1]
|
|
75416
75509
|
*/
|
|
75417
|
-
|
|
75510
|
+
readonly text: string;
|
|
75418
75511
|
/**
|
|
75419
|
-
* Gets the
|
|
75512
|
+
* Gets or sets a value that indicates the comment text's underline type. 'None' if the comment text is not underlined.
|
|
75420
75513
|
*
|
|
75421
75514
|
* @remarks
|
|
75422
|
-
* [Api set:
|
|
75515
|
+
* [Api set: WordApiOnline 1.1]
|
|
75423
75516
|
*/
|
|
75424
|
-
|
|
75517
|
+
underline: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble";
|
|
75425
75518
|
/**
|
|
75426
75519
|
* Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
|
|
75427
75520
|
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
75428
75521
|
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
75429
75522
|
*/
|
|
75430
|
-
set(properties: Interfaces.
|
|
75523
|
+
set(properties: Interfaces.CommentContentRangeUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
75431
75524
|
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
75432
|
-
set(properties: Word.
|
|
75525
|
+
set(properties: Word.CommentContentRange): void;
|
|
75433
75526
|
/**
|
|
75434
|
-
*
|
|
75527
|
+
* Inserts text into at the specified location.
|
|
75435
75528
|
*
|
|
75436
75529
|
* @remarks
|
|
75437
|
-
* [Api set:
|
|
75530
|
+
* [Api set: WordApiOnline 1.1]
|
|
75531
|
+
*
|
|
75532
|
+
* @param text Required. The text to be inserted in to the CommentContentRange.
|
|
75533
|
+
* @param insertLocation Required. The value must be 'After', 'Before', 'Replace', 'Start', or 'End'.
|
|
75438
75534
|
*/
|
|
75439
|
-
|
|
75535
|
+
insertText(text: string, insertLocation: Word.InsertLocation): Word.CommentContentRange;
|
|
75440
75536
|
/**
|
|
75441
|
-
*
|
|
75537
|
+
* Inserts text into at the specified location.
|
|
75442
75538
|
*
|
|
75443
75539
|
* @remarks
|
|
75444
|
-
* [Api set:
|
|
75540
|
+
* [Api set: WordApiOnline 1.1]
|
|
75445
75541
|
*
|
|
75446
|
-
* @param
|
|
75542
|
+
* @param text Required. The text to be inserted in to the CommentContentRange.
|
|
75543
|
+
* @param insertLocation Required. The value must be 'After', 'Before', 'Replace', 'Start', or 'End'.
|
|
75447
75544
|
*/
|
|
75448
|
-
|
|
75545
|
+
insertText(text: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.CommentContentRange;
|
|
75449
75546
|
/**
|
|
75450
|
-
*
|
|
75547
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75451
75548
|
*
|
|
75452
|
-
* @
|
|
75453
|
-
* [Api set: WordApi 1.1]
|
|
75549
|
+
* @param options Provides options for which properties of the object to load.
|
|
75454
75550
|
*/
|
|
75455
|
-
|
|
75551
|
+
load(options?: Word.Interfaces.CommentContentRangeLoadOptions): Word.CommentContentRange;
|
|
75456
75552
|
/**
|
|
75457
|
-
*
|
|
75553
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75458
75554
|
*
|
|
75459
|
-
* @
|
|
75460
|
-
* [Api set: WordApi 1.1]
|
|
75555
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
75461
75556
|
*/
|
|
75462
|
-
|
|
75557
|
+
load(propertyNames?: string | string[]): Word.CommentContentRange;
|
|
75463
75558
|
/**
|
|
75464
|
-
*
|
|
75465
|
-
*
|
|
75466
|
-
* @remarks
|
|
75467
|
-
* [Api set: WordApi 1.3]
|
|
75559
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75468
75560
|
*
|
|
75469
|
-
* @param
|
|
75561
|
+
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
75470
75562
|
*/
|
|
75471
|
-
|
|
75563
|
+
load(propertyNamesAndPaths?: {
|
|
75564
|
+
select?: string;
|
|
75565
|
+
expand?: string;
|
|
75566
|
+
}): Word.CommentContentRange;
|
|
75472
75567
|
/**
|
|
75473
|
-
*
|
|
75568
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
|
|
75569
|
+
*/
|
|
75570
|
+
track(): Word.CommentContentRange;
|
|
75571
|
+
/**
|
|
75572
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `context.trackedObjects.remove(thisObject)`. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
75573
|
+
*/
|
|
75574
|
+
untrack(): Word.CommentContentRange;
|
|
75575
|
+
/**
|
|
75576
|
+
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
75577
|
+
* Whereas the original Word.CommentContentRange object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentContentRangeData`) that contains shallow copies of any loaded child properties from the original object.
|
|
75578
|
+
*/
|
|
75579
|
+
toJSON(): Word.Interfaces.CommentContentRangeData;
|
|
75580
|
+
}
|
|
75581
|
+
/**
|
|
75582
|
+
* Represents a comment reply in the document.
|
|
75583
|
+
*
|
|
75584
|
+
* @remarks
|
|
75585
|
+
* [Api set: WordApiOnline 1.1]
|
|
75586
|
+
*/
|
|
75587
|
+
class CommentReply extends OfficeExtension.ClientObject {
|
|
75588
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
75589
|
+
context: RequestContext;
|
|
75590
|
+
/**
|
|
75591
|
+
* Gets or sets the commentReply's content range.
|
|
75474
75592
|
*
|
|
75475
75593
|
* @remarks
|
|
75476
|
-
* [Api set:
|
|
75477
|
-
*
|
|
75478
|
-
* @param rangeLocation Optional. The range location must be 'Whole', 'Before', 'Start', 'End', 'After', or 'Content'.
|
|
75594
|
+
* [Api set: WordApiOnline 1.1]
|
|
75479
75595
|
*/
|
|
75480
|
-
|
|
75596
|
+
contentRange: Word.CommentContentRange;
|
|
75481
75597
|
/**
|
|
75482
|
-
* Gets the
|
|
75598
|
+
* Gets the parent comment of this reply.
|
|
75483
75599
|
*
|
|
75484
75600
|
* @remarks
|
|
75485
|
-
* [Api set:
|
|
75486
|
-
*
|
|
75487
|
-
* @param endingMarks Required. The punctuation marks and/or other ending marks as an array of strings.
|
|
75488
|
-
* @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection.
|
|
75601
|
+
* [Api set: WordApiOnline 1.1]
|
|
75489
75602
|
*/
|
|
75490
|
-
|
|
75603
|
+
readonly parentComment: Word.Comment;
|
|
75491
75604
|
/**
|
|
75492
|
-
*
|
|
75605
|
+
* Gets the email of the comment reply's author.
|
|
75493
75606
|
*
|
|
75494
75607
|
* @remarks
|
|
75495
|
-
* [Api set:
|
|
75496
|
-
|
|
75497
|
-
|
|
75498
|
-
|
|
75608
|
+
* [Api set: WordApiOnline 1.1]
|
|
75609
|
+
*/
|
|
75610
|
+
readonly authorEmail: string;
|
|
75611
|
+
/**
|
|
75612
|
+
* Gets the name of the comment reply's author.
|
|
75613
|
+
*
|
|
75614
|
+
* @remarks
|
|
75615
|
+
* [Api set: WordApiOnline 1.1]
|
|
75616
|
+
*/
|
|
75617
|
+
readonly authorName: string;
|
|
75618
|
+
/**
|
|
75619
|
+
* Gets or sets the comment reply's content. The string is plain text.
|
|
75620
|
+
*
|
|
75621
|
+
* @remarks
|
|
75622
|
+
* [Api set: WordApiOnline 1.1]
|
|
75623
|
+
*/
|
|
75624
|
+
content: string;
|
|
75625
|
+
/**
|
|
75626
|
+
* Gets the creation date of the comment reply.
|
|
75627
|
+
*
|
|
75628
|
+
* @remarks
|
|
75629
|
+
* [Api set: WordApiOnline 1.1]
|
|
75630
|
+
*/
|
|
75631
|
+
readonly creationDate: Date;
|
|
75632
|
+
/**
|
|
75633
|
+
* Gets the Id of the comment reply. Read-only.
|
|
75634
|
+
*
|
|
75635
|
+
* @remarks
|
|
75636
|
+
* [Api set: WordApiOnline 1.1]
|
|
75637
|
+
*/
|
|
75638
|
+
readonly id: string;
|
|
75639
|
+
/**
|
|
75640
|
+
* Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
|
|
75641
|
+
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
75642
|
+
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
75643
|
+
*/
|
|
75644
|
+
set(properties: Interfaces.CommentReplyUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
75645
|
+
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
75646
|
+
set(properties: Word.CommentReply): void;
|
|
75647
|
+
/**
|
|
75648
|
+
* Deletes the comment reply.
|
|
75649
|
+
*
|
|
75650
|
+
* @remarks
|
|
75651
|
+
* [Api set: WordApiOnline 1.1]
|
|
75652
|
+
*/
|
|
75653
|
+
delete(): void;
|
|
75654
|
+
/**
|
|
75655
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75656
|
+
*
|
|
75657
|
+
* @param options Provides options for which properties of the object to load.
|
|
75658
|
+
*/
|
|
75659
|
+
load(options?: Word.Interfaces.CommentReplyLoadOptions): Word.CommentReply;
|
|
75660
|
+
/**
|
|
75661
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75662
|
+
*
|
|
75663
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
75664
|
+
*/
|
|
75665
|
+
load(propertyNames?: string | string[]): Word.CommentReply;
|
|
75666
|
+
/**
|
|
75667
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75668
|
+
*
|
|
75669
|
+
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
75670
|
+
*/
|
|
75671
|
+
load(propertyNamesAndPaths?: {
|
|
75672
|
+
select?: string;
|
|
75673
|
+
expand?: string;
|
|
75674
|
+
}): Word.CommentReply;
|
|
75675
|
+
/**
|
|
75676
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
|
|
75677
|
+
*/
|
|
75678
|
+
track(): Word.CommentReply;
|
|
75679
|
+
/**
|
|
75680
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `context.trackedObjects.remove(thisObject)`. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
75681
|
+
*/
|
|
75682
|
+
untrack(): Word.CommentReply;
|
|
75683
|
+
/**
|
|
75684
|
+
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
75685
|
+
* Whereas the original Word.CommentReply object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentReplyData`) that contains shallow copies of any loaded child properties from the original object.
|
|
75686
|
+
*/
|
|
75687
|
+
toJSON(): Word.Interfaces.CommentReplyData;
|
|
75688
|
+
}
|
|
75689
|
+
/**
|
|
75690
|
+
* Contains a collection of {@link Word.CommentReply} objects. Represents all comment replies in one comment thread.
|
|
75691
|
+
*
|
|
75692
|
+
* @remarks
|
|
75693
|
+
* [Api set: WordApiOnline 1.1]
|
|
75694
|
+
*/
|
|
75695
|
+
class CommentReplyCollection extends OfficeExtension.ClientObject {
|
|
75696
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
75697
|
+
context: RequestContext;
|
|
75698
|
+
/** Gets the loaded child items in this collection. */
|
|
75699
|
+
readonly items: Word.CommentReply[];
|
|
75700
|
+
/**
|
|
75701
|
+
* Gets the first comment reply in the collection. Throws an error if this collection is empty.
|
|
75702
|
+
*
|
|
75703
|
+
* @remarks
|
|
75704
|
+
* [Api set: WordApiOnline 1.1]
|
|
75705
|
+
*/
|
|
75706
|
+
getFirst(): Word.CommentReply;
|
|
75707
|
+
/**
|
|
75708
|
+
* Gets the first comment reply in the collection. If the collection is empty, returns a null object.
|
|
75709
|
+
*
|
|
75710
|
+
* @remarks
|
|
75711
|
+
* [Api set: WordApiOnline 1.1]
|
|
75712
|
+
*/
|
|
75713
|
+
getFirstOrNullObject(): Word.CommentReply;
|
|
75714
|
+
/**
|
|
75715
|
+
* Gets a comment reply object by its index in the collection.
|
|
75716
|
+
*
|
|
75717
|
+
* @remarks
|
|
75718
|
+
* [Api set: WordApiOnline 1.1]
|
|
75719
|
+
*
|
|
75720
|
+
* @param index A number that identifies the index location of a comment reply object.
|
|
75721
|
+
*/
|
|
75722
|
+
getItem(index: number): Word.CommentReply;
|
|
75723
|
+
/**
|
|
75724
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75725
|
+
*
|
|
75726
|
+
* @param options Provides options for which properties of the object to load.
|
|
75727
|
+
*/
|
|
75728
|
+
load(options?: Word.Interfaces.CommentReplyCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CommentReplyCollection;
|
|
75729
|
+
/**
|
|
75730
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75731
|
+
*
|
|
75732
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
75733
|
+
*/
|
|
75734
|
+
load(propertyNames?: string | string[]): Word.CommentReplyCollection;
|
|
75735
|
+
/**
|
|
75736
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75737
|
+
*
|
|
75738
|
+
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
75739
|
+
*/
|
|
75740
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CommentReplyCollection;
|
|
75741
|
+
/**
|
|
75742
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
|
|
75743
|
+
*/
|
|
75744
|
+
track(): Word.CommentReplyCollection;
|
|
75745
|
+
/**
|
|
75746
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `context.trackedObjects.remove(thisObject)`. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
75747
|
+
*/
|
|
75748
|
+
untrack(): Word.CommentReplyCollection;
|
|
75749
|
+
/**
|
|
75750
|
+
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
75751
|
+
* Whereas the original `Word.CommentReplyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentReplyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
75752
|
+
*/
|
|
75753
|
+
toJSON(): Word.Interfaces.CommentReplyCollectionData;
|
|
75754
|
+
}
|
|
75755
|
+
/**
|
|
75756
|
+
* Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text content controls are supported.
|
|
75757
|
+
*
|
|
75758
|
+
* @remarks
|
|
75759
|
+
* [Api set: WordApi 1.1]
|
|
75760
|
+
*/
|
|
75761
|
+
class ContentControl extends OfficeExtension.ClientObject {
|
|
75762
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
75763
|
+
context: RequestContext;
|
|
75764
|
+
/**
|
|
75765
|
+
* Gets the collection of content control objects in the content control. Read-only.
|
|
75766
|
+
*
|
|
75767
|
+
* @remarks
|
|
75768
|
+
* [Api set: WordApi 1.1]
|
|
75769
|
+
*/
|
|
75770
|
+
readonly contentControls: Word.ContentControlCollection;
|
|
75771
|
+
/**
|
|
75772
|
+
* Gets the collection of endnotes in the contentcontrol. Read-only.
|
|
75773
|
+
*
|
|
75774
|
+
* @remarks
|
|
75775
|
+
* [Api set: WordApiOnline 1.1]
|
|
75776
|
+
*/
|
|
75777
|
+
readonly endnotes: Word.NoteItemCollection;
|
|
75778
|
+
/**
|
|
75779
|
+
* Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. Read-only.
|
|
75780
|
+
*
|
|
75781
|
+
* @remarks
|
|
75782
|
+
* [Api set: WordApi 1.1]
|
|
75783
|
+
*/
|
|
75784
|
+
readonly font: Word.Font;
|
|
75785
|
+
/**
|
|
75786
|
+
* Gets the collection of footnotes in the contentcontrol. Read-only.
|
|
75787
|
+
*
|
|
75788
|
+
* @remarks
|
|
75789
|
+
* [Api set: WordApiOnline 1.1]
|
|
75790
|
+
*/
|
|
75791
|
+
readonly footnotes: Word.NoteItemCollection;
|
|
75792
|
+
/**
|
|
75793
|
+
* Gets the collection of inlinePicture objects in the content control. The collection does not include floating images. Read-only.
|
|
75794
|
+
*
|
|
75795
|
+
* @remarks
|
|
75796
|
+
* [Api set: WordApi 1.1]
|
|
75797
|
+
*/
|
|
75798
|
+
readonly inlinePictures: Word.InlinePictureCollection;
|
|
75799
|
+
/**
|
|
75800
|
+
* Gets the collection of list objects in the content control. Read-only.
|
|
75801
|
+
*
|
|
75802
|
+
* @remarks
|
|
75803
|
+
* [Api set: WordApi 1.3]
|
|
75804
|
+
*/
|
|
75805
|
+
readonly lists: Word.ListCollection;
|
|
75806
|
+
/**
|
|
75807
|
+
* Gets the collection of paragraph objects in the content control. Read-only. **Important**: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this content control are not returned. From requirement set 1.3, paragraphs in such tables are also returned.
|
|
75808
|
+
*
|
|
75809
|
+
* @remarks
|
|
75810
|
+
* [Api set: WordApi 1.1]
|
|
75811
|
+
*/
|
|
75812
|
+
readonly paragraphs: Word.ParagraphCollection;
|
|
75813
|
+
/**
|
|
75814
|
+
* Gets the parent body of the content control. Read-only.
|
|
75815
|
+
*
|
|
75816
|
+
* @remarks
|
|
75817
|
+
* [Api set: WordApi 1.3]
|
|
75818
|
+
*/
|
|
75819
|
+
readonly parentBody: Word.Body;
|
|
75820
|
+
/**
|
|
75821
|
+
* Gets the content control that contains the content control. Throws an error if there isn't a parent content control. Read-only.
|
|
75822
|
+
*
|
|
75823
|
+
* @remarks
|
|
75824
|
+
* [Api set: WordApi 1.1]
|
|
75825
|
+
*/
|
|
75826
|
+
readonly parentContentControl: Word.ContentControl;
|
|
75827
|
+
/**
|
|
75828
|
+
* Gets the content control that contains the content control. Returns a null object if there isn't a parent content control. Read-only.
|
|
75829
|
+
*
|
|
75830
|
+
* @remarks
|
|
75831
|
+
* [Api set: WordApi 1.3]
|
|
75832
|
+
*/
|
|
75833
|
+
readonly parentContentControlOrNullObject: Word.ContentControl;
|
|
75834
|
+
/**
|
|
75835
|
+
* Gets the table that contains the content control. Throws an error if it is not contained in a table. Read-only.
|
|
75836
|
+
*
|
|
75837
|
+
* @remarks
|
|
75838
|
+
* [Api set: WordApi 1.3]
|
|
75839
|
+
*/
|
|
75840
|
+
readonly parentTable: Word.Table;
|
|
75841
|
+
/**
|
|
75842
|
+
* Gets the table cell that contains the content control. Throws an error if it is not contained in a table cell. Read-only.
|
|
75843
|
+
*
|
|
75844
|
+
* @remarks
|
|
75845
|
+
* [Api set: WordApi 1.3]
|
|
75846
|
+
*/
|
|
75847
|
+
readonly parentTableCell: Word.TableCell;
|
|
75848
|
+
/**
|
|
75849
|
+
* Gets the table cell that contains the content control. Returns a null object if it is not contained in a table cell. Read-only.
|
|
75850
|
+
*
|
|
75851
|
+
* @remarks
|
|
75852
|
+
* [Api set: WordApi 1.3]
|
|
75853
|
+
*/
|
|
75854
|
+
readonly parentTableCellOrNullObject: Word.TableCell;
|
|
75855
|
+
/**
|
|
75856
|
+
* Gets the table that contains the content control. Returns a null object if it is not contained in a table. Read-only.
|
|
75857
|
+
*
|
|
75858
|
+
* @remarks
|
|
75859
|
+
* [Api set: WordApi 1.3]
|
|
75860
|
+
*/
|
|
75861
|
+
readonly parentTableOrNullObject: Word.Table;
|
|
75862
|
+
/**
|
|
75863
|
+
* Gets the collection of table objects in the content control. Read-only.
|
|
75864
|
+
*
|
|
75865
|
+
* @remarks
|
|
75866
|
+
* [Api set: WordApi 1.3]
|
|
75867
|
+
*/
|
|
75868
|
+
readonly tables: Word.TableCollection;
|
|
75869
|
+
/**
|
|
75870
|
+
* Gets or sets the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'.
|
|
75871
|
+
*
|
|
75872
|
+
* @remarks
|
|
75873
|
+
* [Api set: WordApi 1.1]
|
|
75874
|
+
*/
|
|
75875
|
+
appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden";
|
|
75876
|
+
/**
|
|
75877
|
+
* Gets or sets a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited.
|
|
75878
|
+
*
|
|
75879
|
+
* @remarks
|
|
75880
|
+
* [Api set: WordApi 1.1]
|
|
75881
|
+
*/
|
|
75882
|
+
cannotDelete: boolean;
|
|
75883
|
+
/**
|
|
75884
|
+
* Gets or sets a value that indicates whether the user can edit the contents of the content control.
|
|
75885
|
+
*
|
|
75886
|
+
* @remarks
|
|
75887
|
+
* [Api set: WordApi 1.1]
|
|
75888
|
+
*/
|
|
75889
|
+
cannotEdit: boolean;
|
|
75890
|
+
/**
|
|
75891
|
+
* Gets or sets the color of the content control. Color is specified in '#RRGGBB' format or by using the color name.
|
|
75892
|
+
*
|
|
75893
|
+
* @remarks
|
|
75894
|
+
* [Api set: WordApi 1.1]
|
|
75895
|
+
*/
|
|
75896
|
+
color: string;
|
|
75897
|
+
/**
|
|
75898
|
+
* Gets an integer that represents the content control identifier. Read-only.
|
|
75899
|
+
*
|
|
75900
|
+
* @remarks
|
|
75901
|
+
* [Api set: WordApi 1.1]
|
|
75902
|
+
*/
|
|
75903
|
+
readonly id: number;
|
|
75904
|
+
/**
|
|
75905
|
+
* Gets or sets the placeholder text of the content control. Dimmed text will be displayed when the content control is empty.
|
|
75906
|
+
* **Note**: The set operation for this property is not supported in Word on the web.
|
|
75907
|
+
*
|
|
75908
|
+
* @remarks
|
|
75909
|
+
* [Api set: WordApi 1.1]
|
|
75910
|
+
*/
|
|
75911
|
+
placeholderText: string;
|
|
75912
|
+
/**
|
|
75913
|
+
* Gets or sets a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete.
|
|
75914
|
+
*
|
|
75915
|
+
* @remarks
|
|
75916
|
+
* [Api set: WordApi 1.1]
|
|
75917
|
+
*/
|
|
75918
|
+
removeWhenEdited: boolean;
|
|
75919
|
+
/**
|
|
75920
|
+
* Gets or sets the style name for the content control. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property.
|
|
75921
|
+
*
|
|
75922
|
+
* @remarks
|
|
75923
|
+
* [Api set: WordApi 1.1]
|
|
75924
|
+
*/
|
|
75925
|
+
style: string;
|
|
75926
|
+
/**
|
|
75927
|
+
* Gets or sets the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property.
|
|
75928
|
+
*
|
|
75929
|
+
* @remarks
|
|
75930
|
+
* [Api set: WordApi 1.3]
|
|
75931
|
+
*/
|
|
75932
|
+
styleBuiltIn: Word.Style | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6";
|
|
75933
|
+
/**
|
|
75934
|
+
* Gets the content control subtype. The subtype can be 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' and 'RichTextTable' for rich text content controls. Read-only.
|
|
75935
|
+
*
|
|
75936
|
+
* @remarks
|
|
75937
|
+
* [Api set: WordApi 1.3]
|
|
75938
|
+
*/
|
|
75939
|
+
readonly subtype: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText";
|
|
75940
|
+
/**
|
|
75941
|
+
* Gets or sets a tag to identify a content control.
|
|
75942
|
+
*
|
|
75943
|
+
* @remarks
|
|
75944
|
+
* [Api set: WordApi 1.1]
|
|
75945
|
+
*/
|
|
75946
|
+
tag: string;
|
|
75947
|
+
/**
|
|
75948
|
+
* Gets the text of the content control. Read-only.
|
|
75949
|
+
*
|
|
75950
|
+
* @remarks
|
|
75951
|
+
* [Api set: WordApi 1.1]
|
|
75952
|
+
*/
|
|
75953
|
+
readonly text: string;
|
|
75954
|
+
/**
|
|
75955
|
+
* Gets or sets the title for a content control.
|
|
75956
|
+
*
|
|
75957
|
+
* @remarks
|
|
75958
|
+
* [Api set: WordApi 1.1]
|
|
75959
|
+
*/
|
|
75960
|
+
title: string;
|
|
75961
|
+
/**
|
|
75962
|
+
* Gets the content control type. Only rich text content controls are supported currently. Read-only.
|
|
75963
|
+
*
|
|
75964
|
+
* @remarks
|
|
75965
|
+
* [Api set: WordApi 1.1]
|
|
75966
|
+
*/
|
|
75967
|
+
readonly type: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText";
|
|
75968
|
+
/**
|
|
75969
|
+
* Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
|
|
75970
|
+
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
75971
|
+
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
75972
|
+
*/
|
|
75973
|
+
set(properties: Interfaces.ContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
75974
|
+
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
75975
|
+
set(properties: Word.ContentControl): void;
|
|
75976
|
+
/**
|
|
75977
|
+
* Clears the contents of the content control. The user can perform the undo operation on the cleared content.
|
|
75978
|
+
*
|
|
75979
|
+
* @remarks
|
|
75980
|
+
* [Api set: WordApi 1.1]
|
|
75981
|
+
*/
|
|
75982
|
+
clear(): void;
|
|
75983
|
+
/**
|
|
75984
|
+
* Deletes the content control and its content. If keepContent is set to true, the content is not deleted.
|
|
75985
|
+
*
|
|
75986
|
+
* @remarks
|
|
75987
|
+
* [Api set: WordApi 1.1]
|
|
75988
|
+
*
|
|
75989
|
+
* @param keepContent Required. Indicates whether the content should be deleted with the content control. If keepContent is set to true, the content is not deleted.
|
|
75990
|
+
*/
|
|
75991
|
+
delete(keepContent: boolean): void;
|
|
75992
|
+
/**
|
|
75993
|
+
* Gets comments associated with the body.
|
|
75994
|
+
*
|
|
75995
|
+
* @remarks
|
|
75996
|
+
* [Api set: WordApiOnline 1.1]
|
|
75997
|
+
*/
|
|
75998
|
+
getComments(): Word.CommentCollection;
|
|
75999
|
+
/**
|
|
76000
|
+
* Gets an HTML representation of the content control object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `ContentControl.getOoxml()` and convert the returned XML to HTML.
|
|
76001
|
+
*
|
|
76002
|
+
* @remarks
|
|
76003
|
+
* [Api set: WordApi 1.1]
|
|
76004
|
+
*/
|
|
76005
|
+
getHtml(): OfficeExtension.ClientResult<string>;
|
|
76006
|
+
/**
|
|
76007
|
+
* Gets the Office Open XML (OOXML) representation of the content control object.
|
|
76008
|
+
*
|
|
76009
|
+
* @remarks
|
|
76010
|
+
* [Api set: WordApi 1.1]
|
|
76011
|
+
*/
|
|
76012
|
+
getOoxml(): OfficeExtension.ClientResult<string>;
|
|
76013
|
+
/**
|
|
76014
|
+
* Gets the whole content control, or the starting or ending point of the content control, as a range.
|
|
76015
|
+
*
|
|
76016
|
+
* @remarks
|
|
76017
|
+
* [Api set: WordApi 1.3]
|
|
76018
|
+
*
|
|
76019
|
+
* @param rangeLocation Optional. The range location must be 'Whole', 'Before', 'Start', 'End', 'After', or 'Content'.
|
|
76020
|
+
*/
|
|
76021
|
+
getRange(rangeLocation?: Word.RangeLocation): Word.Range;
|
|
76022
|
+
/**
|
|
76023
|
+
* Gets the whole content control, or the starting or ending point of the content control, as a range.
|
|
76024
|
+
*
|
|
76025
|
+
* @remarks
|
|
76026
|
+
* [Api set: WordApi 1.3]
|
|
76027
|
+
*
|
|
76028
|
+
* @param rangeLocation Optional. The range location must be 'Whole', 'Before', 'Start', 'End', 'After', or 'Content'.
|
|
76029
|
+
*/
|
|
76030
|
+
getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
|
|
76031
|
+
/**
|
|
76032
|
+
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
76033
|
+
*
|
|
76034
|
+
* @remarks
|
|
76035
|
+
* [Api set: WordApiOnline 1.1]
|
|
76036
|
+
*
|
|
76037
|
+
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
76038
|
+
*/
|
|
76039
|
+
getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;
|
|
76040
|
+
/**
|
|
76041
|
+
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
76042
|
+
*
|
|
76043
|
+
* @remarks
|
|
76044
|
+
* [Api set: WordApiOnline 1.1]
|
|
76045
|
+
*
|
|
76046
|
+
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
76047
|
+
*/
|
|
76048
|
+
getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
|
|
76049
|
+
/**
|
|
76050
|
+
* Gets the text ranges in the content control by using punctuation marks and/or other ending marks.
|
|
76051
|
+
*
|
|
76052
|
+
* @remarks
|
|
76053
|
+
* [Api set: WordApi 1.3]
|
|
76054
|
+
*
|
|
76055
|
+
* @param endingMarks Required. The punctuation marks and/or other ending marks as an array of strings.
|
|
76056
|
+
* @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection.
|
|
76057
|
+
*/
|
|
76058
|
+
getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection;
|
|
76059
|
+
/**
|
|
76060
|
+
* Inserts a break at the specified location in the main document. This method cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls.
|
|
76061
|
+
*
|
|
76062
|
+
* @remarks
|
|
76063
|
+
* [Api set: WordApi 1.1]
|
|
76064
|
+
*
|
|
76065
|
+
* @param breakType Required. Type of break.
|
|
76066
|
+
* @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'.
|
|
75499
76067
|
*/
|
|
75500
76068
|
insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void;
|
|
75501
76069
|
/**
|
|
@@ -76048,6 +76616,13 @@ declare namespace Word {
|
|
|
76048
76616
|
* [Api set: WordApi 1.1]
|
|
76049
76617
|
*/
|
|
76050
76618
|
readonly sections: Word.SectionCollection;
|
|
76619
|
+
/**
|
|
76620
|
+
* Gets or sets the ChangeTracking mode.
|
|
76621
|
+
*
|
|
76622
|
+
* @remarks
|
|
76623
|
+
* [Api set: WordApiOnline 1.1]
|
|
76624
|
+
*/
|
|
76625
|
+
changeTrackingMode: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly";
|
|
76051
76626
|
/**
|
|
76052
76627
|
* Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. Read-only.
|
|
76053
76628
|
*
|
|
@@ -76063,6 +76638,22 @@ declare namespace Word {
|
|
|
76063
76638
|
set(properties: Interfaces.DocumentUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
76064
76639
|
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
76065
76640
|
set(properties: Word.Document): void;
|
|
76641
|
+
/**
|
|
76642
|
+
* Gets the document's endnotes in a single body. Read-only.
|
|
76643
|
+
Not implemented in Word on the web.
|
|
76644
|
+
*
|
|
76645
|
+
* @remarks
|
|
76646
|
+
* [Api set: WordApiOnline 1.1]
|
|
76647
|
+
*/
|
|
76648
|
+
getEndnoteBody(): Word.Body;
|
|
76649
|
+
/**
|
|
76650
|
+
* Gets the document's footnotes in a single body. Read-only.
|
|
76651
|
+
Not implemented in Word on the web.
|
|
76652
|
+
*
|
|
76653
|
+
* @remarks
|
|
76654
|
+
* [Api set: WordApiOnline 1.1]
|
|
76655
|
+
*/
|
|
76656
|
+
getFootnoteBody(): Word.Body;
|
|
76066
76657
|
/**
|
|
76067
76658
|
* Gets the current selection of the document. Multiple selections are not supported.
|
|
76068
76659
|
*
|
|
@@ -76077,6 +76668,21 @@ declare namespace Word {
|
|
|
76077
76668
|
* [Api set: WordApi 1.1]
|
|
76078
76669
|
*/
|
|
76079
76670
|
save(): void;
|
|
76671
|
+
/**
|
|
76672
|
+
* Performs a search with the specified search options on the scope of the whole document. The search results are a collection of range objects.
|
|
76673
|
+
*
|
|
76674
|
+
* @remarks
|
|
76675
|
+
* [Api set: WordApiOnline 1.1]
|
|
76676
|
+
*/
|
|
76677
|
+
search(searchText: string, searchOptions?: Word.SearchOptions | {
|
|
76678
|
+
ignorePunct?: boolean;
|
|
76679
|
+
ignoreSpace?: boolean;
|
|
76680
|
+
matchCase?: boolean;
|
|
76681
|
+
matchPrefix?: boolean;
|
|
76682
|
+
matchSuffix?: boolean;
|
|
76683
|
+
matchWholeWord?: boolean;
|
|
76684
|
+
matchWildcards?: boolean;
|
|
76685
|
+
}): Word.RangeCollection;
|
|
76080
76686
|
/**
|
|
76081
76687
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
76082
76688
|
*
|
|
@@ -77313,6 +77919,157 @@ declare namespace Word {
|
|
|
77313
77919
|
*/
|
|
77314
77920
|
toJSON(): Word.Interfaces.ListItemData;
|
|
77315
77921
|
}
|
|
77922
|
+
/**
|
|
77923
|
+
* Represents a footnote or endnote.
|
|
77924
|
+
*
|
|
77925
|
+
* @remarks
|
|
77926
|
+
* [Api set: WordApiOnline 1.1]
|
|
77927
|
+
*/
|
|
77928
|
+
class NoteItem extends OfficeExtension.ClientObject {
|
|
77929
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
77930
|
+
context: RequestContext;
|
|
77931
|
+
/**
|
|
77932
|
+
* Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
|
|
77933
|
+
*
|
|
77934
|
+
* @remarks
|
|
77935
|
+
* [Api set: WordApiOnline 1.1]
|
|
77936
|
+
*/
|
|
77937
|
+
readonly body: Word.Body;
|
|
77938
|
+
/**
|
|
77939
|
+
* Represents a footnote or endnote reference in the main document.
|
|
77940
|
+
*
|
|
77941
|
+
* @remarks
|
|
77942
|
+
* [Api set: WordApiOnline 1.1]
|
|
77943
|
+
*/
|
|
77944
|
+
readonly reference: Word.Range;
|
|
77945
|
+
/**
|
|
77946
|
+
* Represents the note item type: footnote or endnote.
|
|
77947
|
+
*
|
|
77948
|
+
* @remarks
|
|
77949
|
+
* [Api set: WordApiOnline 1.1]
|
|
77950
|
+
*/
|
|
77951
|
+
readonly type: Word.NoteItemType | "Footnote" | "Endnote";
|
|
77952
|
+
/**
|
|
77953
|
+
* Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
|
|
77954
|
+
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
77955
|
+
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
77956
|
+
*/
|
|
77957
|
+
set(properties: Interfaces.NoteItemUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
77958
|
+
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
77959
|
+
set(properties: Word.NoteItem): void;
|
|
77960
|
+
/**
|
|
77961
|
+
* Deletes the note item.
|
|
77962
|
+
*
|
|
77963
|
+
* @remarks
|
|
77964
|
+
* [Api set: WordApiOnline 1.1]
|
|
77965
|
+
*/
|
|
77966
|
+
delete(): void;
|
|
77967
|
+
/**
|
|
77968
|
+
* Gets the next note item of the same type. Throws an error if this note item is the last one.
|
|
77969
|
+
*
|
|
77970
|
+
* @remarks
|
|
77971
|
+
* [Api set: WordApiOnline 1.1]
|
|
77972
|
+
*/
|
|
77973
|
+
getNext(): Word.NoteItem;
|
|
77974
|
+
/**
|
|
77975
|
+
* Gets the next note item of the same type. Returns a null object if this note item is the last one.
|
|
77976
|
+
*
|
|
77977
|
+
* @remarks
|
|
77978
|
+
* [Api set: WordApiOnline 1.1]
|
|
77979
|
+
*/
|
|
77980
|
+
getNextOrNullObject(): Word.NoteItem;
|
|
77981
|
+
/**
|
|
77982
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
77983
|
+
*
|
|
77984
|
+
* @param options Provides options for which properties of the object to load.
|
|
77985
|
+
*/
|
|
77986
|
+
load(options?: Word.Interfaces.NoteItemLoadOptions): Word.NoteItem;
|
|
77987
|
+
/**
|
|
77988
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
77989
|
+
*
|
|
77990
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
77991
|
+
*/
|
|
77992
|
+
load(propertyNames?: string | string[]): Word.NoteItem;
|
|
77993
|
+
/**
|
|
77994
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
77995
|
+
*
|
|
77996
|
+
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
77997
|
+
*/
|
|
77998
|
+
load(propertyNamesAndPaths?: {
|
|
77999
|
+
select?: string;
|
|
78000
|
+
expand?: string;
|
|
78001
|
+
}): Word.NoteItem;
|
|
78002
|
+
/**
|
|
78003
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
|
|
78004
|
+
*/
|
|
78005
|
+
track(): Word.NoteItem;
|
|
78006
|
+
/**
|
|
78007
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `context.trackedObjects.remove(thisObject)`. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
78008
|
+
*/
|
|
78009
|
+
untrack(): Word.NoteItem;
|
|
78010
|
+
/**
|
|
78011
|
+
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
78012
|
+
* Whereas the original Word.NoteItem object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.NoteItemData`) that contains shallow copies of any loaded child properties from the original object.
|
|
78013
|
+
*/
|
|
78014
|
+
toJSON(): Word.Interfaces.NoteItemData;
|
|
78015
|
+
}
|
|
78016
|
+
/**
|
|
78017
|
+
* Contains a collection of {@link Word.NoteItem} objects.
|
|
78018
|
+
*
|
|
78019
|
+
* @remarks
|
|
78020
|
+
* [Api set: WordApiOnline 1.1]
|
|
78021
|
+
*/
|
|
78022
|
+
class NoteItemCollection extends OfficeExtension.ClientObject {
|
|
78023
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
78024
|
+
context: RequestContext;
|
|
78025
|
+
/** Gets the loaded child items in this collection. */
|
|
78026
|
+
readonly items: Word.NoteItem[];
|
|
78027
|
+
/**
|
|
78028
|
+
* Gets the first note item in this collection. Throws an error if this collection is empty.
|
|
78029
|
+
*
|
|
78030
|
+
* @remarks
|
|
78031
|
+
* [Api set: WordApiOnline 1.1]
|
|
78032
|
+
*/
|
|
78033
|
+
getFirst(): Word.NoteItem;
|
|
78034
|
+
/**
|
|
78035
|
+
* Gets the first note item in this collection. Returns a null object if this collection is empty.
|
|
78036
|
+
*
|
|
78037
|
+
* @remarks
|
|
78038
|
+
* [Api set: WordApiOnline 1.1]
|
|
78039
|
+
*/
|
|
78040
|
+
getFirstOrNullObject(): Word.NoteItem;
|
|
78041
|
+
/**
|
|
78042
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
78043
|
+
*
|
|
78044
|
+
* @param options Provides options for which properties of the object to load.
|
|
78045
|
+
*/
|
|
78046
|
+
load(options?: Word.Interfaces.NoteItemCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.NoteItemCollection;
|
|
78047
|
+
/**
|
|
78048
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
78049
|
+
*
|
|
78050
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
78051
|
+
*/
|
|
78052
|
+
load(propertyNames?: string | string[]): Word.NoteItemCollection;
|
|
78053
|
+
/**
|
|
78054
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
78055
|
+
*
|
|
78056
|
+
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
78057
|
+
*/
|
|
78058
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.NoteItemCollection;
|
|
78059
|
+
/**
|
|
78060
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
|
|
78061
|
+
*/
|
|
78062
|
+
track(): Word.NoteItemCollection;
|
|
78063
|
+
/**
|
|
78064
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `context.trackedObjects.remove(thisObject)`. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
78065
|
+
*/
|
|
78066
|
+
untrack(): Word.NoteItemCollection;
|
|
78067
|
+
/**
|
|
78068
|
+
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
78069
|
+
* Whereas the original `Word.NoteItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.NoteItemCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
78070
|
+
*/
|
|
78071
|
+
toJSON(): Word.Interfaces.NoteItemCollectionData;
|
|
78072
|
+
}
|
|
77316
78073
|
/**
|
|
77317
78074
|
* Represents a single paragraph in a selection, range, content control, or document body.
|
|
77318
78075
|
*
|
|
@@ -77329,6 +78086,13 @@ declare namespace Word {
|
|
|
77329
78086
|
* [Api set: WordApi 1.1]
|
|
77330
78087
|
*/
|
|
77331
78088
|
readonly contentControls: Word.ContentControlCollection;
|
|
78089
|
+
/**
|
|
78090
|
+
* Gets the collection of endnotes in the paragraph. Read-only.
|
|
78091
|
+
*
|
|
78092
|
+
* @remarks
|
|
78093
|
+
* [Api set: WordApiOnline 1.1]
|
|
78094
|
+
*/
|
|
78095
|
+
readonly endnotes: Word.NoteItemCollection;
|
|
77332
78096
|
/**
|
|
77333
78097
|
* Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. Read-only.
|
|
77334
78098
|
*
|
|
@@ -77336,6 +78100,13 @@ declare namespace Word {
|
|
|
77336
78100
|
* [Api set: WordApi 1.1]
|
|
77337
78101
|
*/
|
|
77338
78102
|
readonly font: Word.Font;
|
|
78103
|
+
/**
|
|
78104
|
+
* Gets the collection of footnotes in the paragraph. Read-only.
|
|
78105
|
+
*
|
|
78106
|
+
* @remarks
|
|
78107
|
+
* [Api set: WordApiOnline 1.1]
|
|
78108
|
+
*/
|
|
78109
|
+
readonly footnotes: Word.NoteItemCollection;
|
|
77339
78110
|
/**
|
|
77340
78111
|
* Gets the collection of InlinePicture objects in the paragraph. The collection does not include floating images. Read-only.
|
|
77341
78112
|
*
|
|
@@ -77571,6 +78342,13 @@ declare namespace Word {
|
|
|
77571
78342
|
* [Api set: WordApi 1.3]
|
|
77572
78343
|
*/
|
|
77573
78344
|
detachFromList(): void;
|
|
78345
|
+
/**
|
|
78346
|
+
* Gets comments associated with the paragraph.
|
|
78347
|
+
*
|
|
78348
|
+
* @remarks
|
|
78349
|
+
* [Api set: WordApiOnline 1.1]
|
|
78350
|
+
*/
|
|
78351
|
+
getComments(): Word.CommentCollection;
|
|
77574
78352
|
/**
|
|
77575
78353
|
* Gets an HTML representation of the paragraph object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Paragraph.getOoxml()` and convert the returned XML to HTML.
|
|
77576
78354
|
*
|
|
@@ -77631,6 +78409,24 @@ declare namespace Word {
|
|
|
77631
78409
|
* @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
|
|
77632
78410
|
*/
|
|
77633
78411
|
getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
|
|
78412
|
+
/**
|
|
78413
|
+
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
78414
|
+
*
|
|
78415
|
+
* @remarks
|
|
78416
|
+
* [Api set: WordApiOnline 1.1]
|
|
78417
|
+
*
|
|
78418
|
+
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
78419
|
+
*/
|
|
78420
|
+
getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;
|
|
78421
|
+
/**
|
|
78422
|
+
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
78423
|
+
*
|
|
78424
|
+
* @remarks
|
|
78425
|
+
* [Api set: WordApiOnline 1.1]
|
|
78426
|
+
*
|
|
78427
|
+
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
78428
|
+
*/
|
|
78429
|
+
getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
|
|
77634
78430
|
/**
|
|
77635
78431
|
* Gets the text ranges in the paragraph by using punctuation marks and/or other ending marks.
|
|
77636
78432
|
*
|
|
@@ -77988,6 +78784,13 @@ declare namespace Word {
|
|
|
77988
78784
|
* [Api set: WordApi 1.1]
|
|
77989
78785
|
*/
|
|
77990
78786
|
readonly contentControls: Word.ContentControlCollection;
|
|
78787
|
+
/**
|
|
78788
|
+
* Gets the collection of endnotes in the range. Read-only.
|
|
78789
|
+
*
|
|
78790
|
+
* @remarks
|
|
78791
|
+
* [Api set: WordApiOnline 1.1]
|
|
78792
|
+
*/
|
|
78793
|
+
readonly endnotes: Word.NoteItemCollection;
|
|
77991
78794
|
/**
|
|
77992
78795
|
* Gets the text format of the range. Use this to get and set font name, size, color, and other properties. Read-only.
|
|
77993
78796
|
*
|
|
@@ -77995,6 +78798,13 @@ declare namespace Word {
|
|
|
77995
78798
|
* [Api set: WordApi 1.1]
|
|
77996
78799
|
*/
|
|
77997
78800
|
readonly font: Word.Font;
|
|
78801
|
+
/**
|
|
78802
|
+
* Gets the collection of footnotes in the range. Read-only.
|
|
78803
|
+
*
|
|
78804
|
+
* @remarks
|
|
78805
|
+
* [Api set: WordApiOnline 1.1]
|
|
78806
|
+
*/
|
|
78807
|
+
readonly footnotes: Word.NoteItemCollection;
|
|
77998
78808
|
/**
|
|
77999
78809
|
* Gets the collection of inline picture objects in the range. Read-only.
|
|
78000
78810
|
*
|
|
@@ -78156,6 +78966,14 @@ declare namespace Word {
|
|
|
78156
78966
|
* @param range Required. Another range.
|
|
78157
78967
|
*/
|
|
78158
78968
|
expandToOrNullObject(range: Word.Range): Word.Range;
|
|
78969
|
+
/**
|
|
78970
|
+
* Gets comments associated with the range.
|
|
78971
|
+
*
|
|
78972
|
+
* @remarks
|
|
78973
|
+
* [Api set: WordApiOnline 1.1]
|
|
78974
|
+
* @returns
|
|
78975
|
+
*/
|
|
78976
|
+
getComments(): Word.CommentCollection;
|
|
78159
78977
|
/**
|
|
78160
78978
|
* Gets an HTML representation of the range object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Range.getOoxml()` and convert the returned XML to HTML.
|
|
78161
78979
|
*
|
|
@@ -78215,6 +79033,24 @@ declare namespace Word {
|
|
|
78215
79033
|
* @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
|
|
78216
79034
|
*/
|
|
78217
79035
|
getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
|
|
79036
|
+
/**
|
|
79037
|
+
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
79038
|
+
*
|
|
79039
|
+
* @remarks
|
|
79040
|
+
* [Api set: WordApiOnline 1.1]
|
|
79041
|
+
*
|
|
79042
|
+
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
79043
|
+
*/
|
|
79044
|
+
getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;
|
|
79045
|
+
/**
|
|
79046
|
+
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
79047
|
+
*
|
|
79048
|
+
* @remarks
|
|
79049
|
+
* [Api set: WordApiOnline 1.1]
|
|
79050
|
+
*
|
|
79051
|
+
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
79052
|
+
*/
|
|
79053
|
+
getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
|
|
78218
79054
|
/**
|
|
78219
79055
|
* Gets the text child ranges in the range by using punctuation marks and/or other ending marks.
|
|
78220
79056
|
*
|
|
@@ -78245,6 +79081,16 @@ declare namespace Word {
|
|
|
78245
79081
|
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
78246
79082
|
*/
|
|
78247
79083
|
insertBreak(breakType: "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): void;
|
|
79084
|
+
/**
|
|
79085
|
+
* Insert a comment on the range.
|
|
79086
|
+
*
|
|
79087
|
+
* @remarks
|
|
79088
|
+
* [Api set: WordApiOnline 1.1]
|
|
79089
|
+
*
|
|
79090
|
+
* @param commentText Required. The comment text to be inserted.
|
|
79091
|
+
* @returns comment object
|
|
79092
|
+
*/
|
|
79093
|
+
insertComment(commentText: string): Word.Comment;
|
|
78248
79094
|
/**
|
|
78249
79095
|
* Wraps the range object with a rich text content control.
|
|
78250
79096
|
*
|
|
@@ -78252,6 +79098,15 @@ declare namespace Word {
|
|
|
78252
79098
|
* [Api set: WordApi 1.1]
|
|
78253
79099
|
*/
|
|
78254
79100
|
insertContentControl(): Word.ContentControl;
|
|
79101
|
+
/**
|
|
79102
|
+
* Inserts an endnote. The endnote reference is placed after the range.
|
|
79103
|
+
*
|
|
79104
|
+
* @remarks
|
|
79105
|
+
* [Api set: WordApiOnline 1.1]
|
|
79106
|
+
*
|
|
79107
|
+
* @param insertText Optional. Text to be inserted into the endnote body. The default is "".
|
|
79108
|
+
*/
|
|
79109
|
+
insertEndnote(insertText?: string): Word.NoteItem;
|
|
78255
79110
|
/**
|
|
78256
79111
|
* Inserts a document at the specified location.
|
|
78257
79112
|
*
|
|
@@ -78272,6 +79127,15 @@ declare namespace Word {
|
|
|
78272
79127
|
* @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
|
|
78273
79128
|
*/
|
|
78274
79129
|
insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
|
|
79130
|
+
/**
|
|
79131
|
+
* Inserts a footnote. The footnote reference is placed after the range.
|
|
79132
|
+
*
|
|
79133
|
+
* @remarks
|
|
79134
|
+
* [Api set: WordApiOnline 1.1]
|
|
79135
|
+
*
|
|
79136
|
+
* @param insertText Optional. Text to be inserted into the footnote body. The default is "".
|
|
79137
|
+
*/
|
|
79138
|
+
insertFootnote(insertText?: string): Word.NoteItem;
|
|
78275
79139
|
/**
|
|
78276
79140
|
* Inserts HTML at the specified location.
|
|
78277
79141
|
*
|
|
@@ -78828,6 +79692,13 @@ declare namespace Word {
|
|
|
78828
79692
|
class Table extends OfficeExtension.ClientObject {
|
|
78829
79693
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
78830
79694
|
context: RequestContext;
|
|
79695
|
+
/**
|
|
79696
|
+
* Gets the collection of endnotes in the table. Read-only.
|
|
79697
|
+
*
|
|
79698
|
+
* @remarks
|
|
79699
|
+
* [Api set: WordApiOnline 1.1]
|
|
79700
|
+
*/
|
|
79701
|
+
readonly endnotes: Word.NoteItemCollection;
|
|
78831
79702
|
/**
|
|
78832
79703
|
* Gets the font. Use this to get and set font name, size, color, and other properties. Read-only.
|
|
78833
79704
|
*
|
|
@@ -78835,6 +79706,13 @@ declare namespace Word {
|
|
|
78835
79706
|
* [Api set: WordApi 1.3]
|
|
78836
79707
|
*/
|
|
78837
79708
|
readonly font: Word.Font;
|
|
79709
|
+
/**
|
|
79710
|
+
* Gets the collection of footnotes in the table. Read-only.
|
|
79711
|
+
*
|
|
79712
|
+
* @remarks
|
|
79713
|
+
* [Api set: WordApiOnline 1.1]
|
|
79714
|
+
*/
|
|
79715
|
+
readonly footnotes: Word.NoteItemCollection;
|
|
78838
79716
|
/**
|
|
78839
79717
|
* Gets the parent body of the table. Read-only.
|
|
78840
79718
|
*
|
|
@@ -79448,6 +80326,13 @@ declare namespace Word {
|
|
|
79448
80326
|
* [Api set: WordApi 1.3]
|
|
79449
80327
|
*/
|
|
79450
80328
|
readonly cells: Word.TableCellCollection;
|
|
80329
|
+
/**
|
|
80330
|
+
* Gets the collection of endnotes in the table row. Read-only.
|
|
80331
|
+
*
|
|
80332
|
+
* @remarks
|
|
80333
|
+
* [Api set: WordApiOnline 1.1]
|
|
80334
|
+
*/
|
|
80335
|
+
readonly endnotes: Word.NoteItemCollection;
|
|
79451
80336
|
/**
|
|
79452
80337
|
* Gets the font. Use this to get and set font name, size, color, and other properties. Read-only.
|
|
79453
80338
|
*
|
|
@@ -79455,6 +80340,13 @@ declare namespace Word {
|
|
|
79455
80340
|
* [Api set: WordApi 1.3]
|
|
79456
80341
|
*/
|
|
79457
80342
|
readonly font: Word.Font;
|
|
80343
|
+
/**
|
|
80344
|
+
* Gets the collection of footnotes in the table row. Read-only.
|
|
80345
|
+
*
|
|
80346
|
+
* @remarks
|
|
80347
|
+
* [Api set: WordApiOnline 1.1]
|
|
80348
|
+
*/
|
|
80349
|
+
readonly footnotes: Word.NoteItemCollection;
|
|
79458
80350
|
/**
|
|
79459
80351
|
* Gets parent table. Read-only.
|
|
79460
80352
|
*
|
|
@@ -80134,18 +81026,80 @@ declare namespace Word {
|
|
|
80134
81026
|
expand?: string;
|
|
80135
81027
|
}): Word.TableBorder;
|
|
80136
81028
|
/**
|
|
80137
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
|
|
81029
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
|
|
81030
|
+
*/
|
|
81031
|
+
track(): Word.TableBorder;
|
|
81032
|
+
/**
|
|
81033
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `context.trackedObjects.remove(thisObject)`. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
81034
|
+
*/
|
|
81035
|
+
untrack(): Word.TableBorder;
|
|
81036
|
+
/**
|
|
81037
|
+
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
81038
|
+
* Whereas the original Word.TableBorder object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableBorderData`) that contains shallow copies of any loaded child properties from the original object.
|
|
81039
|
+
*/
|
|
81040
|
+
toJSON(): Word.Interfaces.TableBorderData;
|
|
81041
|
+
}
|
|
81042
|
+
/**
|
|
81043
|
+
* ChangeTracking mode.
|
|
81044
|
+
*
|
|
81045
|
+
* @remarks
|
|
81046
|
+
* [Api set: WordApiOnline 1.1]
|
|
81047
|
+
*/
|
|
81048
|
+
enum ChangeTrackingMode {
|
|
81049
|
+
/**
|
|
81050
|
+
* ChangeTracking is turned off.
|
|
81051
|
+
* @remarks
|
|
81052
|
+
* [Api set: WordApiOnline 1.1]
|
|
81053
|
+
*/
|
|
81054
|
+
off = "Off",
|
|
81055
|
+
/**
|
|
81056
|
+
* ChangeTracking is turned on for everyone.
|
|
81057
|
+
* @remarks
|
|
81058
|
+
* [Api set: WordApiOnline 1.1]
|
|
81059
|
+
*/
|
|
81060
|
+
trackAll = "TrackAll",
|
|
81061
|
+
/**
|
|
81062
|
+
* Tracking is turned on for my changes only.
|
|
81063
|
+
* @remarks
|
|
81064
|
+
* [Api set: WordApiOnline 1.1]
|
|
81065
|
+
*/
|
|
81066
|
+
trackMineOnly = "TrackMineOnly",
|
|
81067
|
+
}
|
|
81068
|
+
/**
|
|
81069
|
+
* Specify the current version or the original version of the text.
|
|
81070
|
+
*
|
|
81071
|
+
* @remarks
|
|
81072
|
+
* [Api set: WordApiOnline 1.1]
|
|
81073
|
+
*/
|
|
81074
|
+
enum ChangeTrackingVersion {
|
|
81075
|
+
/**
|
|
81076
|
+
* @remarks
|
|
81077
|
+
* [Api set: WordApiOnline 1.1]
|
|
80138
81078
|
*/
|
|
80139
|
-
|
|
81079
|
+
original = "Original",
|
|
80140
81080
|
/**
|
|
80141
|
-
*
|
|
81081
|
+
* @remarks
|
|
81082
|
+
* [Api set: WordApiOnline 1.1]
|
|
80142
81083
|
*/
|
|
80143
|
-
|
|
81084
|
+
current = "Current",
|
|
81085
|
+
}
|
|
81086
|
+
/**
|
|
81087
|
+
* Note item type
|
|
81088
|
+
*
|
|
81089
|
+
* @remarks
|
|
81090
|
+
* [Api set: WordApiOnline 1.1]
|
|
81091
|
+
*/
|
|
81092
|
+
enum NoteItemType {
|
|
80144
81093
|
/**
|
|
80145
|
-
|
|
80146
|
-
|
|
80147
|
-
|
|
80148
|
-
|
|
81094
|
+
* @remarks
|
|
81095
|
+
* [Api set: WordApiOnline 1.1]
|
|
81096
|
+
*/
|
|
81097
|
+
footnote = "Footnote",
|
|
81098
|
+
/**
|
|
81099
|
+
* @remarks
|
|
81100
|
+
* [Api set: WordApiOnline 1.1]
|
|
81101
|
+
*/
|
|
81102
|
+
endnote = "Endnote",
|
|
80149
81103
|
}
|
|
80150
81104
|
/**
|
|
80151
81105
|
* Provides information about the type of a raised event. For each object type, please keep the order of: deleted, selection changed, data changed, added.
|
|
@@ -80645,6 +81599,21 @@ declare namespace Word {
|
|
|
80645
81599
|
* [Api set: WordApi 1.3]
|
|
80646
81600
|
*/
|
|
80647
81601
|
tableCell = "TableCell",
|
|
81602
|
+
/**
|
|
81603
|
+
* @remarks
|
|
81604
|
+
* [Api set: WordApiOnline 1.1]
|
|
81605
|
+
*/
|
|
81606
|
+
footnote = "Footnote",
|
|
81607
|
+
/**
|
|
81608
|
+
* @remarks
|
|
81609
|
+
* [Api set: WordApiOnline 1.1]
|
|
81610
|
+
*/
|
|
81611
|
+
endnote = "Endnote",
|
|
81612
|
+
/**
|
|
81613
|
+
* @remarks
|
|
81614
|
+
* [Api set: WordApiOnline 1.1]
|
|
81615
|
+
*/
|
|
81616
|
+
noteItem = "NoteItem",
|
|
80648
81617
|
}
|
|
80649
81618
|
/**
|
|
80650
81619
|
* This enum sets where the cursor (insertion point) in the document is after a selection.
|
|
@@ -81962,6 +82931,100 @@ declare namespace Word {
|
|
|
81962
82931
|
*/
|
|
81963
82932
|
styleBuiltIn?: Word.Style | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6";
|
|
81964
82933
|
}
|
|
82934
|
+
/** An interface for updating data on the Comment object, for use in `comment.set({ ... })`. */
|
|
82935
|
+
interface CommentUpdateData {
|
|
82936
|
+
/**
|
|
82937
|
+
* Gets or sets the comment's content range.
|
|
82938
|
+
*
|
|
82939
|
+
* @remarks
|
|
82940
|
+
* [Api set: WordApiOnline 1.1]
|
|
82941
|
+
*/
|
|
82942
|
+
contentRange?: Word.Interfaces.CommentContentRangeUpdateData;
|
|
82943
|
+
/**
|
|
82944
|
+
* Gets or sets the comment's content as plain text.
|
|
82945
|
+
*
|
|
82946
|
+
* @remarks
|
|
82947
|
+
* [Api set: WordApiOnline 1.1]
|
|
82948
|
+
*/
|
|
82949
|
+
content?: string;
|
|
82950
|
+
/**
|
|
82951
|
+
* 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.
|
|
82952
|
+
*
|
|
82953
|
+
* @remarks
|
|
82954
|
+
* [Api set: WordApiOnline 1.1]
|
|
82955
|
+
*/
|
|
82956
|
+
resolved?: boolean;
|
|
82957
|
+
}
|
|
82958
|
+
/** An interface for updating data on the CommentCollection object, for use in `commentCollection.set({ ... })`. */
|
|
82959
|
+
interface CommentCollectionUpdateData {
|
|
82960
|
+
items?: Word.Interfaces.CommentData[];
|
|
82961
|
+
}
|
|
82962
|
+
/** An interface for updating data on the CommentContentRange object, for use in `commentContentRange.set({ ... })`. */
|
|
82963
|
+
interface CommentContentRangeUpdateData {
|
|
82964
|
+
/**
|
|
82965
|
+
* Gets or sets a value that indicates whether the comment text is bold.
|
|
82966
|
+
*
|
|
82967
|
+
* @remarks
|
|
82968
|
+
* [Api set: WordApiOnline 1.1]
|
|
82969
|
+
*/
|
|
82970
|
+
bold?: boolean;
|
|
82971
|
+
/**
|
|
82972
|
+
* 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.
|
|
82973
|
+
*
|
|
82974
|
+
* @remarks
|
|
82975
|
+
* [Api set: WordApiOnline 1.1]
|
|
82976
|
+
*/
|
|
82977
|
+
hyperlink?: string;
|
|
82978
|
+
/**
|
|
82979
|
+
* Gets or sets a value that indicates whether the comment text is italicized.
|
|
82980
|
+
*
|
|
82981
|
+
* @remarks
|
|
82982
|
+
* [Api set: WordApiOnline 1.1]
|
|
82983
|
+
*/
|
|
82984
|
+
italic?: boolean;
|
|
82985
|
+
/**
|
|
82986
|
+
* Gets or sets a value that indicates whether the comment text has a strikethrough.
|
|
82987
|
+
*
|
|
82988
|
+
* @remarks
|
|
82989
|
+
* [Api set: WordApiOnline 1.1]
|
|
82990
|
+
*/
|
|
82991
|
+
strikeThrough?: boolean;
|
|
82992
|
+
/**
|
|
82993
|
+
* Gets or sets a value that indicates the comment text's underline type. 'None' if the comment text is not underlined.
|
|
82994
|
+
*
|
|
82995
|
+
* @remarks
|
|
82996
|
+
* [Api set: WordApiOnline 1.1]
|
|
82997
|
+
*/
|
|
82998
|
+
underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble";
|
|
82999
|
+
}
|
|
83000
|
+
/** An interface for updating data on the CommentReply object, for use in `commentReply.set({ ... })`. */
|
|
83001
|
+
interface CommentReplyUpdateData {
|
|
83002
|
+
/**
|
|
83003
|
+
* Gets or sets the commentReply's content range.
|
|
83004
|
+
*
|
|
83005
|
+
* @remarks
|
|
83006
|
+
* [Api set: WordApiOnline 1.1]
|
|
83007
|
+
*/
|
|
83008
|
+
contentRange?: Word.Interfaces.CommentContentRangeUpdateData;
|
|
83009
|
+
/**
|
|
83010
|
+
* Gets the parent comment of this reply.
|
|
83011
|
+
*
|
|
83012
|
+
* @remarks
|
|
83013
|
+
* [Api set: WordApiOnline 1.1]
|
|
83014
|
+
*/
|
|
83015
|
+
parentComment?: Word.Interfaces.CommentUpdateData;
|
|
83016
|
+
/**
|
|
83017
|
+
* Gets or sets the comment reply's content. The string is plain text.
|
|
83018
|
+
*
|
|
83019
|
+
* @remarks
|
|
83020
|
+
* [Api set: WordApiOnline 1.1]
|
|
83021
|
+
*/
|
|
83022
|
+
content?: string;
|
|
83023
|
+
}
|
|
83024
|
+
/** An interface for updating data on the CommentReplyCollection object, for use in `commentReplyCollection.set({ ... })`. */
|
|
83025
|
+
interface CommentReplyCollectionUpdateData {
|
|
83026
|
+
items?: Word.Interfaces.CommentReplyData[];
|
|
83027
|
+
}
|
|
81965
83028
|
/** An interface for updating data on the ContentControl object, for use in `contentControl.set({ ... })`. */
|
|
81966
83029
|
interface ContentControlUpdateData {
|
|
81967
83030
|
/**
|
|
@@ -82077,6 +83140,13 @@ declare namespace Word {
|
|
|
82077
83140
|
* [Api set: WordApi 1.3]
|
|
82078
83141
|
*/
|
|
82079
83142
|
properties?: Word.Interfaces.DocumentPropertiesUpdateData;
|
|
83143
|
+
/**
|
|
83144
|
+
* Gets or sets the ChangeTracking mode.
|
|
83145
|
+
*
|
|
83146
|
+
* @remarks
|
|
83147
|
+
* [Api set: WordApiOnline 1.1]
|
|
83148
|
+
*/
|
|
83149
|
+
changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly";
|
|
82080
83150
|
}
|
|
82081
83151
|
/** An interface for updating data on the DocumentCreated object, for use in `documentCreated.set({ ... })`. */
|
|
82082
83152
|
interface DocumentCreatedUpdateData {
|
|
@@ -82305,6 +83375,27 @@ declare namespace Word {
|
|
|
82305
83375
|
*/
|
|
82306
83376
|
level?: number;
|
|
82307
83377
|
}
|
|
83378
|
+
/** An interface for updating data on the NoteItem object, for use in `noteItem.set({ ... })`. */
|
|
83379
|
+
interface NoteItemUpdateData {
|
|
83380
|
+
/**
|
|
83381
|
+
* Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
|
|
83382
|
+
*
|
|
83383
|
+
* @remarks
|
|
83384
|
+
* [Api set: WordApiOnline 1.1]
|
|
83385
|
+
*/
|
|
83386
|
+
body?: Word.Interfaces.BodyUpdateData;
|
|
83387
|
+
/**
|
|
83388
|
+
* Represents a footnote or endnote reference in the main document.
|
|
83389
|
+
*
|
|
83390
|
+
* @remarks
|
|
83391
|
+
* [Api set: WordApiOnline 1.1]
|
|
83392
|
+
*/
|
|
83393
|
+
reference?: Word.Interfaces.RangeUpdateData;
|
|
83394
|
+
}
|
|
83395
|
+
/** An interface for updating data on the NoteItemCollection object, for use in `noteItemCollection.set({ ... })`. */
|
|
83396
|
+
interface NoteItemCollectionUpdateData {
|
|
83397
|
+
items?: Word.Interfaces.NoteItemData[];
|
|
83398
|
+
}
|
|
82308
83399
|
/** An interface for updating data on the Paragraph object, for use in `paragraph.set({ ... })`. */
|
|
82309
83400
|
interface ParagraphUpdateData {
|
|
82310
83401
|
/**
|
|
@@ -82823,7 +83914,178 @@ declare namespace Word {
|
|
|
82823
83914
|
* @remarks
|
|
82824
83915
|
* [Api set: WordApi 1.3]
|
|
82825
83916
|
*/
|
|
82826
|
-
type?: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell";
|
|
83917
|
+
type?: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" | "Footnote" | "Endnote" | "NoteItem";
|
|
83918
|
+
}
|
|
83919
|
+
/** An interface describing the data returned by calling `comment.toJSON()`. */
|
|
83920
|
+
interface CommentData {
|
|
83921
|
+
/**
|
|
83922
|
+
* Gets or sets the comment's content range.
|
|
83923
|
+
*
|
|
83924
|
+
* @remarks
|
|
83925
|
+
* [Api set: WordApiOnline 1.1]
|
|
83926
|
+
*/
|
|
83927
|
+
contentRange?: Word.Interfaces.CommentContentRangeData;
|
|
83928
|
+
/**
|
|
83929
|
+
* Gets the collection of reply objects associated with the comment.
|
|
83930
|
+
*
|
|
83931
|
+
* @remarks
|
|
83932
|
+
* [Api set: WordApiOnline 1.1]
|
|
83933
|
+
*/
|
|
83934
|
+
replies?: Word.Interfaces.CommentReplyData[];
|
|
83935
|
+
/**
|
|
83936
|
+
* Gets the email of the comment's author.
|
|
83937
|
+
*
|
|
83938
|
+
* @remarks
|
|
83939
|
+
* [Api set: WordApiOnline 1.1]
|
|
83940
|
+
*/
|
|
83941
|
+
authorEmail?: string;
|
|
83942
|
+
/**
|
|
83943
|
+
* Gets the name of the comment's author.
|
|
83944
|
+
*
|
|
83945
|
+
* @remarks
|
|
83946
|
+
* [Api set: WordApiOnline 1.1]
|
|
83947
|
+
*/
|
|
83948
|
+
authorName?: string;
|
|
83949
|
+
/**
|
|
83950
|
+
* Gets or sets the comment's content as plain text.
|
|
83951
|
+
*
|
|
83952
|
+
* @remarks
|
|
83953
|
+
* [Api set: WordApiOnline 1.1]
|
|
83954
|
+
*/
|
|
83955
|
+
content?: string;
|
|
83956
|
+
/**
|
|
83957
|
+
* Gets the creation date of the comment.
|
|
83958
|
+
*
|
|
83959
|
+
* @remarks
|
|
83960
|
+
* [Api set: WordApiOnline 1.1]
|
|
83961
|
+
*/
|
|
83962
|
+
creationDate?: Date;
|
|
83963
|
+
/**
|
|
83964
|
+
* Gets the Id of the comment. Read-only.
|
|
83965
|
+
*
|
|
83966
|
+
* @remarks
|
|
83967
|
+
* [Api set: WordApiOnline 1.1]
|
|
83968
|
+
*/
|
|
83969
|
+
id?: string;
|
|
83970
|
+
/**
|
|
83971
|
+
* 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.
|
|
83972
|
+
*
|
|
83973
|
+
* @remarks
|
|
83974
|
+
* [Api set: WordApiOnline 1.1]
|
|
83975
|
+
*/
|
|
83976
|
+
resolved?: boolean;
|
|
83977
|
+
}
|
|
83978
|
+
/** An interface describing the data returned by calling `commentCollection.toJSON()`. */
|
|
83979
|
+
interface CommentCollectionData {
|
|
83980
|
+
items?: Word.Interfaces.CommentData[];
|
|
83981
|
+
}
|
|
83982
|
+
/** An interface describing the data returned by calling `commentContentRange.toJSON()`. */
|
|
83983
|
+
interface CommentContentRangeData {
|
|
83984
|
+
/**
|
|
83985
|
+
* Gets or sets a value that indicates whether the comment text is bold.
|
|
83986
|
+
*
|
|
83987
|
+
* @remarks
|
|
83988
|
+
* [Api set: WordApiOnline 1.1]
|
|
83989
|
+
*/
|
|
83990
|
+
bold?: boolean;
|
|
83991
|
+
/**
|
|
83992
|
+
* 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.
|
|
83993
|
+
*
|
|
83994
|
+
* @remarks
|
|
83995
|
+
* [Api set: WordApiOnline 1.1]
|
|
83996
|
+
*/
|
|
83997
|
+
hyperlink?: string;
|
|
83998
|
+
/**
|
|
83999
|
+
* Checks whether the range length is zero. Read-only.
|
|
84000
|
+
*
|
|
84001
|
+
* @remarks
|
|
84002
|
+
* [Api set: WordApiOnline 1.1]
|
|
84003
|
+
*/
|
|
84004
|
+
isEmpty?: boolean;
|
|
84005
|
+
/**
|
|
84006
|
+
* Gets or sets a value that indicates whether the comment text is italicized.
|
|
84007
|
+
*
|
|
84008
|
+
* @remarks
|
|
84009
|
+
* [Api set: WordApiOnline 1.1]
|
|
84010
|
+
*/
|
|
84011
|
+
italic?: boolean;
|
|
84012
|
+
/**
|
|
84013
|
+
* Gets or sets a value that indicates whether the comment text has a strikethrough.
|
|
84014
|
+
*
|
|
84015
|
+
* @remarks
|
|
84016
|
+
* [Api set: WordApiOnline 1.1]
|
|
84017
|
+
*/
|
|
84018
|
+
strikeThrough?: boolean;
|
|
84019
|
+
/**
|
|
84020
|
+
* Gets the text of the comment range. Read-only.
|
|
84021
|
+
*
|
|
84022
|
+
* @remarks
|
|
84023
|
+
* [Api set: WordApiOnline 1.1]
|
|
84024
|
+
*/
|
|
84025
|
+
text?: string;
|
|
84026
|
+
/**
|
|
84027
|
+
* Gets or sets a value that indicates the comment text's underline type. 'None' if the comment text is not underlined.
|
|
84028
|
+
*
|
|
84029
|
+
* @remarks
|
|
84030
|
+
* [Api set: WordApiOnline 1.1]
|
|
84031
|
+
*/
|
|
84032
|
+
underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble";
|
|
84033
|
+
}
|
|
84034
|
+
/** An interface describing the data returned by calling `commentReply.toJSON()`. */
|
|
84035
|
+
interface CommentReplyData {
|
|
84036
|
+
/**
|
|
84037
|
+
* Gets or sets the commentReply's content range.
|
|
84038
|
+
*
|
|
84039
|
+
* @remarks
|
|
84040
|
+
* [Api set: WordApiOnline 1.1]
|
|
84041
|
+
*/
|
|
84042
|
+
contentRange?: Word.Interfaces.CommentContentRangeData;
|
|
84043
|
+
/**
|
|
84044
|
+
* Gets the parent comment of this reply.
|
|
84045
|
+
*
|
|
84046
|
+
* @remarks
|
|
84047
|
+
* [Api set: WordApiOnline 1.1]
|
|
84048
|
+
*/
|
|
84049
|
+
parentComment?: Word.Interfaces.CommentData;
|
|
84050
|
+
/**
|
|
84051
|
+
* Gets the email of the comment reply's author.
|
|
84052
|
+
*
|
|
84053
|
+
* @remarks
|
|
84054
|
+
* [Api set: WordApiOnline 1.1]
|
|
84055
|
+
*/
|
|
84056
|
+
authorEmail?: string;
|
|
84057
|
+
/**
|
|
84058
|
+
* Gets the name of the comment reply's author.
|
|
84059
|
+
*
|
|
84060
|
+
* @remarks
|
|
84061
|
+
* [Api set: WordApiOnline 1.1]
|
|
84062
|
+
*/
|
|
84063
|
+
authorName?: string;
|
|
84064
|
+
/**
|
|
84065
|
+
* Gets or sets the comment reply's content. The string is plain text.
|
|
84066
|
+
*
|
|
84067
|
+
* @remarks
|
|
84068
|
+
* [Api set: WordApiOnline 1.1]
|
|
84069
|
+
*/
|
|
84070
|
+
content?: string;
|
|
84071
|
+
/**
|
|
84072
|
+
* Gets the creation date of the comment reply.
|
|
84073
|
+
*
|
|
84074
|
+
* @remarks
|
|
84075
|
+
* [Api set: WordApiOnline 1.1]
|
|
84076
|
+
*/
|
|
84077
|
+
creationDate?: Date;
|
|
84078
|
+
/**
|
|
84079
|
+
* Gets the Id of the comment reply. Read-only.
|
|
84080
|
+
*
|
|
84081
|
+
* @remarks
|
|
84082
|
+
* [Api set: WordApiOnline 1.1]
|
|
84083
|
+
*/
|
|
84084
|
+
id?: string;
|
|
84085
|
+
}
|
|
84086
|
+
/** An interface describing the data returned by calling `commentReplyCollection.toJSON()`. */
|
|
84087
|
+
interface CommentReplyCollectionData {
|
|
84088
|
+
items?: Word.Interfaces.CommentReplyData[];
|
|
82827
84089
|
}
|
|
82828
84090
|
/** An interface describing the data returned by calling `contentControl.toJSON()`. */
|
|
82829
84091
|
interface ContentControlData {
|
|
@@ -83031,6 +84293,13 @@ declare namespace Word {
|
|
|
83031
84293
|
* [Api set: WordApi 1.1]
|
|
83032
84294
|
*/
|
|
83033
84295
|
sections?: Word.Interfaces.SectionData[];
|
|
84296
|
+
/**
|
|
84297
|
+
* Gets or sets the ChangeTracking mode.
|
|
84298
|
+
*
|
|
84299
|
+
* @remarks
|
|
84300
|
+
* [Api set: WordApiOnline 1.1]
|
|
84301
|
+
*/
|
|
84302
|
+
changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly";
|
|
83034
84303
|
/**
|
|
83035
84304
|
* Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. Read-only.
|
|
83036
84305
|
*
|
|
@@ -83381,19 +84650,47 @@ declare namespace Word {
|
|
|
83381
84650
|
*/
|
|
83382
84651
|
level?: number;
|
|
83383
84652
|
/**
|
|
83384
|
-
* Gets the list item bullet, number, or picture as a string. Read-only.
|
|
83385
|
-
*
|
|
83386
|
-
* @remarks
|
|
83387
|
-
* [Api set: WordApi 1.3]
|
|
83388
|
-
*/
|
|
83389
|
-
listString?: string;
|
|
84653
|
+
* Gets the list item bullet, number, or picture as a string. Read-only.
|
|
84654
|
+
*
|
|
84655
|
+
* @remarks
|
|
84656
|
+
* [Api set: WordApi 1.3]
|
|
84657
|
+
*/
|
|
84658
|
+
listString?: string;
|
|
84659
|
+
/**
|
|
84660
|
+
* Gets the list item order number in relation to its siblings. Read-only.
|
|
84661
|
+
*
|
|
84662
|
+
* @remarks
|
|
84663
|
+
* [Api set: WordApi 1.3]
|
|
84664
|
+
*/
|
|
84665
|
+
siblingIndex?: number;
|
|
84666
|
+
}
|
|
84667
|
+
/** An interface describing the data returned by calling `noteItem.toJSON()`. */
|
|
84668
|
+
interface NoteItemData {
|
|
84669
|
+
/**
|
|
84670
|
+
* Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
|
|
84671
|
+
*
|
|
84672
|
+
* @remarks
|
|
84673
|
+
* [Api set: WordApiOnline 1.1]
|
|
84674
|
+
*/
|
|
84675
|
+
body?: Word.Interfaces.BodyData;
|
|
84676
|
+
/**
|
|
84677
|
+
* Represents a footnote or endnote reference in the main document.
|
|
84678
|
+
*
|
|
84679
|
+
* @remarks
|
|
84680
|
+
* [Api set: WordApiOnline 1.1]
|
|
84681
|
+
*/
|
|
84682
|
+
reference?: Word.Interfaces.RangeData;
|
|
83390
84683
|
/**
|
|
83391
|
-
*
|
|
84684
|
+
* Represents the note item type: footnote or endnote.
|
|
83392
84685
|
*
|
|
83393
84686
|
* @remarks
|
|
83394
|
-
* [Api set:
|
|
84687
|
+
* [Api set: WordApiOnline 1.1]
|
|
83395
84688
|
*/
|
|
83396
|
-
|
|
84689
|
+
type?: Word.NoteItemType | "Footnote" | "Endnote";
|
|
84690
|
+
}
|
|
84691
|
+
/** An interface describing the data returned by calling `noteItemCollection.toJSON()`. */
|
|
84692
|
+
interface NoteItemCollectionData {
|
|
84693
|
+
items?: Word.Interfaces.NoteItemData[];
|
|
83397
84694
|
}
|
|
83398
84695
|
/** An interface describing the data returned by calling `paragraph.toJSON()`. */
|
|
83399
84696
|
interface ParagraphData {
|
|
@@ -83845,231 +85142,534 @@ declare namespace Word {
|
|
|
83845
85142
|
* Checks whether the row is a header row. Read-only. To set the number of header rows, use HeaderRowCount on the Table object.
|
|
83846
85143
|
*
|
|
83847
85144
|
* @remarks
|
|
83848
|
-
* [Api set: WordApi 1.3]
|
|
85145
|
+
* [Api set: WordApi 1.3]
|
|
85146
|
+
*/
|
|
85147
|
+
isHeader?: boolean;
|
|
85148
|
+
/**
|
|
85149
|
+
* Gets and sets the preferred height of the row in points.
|
|
85150
|
+
*
|
|
85151
|
+
* @remarks
|
|
85152
|
+
* [Api set: WordApi 1.3]
|
|
85153
|
+
*/
|
|
85154
|
+
preferredHeight?: number;
|
|
85155
|
+
/**
|
|
85156
|
+
* Gets the index of the row in its parent table. Read-only.
|
|
85157
|
+
*
|
|
85158
|
+
* @remarks
|
|
85159
|
+
* [Api set: WordApi 1.3]
|
|
85160
|
+
*/
|
|
85161
|
+
rowIndex?: number;
|
|
85162
|
+
/**
|
|
85163
|
+
* Gets and sets the shading color. Color is specified in "#RRGGBB" format or by using the color name.
|
|
85164
|
+
*
|
|
85165
|
+
* @remarks
|
|
85166
|
+
* [Api set: WordApi 1.3]
|
|
85167
|
+
*/
|
|
85168
|
+
shadingColor?: string;
|
|
85169
|
+
/**
|
|
85170
|
+
* Gets and sets the text values in the row, as a 2D Javascript array.
|
|
85171
|
+
*
|
|
85172
|
+
* @remarks
|
|
85173
|
+
* [Api set: WordApi 1.3]
|
|
85174
|
+
*/
|
|
85175
|
+
values?: string[][];
|
|
85176
|
+
/**
|
|
85177
|
+
* Gets and sets the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'.
|
|
85178
|
+
*
|
|
85179
|
+
* @remarks
|
|
85180
|
+
* [Api set: WordApi 1.3]
|
|
85181
|
+
*/
|
|
85182
|
+
verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom";
|
|
85183
|
+
}
|
|
85184
|
+
/** An interface describing the data returned by calling `tableRowCollection.toJSON()`. */
|
|
85185
|
+
interface TableRowCollectionData {
|
|
85186
|
+
items?: Word.Interfaces.TableRowData[];
|
|
85187
|
+
}
|
|
85188
|
+
/** An interface describing the data returned by calling `tableCell.toJSON()`. */
|
|
85189
|
+
interface TableCellData {
|
|
85190
|
+
/**
|
|
85191
|
+
* Gets the body object of the cell. Read-only.
|
|
85192
|
+
*
|
|
85193
|
+
* @remarks
|
|
85194
|
+
* [Api set: WordApi 1.3]
|
|
85195
|
+
*/
|
|
85196
|
+
body?: Word.Interfaces.BodyData;
|
|
85197
|
+
/**
|
|
85198
|
+
* Gets the index of the cell in its row. Read-only.
|
|
85199
|
+
*
|
|
85200
|
+
* @remarks
|
|
85201
|
+
* [Api set: WordApi 1.3]
|
|
85202
|
+
*/
|
|
85203
|
+
cellIndex?: number;
|
|
85204
|
+
/**
|
|
85205
|
+
* Gets and sets the width of the cell's column in points. This is applicable to uniform tables.
|
|
85206
|
+
*
|
|
85207
|
+
* @remarks
|
|
85208
|
+
* [Api set: WordApi 1.3]
|
|
85209
|
+
*/
|
|
85210
|
+
columnWidth?: number;
|
|
85211
|
+
/**
|
|
85212
|
+
* Gets and sets the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'.
|
|
85213
|
+
*
|
|
85214
|
+
* @remarks
|
|
85215
|
+
* [Api set: WordApi 1.3]
|
|
85216
|
+
*/
|
|
85217
|
+
horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";
|
|
85218
|
+
/**
|
|
85219
|
+
* Gets the index of the cell's row in the table. Read-only.
|
|
85220
|
+
*
|
|
85221
|
+
* @remarks
|
|
85222
|
+
* [Api set: WordApi 1.3]
|
|
85223
|
+
*/
|
|
85224
|
+
rowIndex?: number;
|
|
85225
|
+
/**
|
|
85226
|
+
* Gets or sets the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name.
|
|
85227
|
+
*
|
|
85228
|
+
* @remarks
|
|
85229
|
+
* [Api set: WordApi 1.3]
|
|
85230
|
+
*/
|
|
85231
|
+
shadingColor?: string;
|
|
85232
|
+
/**
|
|
85233
|
+
* Gets and sets the text of the cell.
|
|
85234
|
+
*
|
|
85235
|
+
* @remarks
|
|
85236
|
+
* [Api set: WordApi 1.3]
|
|
85237
|
+
*/
|
|
85238
|
+
value?: string;
|
|
85239
|
+
/**
|
|
85240
|
+
* Gets and sets the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'.
|
|
85241
|
+
*
|
|
85242
|
+
* @remarks
|
|
85243
|
+
* [Api set: WordApi 1.3]
|
|
85244
|
+
*/
|
|
85245
|
+
verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom";
|
|
85246
|
+
/**
|
|
85247
|
+
* Gets the width of the cell in points. Read-only.
|
|
85248
|
+
*
|
|
85249
|
+
* @remarks
|
|
85250
|
+
* [Api set: WordApi 1.3]
|
|
85251
|
+
*/
|
|
85252
|
+
width?: number;
|
|
85253
|
+
}
|
|
85254
|
+
/** An interface describing the data returned by calling `tableCellCollection.toJSON()`. */
|
|
85255
|
+
interface TableCellCollectionData {
|
|
85256
|
+
items?: Word.Interfaces.TableCellData[];
|
|
85257
|
+
}
|
|
85258
|
+
/** An interface describing the data returned by calling `tableBorder.toJSON()`. */
|
|
85259
|
+
interface TableBorderData {
|
|
85260
|
+
/**
|
|
85261
|
+
* Gets or sets the table border color.
|
|
85262
|
+
*
|
|
85263
|
+
* @remarks
|
|
85264
|
+
* [Api set: WordApi 1.3]
|
|
85265
|
+
*/
|
|
85266
|
+
color?: string;
|
|
85267
|
+
/**
|
|
85268
|
+
* Gets or sets the type of the table border.
|
|
85269
|
+
*
|
|
85270
|
+
* @remarks
|
|
85271
|
+
* [Api set: WordApi 1.3]
|
|
85272
|
+
*/
|
|
85273
|
+
type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave";
|
|
85274
|
+
/**
|
|
85275
|
+
* Gets or sets the width, in points, of the table border. Not applicable to table border types that have fixed widths.
|
|
85276
|
+
*
|
|
85277
|
+
* @remarks
|
|
85278
|
+
* [Api set: WordApi 1.3]
|
|
85279
|
+
*/
|
|
85280
|
+
width?: number;
|
|
85281
|
+
}
|
|
85282
|
+
/**
|
|
85283
|
+
* Represents the body of a document or a section.
|
|
85284
|
+
*
|
|
85285
|
+
* @remarks
|
|
85286
|
+
* [Api set: WordApi 1.1]
|
|
85287
|
+
*/
|
|
85288
|
+
interface BodyLoadOptions {
|
|
85289
|
+
/**
|
|
85290
|
+
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
|
|
85291
|
+
*/
|
|
85292
|
+
$all?: boolean;
|
|
85293
|
+
/**
|
|
85294
|
+
* Gets the text format of the body. Use this to get and set font name, size, color and other properties.
|
|
85295
|
+
*
|
|
85296
|
+
* @remarks
|
|
85297
|
+
* [Api set: WordApi 1.1]
|
|
85298
|
+
*/
|
|
85299
|
+
font?: Word.Interfaces.FontLoadOptions;
|
|
85300
|
+
/**
|
|
85301
|
+
* Gets the parent body of the body. For example, a table cell body's parent body could be a header. Throws an error if there isn't a parent body.
|
|
85302
|
+
*
|
|
85303
|
+
* @remarks
|
|
85304
|
+
* [Api set: WordApi 1.3]
|
|
85305
|
+
*/
|
|
85306
|
+
parentBody?: Word.Interfaces.BodyLoadOptions;
|
|
85307
|
+
/**
|
|
85308
|
+
* Gets the parent body of the body. For example, a table cell body's parent body could be a header. Returns a null object if there isn't a parent body.
|
|
85309
|
+
*
|
|
85310
|
+
* @remarks
|
|
85311
|
+
* [Api set: WordApi 1.3]
|
|
85312
|
+
*/
|
|
85313
|
+
parentBodyOrNullObject?: Word.Interfaces.BodyLoadOptions;
|
|
85314
|
+
/**
|
|
85315
|
+
* Gets the content control that contains the body. Throws an error if there isn't a parent content control.
|
|
85316
|
+
*
|
|
85317
|
+
* @remarks
|
|
85318
|
+
* [Api set: WordApi 1.1]
|
|
85319
|
+
*/
|
|
85320
|
+
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
|
|
85321
|
+
/**
|
|
85322
|
+
* Gets the content control that contains the body. Returns a null object if there isn't a parent content control.
|
|
85323
|
+
*
|
|
85324
|
+
* @remarks
|
|
85325
|
+
* [Api set: WordApi 1.3]
|
|
85326
|
+
*/
|
|
85327
|
+
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
|
|
85328
|
+
/**
|
|
85329
|
+
* Gets the parent section of the body. Throws an error if there isn't a parent section.
|
|
85330
|
+
*
|
|
85331
|
+
* @remarks
|
|
85332
|
+
* [Api set: WordApi 1.3]
|
|
85333
|
+
*/
|
|
85334
|
+
parentSection?: Word.Interfaces.SectionLoadOptions;
|
|
85335
|
+
/**
|
|
85336
|
+
* Gets the parent section of the body. Returns a null object if there isn't a parent section.
|
|
85337
|
+
*
|
|
85338
|
+
* @remarks
|
|
85339
|
+
* [Api set: WordApi 1.3]
|
|
85340
|
+
*/
|
|
85341
|
+
parentSectionOrNullObject?: Word.Interfaces.SectionLoadOptions;
|
|
85342
|
+
/**
|
|
85343
|
+
* Gets or sets the style name for the body. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property.
|
|
85344
|
+
*
|
|
85345
|
+
* @remarks
|
|
85346
|
+
* [Api set: WordApi 1.1]
|
|
85347
|
+
*/
|
|
85348
|
+
style?: boolean;
|
|
85349
|
+
/**
|
|
85350
|
+
* Gets or sets the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property.
|
|
85351
|
+
*
|
|
85352
|
+
* @remarks
|
|
85353
|
+
* [Api set: WordApi 1.3]
|
|
85354
|
+
*/
|
|
85355
|
+
styleBuiltIn?: boolean;
|
|
85356
|
+
/**
|
|
85357
|
+
* Gets the text of the body. Use the insertText method to insert text. Read-only.
|
|
85358
|
+
*
|
|
85359
|
+
* @remarks
|
|
85360
|
+
* [Api set: WordApi 1.1]
|
|
85361
|
+
*/
|
|
85362
|
+
text?: boolean;
|
|
85363
|
+
/**
|
|
85364
|
+
* Gets the type of the body. The type can be 'MainDoc', 'Section', 'Header', 'Footer', or 'TableCell'. Read-only.
|
|
85365
|
+
*
|
|
85366
|
+
* @remarks
|
|
85367
|
+
* [Api set: WordApi 1.3]
|
|
85368
|
+
*/
|
|
85369
|
+
type?: boolean;
|
|
85370
|
+
}
|
|
85371
|
+
/**
|
|
85372
|
+
* Represents a comment in the document.
|
|
85373
|
+
*
|
|
85374
|
+
* @remarks
|
|
85375
|
+
* [Api set: WordApiOnline 1.1]
|
|
85376
|
+
*/
|
|
85377
|
+
interface CommentLoadOptions {
|
|
85378
|
+
/**
|
|
85379
|
+
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
|
|
85380
|
+
*/
|
|
85381
|
+
$all?: boolean;
|
|
85382
|
+
/**
|
|
85383
|
+
* Gets or sets the comment's content range.
|
|
85384
|
+
*
|
|
85385
|
+
* @remarks
|
|
85386
|
+
* [Api set: WordApiOnline 1.1]
|
|
85387
|
+
*/
|
|
85388
|
+
contentRange?: Word.Interfaces.CommentContentRangeLoadOptions;
|
|
85389
|
+
/**
|
|
85390
|
+
* Gets the email of the comment's author.
|
|
85391
|
+
*
|
|
85392
|
+
* @remarks
|
|
85393
|
+
* [Api set: WordApiOnline 1.1]
|
|
83849
85394
|
*/
|
|
83850
|
-
|
|
85395
|
+
authorEmail?: boolean;
|
|
83851
85396
|
/**
|
|
83852
|
-
* Gets
|
|
85397
|
+
* Gets the name of the comment's author.
|
|
83853
85398
|
*
|
|
83854
85399
|
* @remarks
|
|
83855
|
-
* [Api set:
|
|
85400
|
+
* [Api set: WordApiOnline 1.1]
|
|
83856
85401
|
*/
|
|
83857
|
-
|
|
85402
|
+
authorName?: boolean;
|
|
83858
85403
|
/**
|
|
83859
|
-
* Gets
|
|
85404
|
+
* Gets or sets the comment's content as plain text.
|
|
83860
85405
|
*
|
|
83861
85406
|
* @remarks
|
|
83862
|
-
* [Api set:
|
|
85407
|
+
* [Api set: WordApiOnline 1.1]
|
|
83863
85408
|
*/
|
|
83864
|
-
|
|
85409
|
+
content?: boolean;
|
|
83865
85410
|
/**
|
|
83866
|
-
* Gets
|
|
85411
|
+
* Gets the creation date of the comment.
|
|
83867
85412
|
*
|
|
83868
85413
|
* @remarks
|
|
83869
|
-
* [Api set:
|
|
85414
|
+
* [Api set: WordApiOnline 1.1]
|
|
83870
85415
|
*/
|
|
83871
|
-
|
|
85416
|
+
creationDate?: boolean;
|
|
83872
85417
|
/**
|
|
83873
|
-
* Gets
|
|
85418
|
+
* Gets the Id of the comment. Read-only.
|
|
83874
85419
|
*
|
|
83875
85420
|
* @remarks
|
|
83876
|
-
* [Api set:
|
|
85421
|
+
* [Api set: WordApiOnline 1.1]
|
|
83877
85422
|
*/
|
|
83878
|
-
|
|
85423
|
+
id?: boolean;
|
|
83879
85424
|
/**
|
|
83880
|
-
* Gets
|
|
85425
|
+
* 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.
|
|
83881
85426
|
*
|
|
83882
85427
|
* @remarks
|
|
83883
|
-
* [Api set:
|
|
85428
|
+
* [Api set: WordApiOnline 1.1]
|
|
83884
85429
|
*/
|
|
83885
|
-
|
|
83886
|
-
}
|
|
83887
|
-
/** An interface describing the data returned by calling `tableRowCollection.toJSON()`. */
|
|
83888
|
-
interface TableRowCollectionData {
|
|
83889
|
-
items?: Word.Interfaces.TableRowData[];
|
|
85430
|
+
resolved?: boolean;
|
|
83890
85431
|
}
|
|
83891
|
-
/**
|
|
83892
|
-
|
|
85432
|
+
/**
|
|
85433
|
+
* Contains a collection of {@link Word.Comment} objects.
|
|
85434
|
+
*
|
|
85435
|
+
* @remarks
|
|
85436
|
+
* [Api set: WordApiOnline 1.1]
|
|
85437
|
+
*/
|
|
85438
|
+
interface CommentCollectionLoadOptions {
|
|
83893
85439
|
/**
|
|
83894
|
-
|
|
85440
|
+
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
|
|
85441
|
+
*/
|
|
85442
|
+
$all?: boolean;
|
|
85443
|
+
/**
|
|
85444
|
+
* For EACH ITEM in the collection: Gets or sets the comment's content range.
|
|
83895
85445
|
*
|
|
83896
85446
|
* @remarks
|
|
83897
|
-
* [Api set:
|
|
85447
|
+
* [Api set: WordApiOnline 1.1]
|
|
83898
85448
|
*/
|
|
83899
|
-
|
|
85449
|
+
contentRange?: Word.Interfaces.CommentContentRangeLoadOptions;
|
|
83900
85450
|
/**
|
|
83901
|
-
*
|
|
85451
|
+
* For EACH ITEM in the collection: Gets the email of the comment's author.
|
|
83902
85452
|
*
|
|
83903
85453
|
* @remarks
|
|
83904
|
-
* [Api set:
|
|
85454
|
+
* [Api set: WordApiOnline 1.1]
|
|
83905
85455
|
*/
|
|
83906
|
-
|
|
85456
|
+
authorEmail?: boolean;
|
|
83907
85457
|
/**
|
|
83908
|
-
*
|
|
85458
|
+
* For EACH ITEM in the collection: Gets the name of the comment's author.
|
|
83909
85459
|
*
|
|
83910
85460
|
* @remarks
|
|
83911
|
-
* [Api set:
|
|
85461
|
+
* [Api set: WordApiOnline 1.1]
|
|
83912
85462
|
*/
|
|
83913
|
-
|
|
85463
|
+
authorName?: boolean;
|
|
83914
85464
|
/**
|
|
83915
|
-
*
|
|
85465
|
+
* For EACH ITEM in the collection: Gets or sets the comment's content as plain text.
|
|
83916
85466
|
*
|
|
83917
85467
|
* @remarks
|
|
83918
|
-
* [Api set:
|
|
85468
|
+
* [Api set: WordApiOnline 1.1]
|
|
83919
85469
|
*/
|
|
83920
|
-
|
|
85470
|
+
content?: boolean;
|
|
83921
85471
|
/**
|
|
83922
|
-
*
|
|
85472
|
+
* For EACH ITEM in the collection: Gets the creation date of the comment.
|
|
83923
85473
|
*
|
|
83924
85474
|
* @remarks
|
|
83925
|
-
* [Api set:
|
|
85475
|
+
* [Api set: WordApiOnline 1.1]
|
|
83926
85476
|
*/
|
|
83927
|
-
|
|
85477
|
+
creationDate?: boolean;
|
|
83928
85478
|
/**
|
|
83929
|
-
*
|
|
85479
|
+
* For EACH ITEM in the collection: Gets the Id of the comment. Read-only.
|
|
83930
85480
|
*
|
|
83931
85481
|
* @remarks
|
|
83932
|
-
* [Api set:
|
|
85482
|
+
* [Api set: WordApiOnline 1.1]
|
|
83933
85483
|
*/
|
|
83934
|
-
|
|
85484
|
+
id?: boolean;
|
|
83935
85485
|
/**
|
|
83936
|
-
* Gets
|
|
85486
|
+
* 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.
|
|
83937
85487
|
*
|
|
83938
85488
|
* @remarks
|
|
83939
|
-
* [Api set:
|
|
85489
|
+
* [Api set: WordApiOnline 1.1]
|
|
83940
85490
|
*/
|
|
83941
|
-
|
|
85491
|
+
resolved?: boolean;
|
|
85492
|
+
}
|
|
85493
|
+
/**
|
|
85494
|
+
* @remarks
|
|
85495
|
+
* [Api set: WordApiOnline 1.1]
|
|
85496
|
+
*/
|
|
85497
|
+
interface CommentContentRangeLoadOptions {
|
|
83942
85498
|
/**
|
|
83943
|
-
|
|
85499
|
+
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
|
|
85500
|
+
*/
|
|
85501
|
+
$all?: boolean;
|
|
85502
|
+
/**
|
|
85503
|
+
* Gets or sets a value that indicates whether the comment text is bold.
|
|
83944
85504
|
*
|
|
83945
85505
|
* @remarks
|
|
83946
|
-
* [Api set:
|
|
85506
|
+
* [Api set: WordApiOnline 1.1]
|
|
83947
85507
|
*/
|
|
83948
|
-
|
|
85508
|
+
bold?: boolean;
|
|
83949
85509
|
/**
|
|
83950
|
-
* Gets the
|
|
85510
|
+
* 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.
|
|
83951
85511
|
*
|
|
83952
85512
|
* @remarks
|
|
83953
|
-
* [Api set:
|
|
85513
|
+
* [Api set: WordApiOnline 1.1]
|
|
83954
85514
|
*/
|
|
83955
|
-
|
|
83956
|
-
}
|
|
83957
|
-
/** An interface describing the data returned by calling `tableCellCollection.toJSON()`. */
|
|
83958
|
-
interface TableCellCollectionData {
|
|
83959
|
-
items?: Word.Interfaces.TableCellData[];
|
|
83960
|
-
}
|
|
83961
|
-
/** An interface describing the data returned by calling `tableBorder.toJSON()`. */
|
|
83962
|
-
interface TableBorderData {
|
|
85515
|
+
hyperlink?: boolean;
|
|
83963
85516
|
/**
|
|
83964
|
-
*
|
|
85517
|
+
* Checks whether the range length is zero. Read-only.
|
|
83965
85518
|
*
|
|
83966
85519
|
* @remarks
|
|
83967
|
-
* [Api set:
|
|
85520
|
+
* [Api set: WordApiOnline 1.1]
|
|
83968
85521
|
*/
|
|
83969
|
-
|
|
85522
|
+
isEmpty?: boolean;
|
|
83970
85523
|
/**
|
|
83971
|
-
* Gets or sets
|
|
85524
|
+
* Gets or sets a value that indicates whether the comment text is italicized.
|
|
83972
85525
|
*
|
|
83973
85526
|
* @remarks
|
|
83974
|
-
* [Api set:
|
|
85527
|
+
* [Api set: WordApiOnline 1.1]
|
|
83975
85528
|
*/
|
|
83976
|
-
|
|
85529
|
+
italic?: boolean;
|
|
83977
85530
|
/**
|
|
83978
|
-
* Gets or sets
|
|
85531
|
+
* Gets or sets a value that indicates whether the comment text has a strikethrough.
|
|
83979
85532
|
*
|
|
83980
85533
|
* @remarks
|
|
83981
|
-
* [Api set:
|
|
85534
|
+
* [Api set: WordApiOnline 1.1]
|
|
83982
85535
|
*/
|
|
83983
|
-
|
|
85536
|
+
strikeThrough?: boolean;
|
|
85537
|
+
/**
|
|
85538
|
+
* Gets the text of the comment range. Read-only.
|
|
85539
|
+
*
|
|
85540
|
+
* @remarks
|
|
85541
|
+
* [Api set: WordApiOnline 1.1]
|
|
85542
|
+
*/
|
|
85543
|
+
text?: boolean;
|
|
85544
|
+
/**
|
|
85545
|
+
* Gets or sets a value that indicates the comment text's underline type. 'None' if the comment text is not underlined.
|
|
85546
|
+
*
|
|
85547
|
+
* @remarks
|
|
85548
|
+
* [Api set: WordApiOnline 1.1]
|
|
85549
|
+
*/
|
|
85550
|
+
underline?: boolean;
|
|
83984
85551
|
}
|
|
83985
85552
|
/**
|
|
83986
|
-
* Represents
|
|
85553
|
+
* Represents a comment reply in the document.
|
|
83987
85554
|
*
|
|
83988
85555
|
* @remarks
|
|
83989
|
-
* [Api set:
|
|
85556
|
+
* [Api set: WordApiOnline 1.1]
|
|
83990
85557
|
*/
|
|
83991
|
-
interface
|
|
85558
|
+
interface CommentReplyLoadOptions {
|
|
83992
85559
|
/**
|
|
83993
85560
|
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
|
|
83994
85561
|
*/
|
|
83995
85562
|
$all?: boolean;
|
|
83996
85563
|
/**
|
|
83997
|
-
* Gets
|
|
85564
|
+
* Gets or sets the commentReply's content range.
|
|
83998
85565
|
*
|
|
83999
85566
|
* @remarks
|
|
84000
|
-
* [Api set:
|
|
85567
|
+
* [Api set: WordApiOnline 1.1]
|
|
84001
85568
|
*/
|
|
84002
|
-
|
|
85569
|
+
contentRange?: Word.Interfaces.CommentContentRangeLoadOptions;
|
|
84003
85570
|
/**
|
|
84004
|
-
* Gets the parent
|
|
85571
|
+
* Gets the parent comment of this reply.
|
|
84005
85572
|
*
|
|
84006
85573
|
* @remarks
|
|
84007
|
-
* [Api set:
|
|
85574
|
+
* [Api set: WordApiOnline 1.1]
|
|
84008
85575
|
*/
|
|
84009
|
-
|
|
85576
|
+
parentComment?: Word.Interfaces.CommentLoadOptions;
|
|
84010
85577
|
/**
|
|
84011
|
-
|
|
84012
|
-
|
|
84013
|
-
|
|
84014
|
-
|
|
84015
|
-
|
|
84016
|
-
|
|
85578
|
+
* Gets the email of the comment reply's author.
|
|
85579
|
+
*
|
|
85580
|
+
* @remarks
|
|
85581
|
+
* [Api set: WordApiOnline 1.1]
|
|
85582
|
+
*/
|
|
85583
|
+
authorEmail?: boolean;
|
|
84017
85584
|
/**
|
|
84018
|
-
|
|
84019
|
-
|
|
84020
|
-
|
|
84021
|
-
|
|
84022
|
-
|
|
84023
|
-
|
|
85585
|
+
* Gets the name of the comment reply's author.
|
|
85586
|
+
*
|
|
85587
|
+
* @remarks
|
|
85588
|
+
* [Api set: WordApiOnline 1.1]
|
|
85589
|
+
*/
|
|
85590
|
+
authorName?: boolean;
|
|
84024
85591
|
/**
|
|
84025
|
-
|
|
84026
|
-
|
|
84027
|
-
|
|
84028
|
-
|
|
84029
|
-
|
|
84030
|
-
|
|
85592
|
+
* Gets or sets the comment reply's content. The string is plain text.
|
|
85593
|
+
*
|
|
85594
|
+
* @remarks
|
|
85595
|
+
* [Api set: WordApiOnline 1.1]
|
|
85596
|
+
*/
|
|
85597
|
+
content?: boolean;
|
|
84031
85598
|
/**
|
|
84032
|
-
|
|
85599
|
+
* Gets the creation date of the comment reply.
|
|
85600
|
+
*
|
|
85601
|
+
* @remarks
|
|
85602
|
+
* [Api set: WordApiOnline 1.1]
|
|
85603
|
+
*/
|
|
85604
|
+
creationDate?: boolean;
|
|
85605
|
+
/**
|
|
85606
|
+
* Gets the Id of the comment reply. Read-only.
|
|
85607
|
+
*
|
|
85608
|
+
* @remarks
|
|
85609
|
+
* [Api set: WordApiOnline 1.1]
|
|
85610
|
+
*/
|
|
85611
|
+
id?: boolean;
|
|
85612
|
+
}
|
|
85613
|
+
/**
|
|
85614
|
+
* Contains a collection of {@link Word.CommentReply} objects. Represents all comment replies in one comment thread.
|
|
85615
|
+
*
|
|
85616
|
+
* @remarks
|
|
85617
|
+
* [Api set: WordApiOnline 1.1]
|
|
85618
|
+
*/
|
|
85619
|
+
interface CommentReplyCollectionLoadOptions {
|
|
85620
|
+
/**
|
|
85621
|
+
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
|
|
85622
|
+
*/
|
|
85623
|
+
$all?: boolean;
|
|
85624
|
+
/**
|
|
85625
|
+
* For EACH ITEM in the collection: Gets or sets the commentReply's content range.
|
|
84033
85626
|
*
|
|
84034
85627
|
* @remarks
|
|
84035
|
-
* [Api set:
|
|
85628
|
+
* [Api set: WordApiOnline 1.1]
|
|
84036
85629
|
*/
|
|
84037
|
-
|
|
85630
|
+
contentRange?: Word.Interfaces.CommentContentRangeLoadOptions;
|
|
84038
85631
|
/**
|
|
84039
|
-
*
|
|
85632
|
+
* For EACH ITEM in the collection: Gets the parent comment of this reply.
|
|
84040
85633
|
*
|
|
84041
85634
|
* @remarks
|
|
84042
|
-
* [Api set:
|
|
85635
|
+
* [Api set: WordApiOnline 1.1]
|
|
84043
85636
|
*/
|
|
84044
|
-
|
|
85637
|
+
parentComment?: Word.Interfaces.CommentLoadOptions;
|
|
84045
85638
|
/**
|
|
84046
|
-
*
|
|
85639
|
+
* For EACH ITEM in the collection: Gets the email of the comment reply's author.
|
|
84047
85640
|
*
|
|
84048
85641
|
* @remarks
|
|
84049
|
-
* [Api set:
|
|
85642
|
+
* [Api set: WordApiOnline 1.1]
|
|
84050
85643
|
*/
|
|
84051
|
-
|
|
85644
|
+
authorEmail?: boolean;
|
|
84052
85645
|
/**
|
|
84053
|
-
*
|
|
85646
|
+
* For EACH ITEM in the collection: Gets the name of the comment reply's author.
|
|
84054
85647
|
*
|
|
84055
85648
|
* @remarks
|
|
84056
|
-
* [Api set:
|
|
85649
|
+
* [Api set: WordApiOnline 1.1]
|
|
84057
85650
|
*/
|
|
84058
|
-
|
|
85651
|
+
authorName?: boolean;
|
|
84059
85652
|
/**
|
|
84060
|
-
*
|
|
85653
|
+
* For EACH ITEM in the collection: Gets or sets the comment reply's content. The string is plain text.
|
|
84061
85654
|
*
|
|
84062
85655
|
* @remarks
|
|
84063
|
-
* [Api set:
|
|
85656
|
+
* [Api set: WordApiOnline 1.1]
|
|
84064
85657
|
*/
|
|
84065
|
-
|
|
85658
|
+
content?: boolean;
|
|
84066
85659
|
/**
|
|
84067
|
-
*
|
|
85660
|
+
* For EACH ITEM in the collection: Gets the creation date of the comment reply.
|
|
84068
85661
|
*
|
|
84069
85662
|
* @remarks
|
|
84070
|
-
* [Api set:
|
|
85663
|
+
* [Api set: WordApiOnline 1.1]
|
|
84071
85664
|
*/
|
|
84072
|
-
|
|
85665
|
+
creationDate?: boolean;
|
|
85666
|
+
/**
|
|
85667
|
+
* For EACH ITEM in the collection: Gets the Id of the comment reply. Read-only.
|
|
85668
|
+
*
|
|
85669
|
+
* @remarks
|
|
85670
|
+
* [Api set: WordApiOnline 1.1]
|
|
85671
|
+
*/
|
|
85672
|
+
id?: boolean;
|
|
84073
85673
|
}
|
|
84074
85674
|
/**
|
|
84075
85675
|
* Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text content controls are supported.
|
|
@@ -84496,6 +86096,13 @@ declare namespace Word {
|
|
|
84496
86096
|
* [Api set: WordApi 1.3]
|
|
84497
86097
|
*/
|
|
84498
86098
|
properties?: Word.Interfaces.DocumentPropertiesLoadOptions;
|
|
86099
|
+
/**
|
|
86100
|
+
* Gets or sets the ChangeTracking mode.
|
|
86101
|
+
*
|
|
86102
|
+
* @remarks
|
|
86103
|
+
* [Api set: WordApiOnline 1.1]
|
|
86104
|
+
*/
|
|
86105
|
+
changeTrackingMode?: boolean;
|
|
84499
86106
|
/**
|
|
84500
86107
|
* Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. Read-only.
|
|
84501
86108
|
*
|
|
@@ -85063,6 +86670,72 @@ declare namespace Word {
|
|
|
85063
86670
|
*/
|
|
85064
86671
|
siblingIndex?: boolean;
|
|
85065
86672
|
}
|
|
86673
|
+
/**
|
|
86674
|
+
* Represents a footnote or endnote.
|
|
86675
|
+
*
|
|
86676
|
+
* @remarks
|
|
86677
|
+
* [Api set: WordApiOnline 1.1]
|
|
86678
|
+
*/
|
|
86679
|
+
interface NoteItemLoadOptions {
|
|
86680
|
+
/**
|
|
86681
|
+
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
|
|
86682
|
+
*/
|
|
86683
|
+
$all?: boolean;
|
|
86684
|
+
/**
|
|
86685
|
+
* Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
|
|
86686
|
+
*
|
|
86687
|
+
* @remarks
|
|
86688
|
+
* [Api set: WordApiOnline 1.1]
|
|
86689
|
+
*/
|
|
86690
|
+
body?: Word.Interfaces.BodyLoadOptions;
|
|
86691
|
+
/**
|
|
86692
|
+
* Represents a footnote or endnote reference in the main document.
|
|
86693
|
+
*
|
|
86694
|
+
* @remarks
|
|
86695
|
+
* [Api set: WordApiOnline 1.1]
|
|
86696
|
+
*/
|
|
86697
|
+
reference?: Word.Interfaces.RangeLoadOptions;
|
|
86698
|
+
/**
|
|
86699
|
+
* Represents the note item type: footnote or endnote.
|
|
86700
|
+
*
|
|
86701
|
+
* @remarks
|
|
86702
|
+
* [Api set: WordApiOnline 1.1]
|
|
86703
|
+
*/
|
|
86704
|
+
type?: boolean;
|
|
86705
|
+
}
|
|
86706
|
+
/**
|
|
86707
|
+
* Contains a collection of {@link Word.NoteItem} objects.
|
|
86708
|
+
*
|
|
86709
|
+
* @remarks
|
|
86710
|
+
* [Api set: WordApiOnline 1.1]
|
|
86711
|
+
*/
|
|
86712
|
+
interface NoteItemCollectionLoadOptions {
|
|
86713
|
+
/**
|
|
86714
|
+
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
|
|
86715
|
+
*/
|
|
86716
|
+
$all?: boolean;
|
|
86717
|
+
/**
|
|
86718
|
+
* 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.
|
|
86719
|
+
*
|
|
86720
|
+
* @remarks
|
|
86721
|
+
* [Api set: WordApiOnline 1.1]
|
|
86722
|
+
*/
|
|
86723
|
+
body?: Word.Interfaces.BodyLoadOptions;
|
|
86724
|
+
/**
|
|
86725
|
+
* For EACH ITEM in the collection: Represents a footnote or endnote reference in the main document.
|
|
86726
|
+
*
|
|
86727
|
+
* @remarks
|
|
86728
|
+
* [Api set: WordApiOnline 1.1]
|
|
86729
|
+
*/
|
|
86730
|
+
reference?: Word.Interfaces.RangeLoadOptions;
|
|
86731
|
+
/**
|
|
86732
|
+
* For EACH ITEM in the collection: Represents the note item type: footnote or endnote.
|
|
86733
|
+
*
|
|
86734
|
+
* @remarks
|
|
86735
|
+
* [Api set: WordApiOnline 1.1]
|
|
86736
|
+
*/
|
|
86737
|
+
type?: boolean;
|
|
86738
|
+
}
|
|
85066
86739
|
/**
|
|
85067
86740
|
* Represents a single paragraph in a selection, range, content control, or document body.
|
|
85068
86741
|
*
|