@types/office-js 1.0.254 → 1.0.257
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 +1722 -8
- office-js/package.json +2 -2
office-js/index.d.ts
CHANGED
|
@@ -537,9 +537,6 @@ declare namespace Office {
|
|
|
537
537
|
}
|
|
538
538
|
/**
|
|
539
539
|
* Manages actions and keyboard shortcuts.
|
|
540
|
-
*
|
|
541
|
-
* @remarks
|
|
542
|
-
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1}
|
|
543
540
|
*/
|
|
544
541
|
interface Actions {
|
|
545
542
|
/**
|
|
@@ -547,11 +544,55 @@ declare namespace Office {
|
|
|
547
544
|
*
|
|
548
545
|
* @param actionId The ID of an action that is defined in an extended manifest or the name of the function as specified in a **FunctionName** element in the manifest.
|
|
549
546
|
* @param actionFunction The function that is run when the action is invoked.
|
|
550
|
-
*
|
|
551
|
-
* @remarks
|
|
552
|
-
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1}
|
|
553
547
|
*/
|
|
554
548
|
associate: (actionId: string, actionFunction: (arg?: any) => void) => void;
|
|
549
|
+
/**
|
|
550
|
+
* Replaces existing add-in shortcuts with custom shortcuts for the user.
|
|
551
|
+
*
|
|
552
|
+
* @remarks
|
|
553
|
+
*
|
|
554
|
+
* **Requirement sets**:
|
|
555
|
+
*
|
|
556
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/keyboard-shortcuts-requirement-sets | KeyboardShortcuts 1.1}
|
|
557
|
+
*
|
|
558
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1}
|
|
559
|
+
*
|
|
560
|
+
* @param shortcuts An object of custom shortcuts with keys being the IDs of the actions (as defined in an extended manifest) and values being the shortcut combinations. For example, `{"SetItalic": "Ctrl+1", "SetBold": "Ctrl+2"}`.
|
|
561
|
+
* To learn how to specify a valid action ID and a key combination, see {@link https://docs.microsoft.com/office/dev/add-ins/design/keyboard-shortcuts | Add custom keyboard shortcuts to your Office Add-ins}. (Note that a key combination can be `null`, in which case, the action keeps the key combination specified in the JSON file.)
|
|
562
|
+
* @returns A promise that resolves when every custom shortcut assignment in `shortcuts` has been registered. Even if there is a conflict with existing shortcuts, the customized shortcut will be registered.
|
|
563
|
+
* Otherwise, the promise will be rejected with error code and error message. An "InvalidOperation" error code is returned if any action ID in `shortcuts` does not exist, or if shortcut combination is invalid.
|
|
564
|
+
*/
|
|
565
|
+
replaceShortcuts(shortcuts: {[actionId: string]: string}): Promise<void>;
|
|
566
|
+
/**
|
|
567
|
+
* Gets the existing shortcuts for the add-in. The set always includes (1) the shortcuts defined in the add-in's extended manifest for keyboard shortcuts and (2) the current user's custom shortcuts if those exist.
|
|
568
|
+
* The shortcut can be `null` if it conflicts with the shortcut of another add-in or with the Office application. Specifically, it would be `null` if, when prompted to choose which shortcut to use, the user didn't choose the action of the current add-in. For more information about conflicts with shortcuts, see {@link https://docs.microsoft.com/office/dev/add-ins/design/keyboard-shortcuts#avoid-key-combinations-in-use-by-other-add-ins | Avoid key combinations in use by other add-ins}.
|
|
569
|
+
*
|
|
570
|
+
* @remarks
|
|
571
|
+
*
|
|
572
|
+
* **Requirement sets**:
|
|
573
|
+
*
|
|
574
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/keyboard-shortcuts-requirement-sets | KeyboardShortcuts 1.1}
|
|
575
|
+
*
|
|
576
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1}
|
|
577
|
+
*
|
|
578
|
+
* @returns A promise that resolves to an object of shortcuts, with keys being the IDs of the actions (as defined in an extended manifest) and values being the shortcut combinations. For example, `{"SetItalic": "Ctrl+1", "SetBold": "Ctrl+2", "SetUnderline": null}`.
|
|
579
|
+
*/
|
|
580
|
+
getShortcuts(): Promise<{[actionId: string]: string|null}>;
|
|
581
|
+
/**
|
|
582
|
+
* Checks if a set of shortcut combinations are currently in use for the user, as defined by another add-in or by the host Office application.
|
|
583
|
+
*
|
|
584
|
+
* @remarks
|
|
585
|
+
*
|
|
586
|
+
* **Requirement sets**:
|
|
587
|
+
*
|
|
588
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/keyboard-shortcuts-requirement-sets | KeyboardShortcuts 1.1}
|
|
589
|
+
*
|
|
590
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1}
|
|
591
|
+
*
|
|
592
|
+
* @param shortcuts An array of shortcut combinations. For example, `["Ctrl+1", "Ctrl+2"]`.
|
|
593
|
+
* @returns A promise that resolves to an array of objects. Each object consists of a shortcut combination and Boolean value. The value is `true` if the shortcut combination conflicts with a shortcut of another add-in or with a shortcut of the Office application; otherwise, `false`. For example, `[{shortcut:"Ctrl+1", inUse:true},{shortcut:"Ctrl+2", inUse:false}]`.
|
|
594
|
+
*/
|
|
595
|
+
areShortcutsInUse(shortcuts: string[]): Promise<{shortcut: string, inUse: boolean}[]>;
|
|
555
596
|
}
|
|
556
597
|
/**
|
|
557
598
|
* Message used in the `onVisibilityModeChanged` invocation.
|
|
@@ -74829,6 +74870,13 @@ declare namespace Word {
|
|
|
74829
74870
|
* [Api set: WordApi 1.1]
|
|
74830
74871
|
*/
|
|
74831
74872
|
readonly contentControls: Word.ContentControlCollection;
|
|
74873
|
+
/**
|
|
74874
|
+
* Gets the collection of endnotes in the body. Read-only.
|
|
74875
|
+
*
|
|
74876
|
+
* @remarks
|
|
74877
|
+
* [Api set: WordApiOnline 1.1]
|
|
74878
|
+
*/
|
|
74879
|
+
readonly endnotes: Word.NoteItemCollection;
|
|
74832
74880
|
/**
|
|
74833
74881
|
* Gets the text format of the body. Use this to get and set font name, size, color and other properties. Read-only.
|
|
74834
74882
|
*
|
|
@@ -74836,6 +74884,13 @@ declare namespace Word {
|
|
|
74836
74884
|
* [Api set: WordApi 1.1]
|
|
74837
74885
|
*/
|
|
74838
74886
|
readonly font: Word.Font;
|
|
74887
|
+
/**
|
|
74888
|
+
* Gets the collection of footnotes in the body. Read-only.
|
|
74889
|
+
*
|
|
74890
|
+
* @remarks
|
|
74891
|
+
* [Api set: WordApiOnline 1.1]
|
|
74892
|
+
*/
|
|
74893
|
+
readonly footnotes: Word.NoteItemCollection;
|
|
74839
74894
|
/**
|
|
74840
74895
|
* Gets the collection of InlinePicture objects in the body. The collection does not include floating images. Read-only.
|
|
74841
74896
|
*
|
|
@@ -74933,7 +74988,7 @@ declare namespace Word {
|
|
|
74933
74988
|
* @remarks
|
|
74934
74989
|
* [Api set: WordApi 1.3]
|
|
74935
74990
|
*/
|
|
74936
|
-
readonly type: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell";
|
|
74991
|
+
readonly type: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" | "Footnote" | "Endnote" | "NoteItem";
|
|
74937
74992
|
/**
|
|
74938
74993
|
* 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
74994
|
* @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 +75004,13 @@ declare namespace Word {
|
|
|
74949
75004
|
* [Api set: WordApi 1.1]
|
|
74950
75005
|
*/
|
|
74951
75006
|
clear(): void;
|
|
75007
|
+
/**
|
|
75008
|
+
* Gets comments associated with the body.
|
|
75009
|
+
*
|
|
75010
|
+
* @remarks
|
|
75011
|
+
* [Api set: WordApiOnline 1.1]
|
|
75012
|
+
*/
|
|
75013
|
+
getComments(): Word.CommentCollection;
|
|
74952
75014
|
/**
|
|
74953
75015
|
* 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
75016
|
*
|
|
@@ -74981,6 +75043,24 @@ declare namespace Word {
|
|
|
74981
75043
|
* @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
|
|
74982
75044
|
*/
|
|
74983
75045
|
getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
|
|
75046
|
+
/**
|
|
75047
|
+
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
75048
|
+
*
|
|
75049
|
+
* @remarks
|
|
75050
|
+
* [Api set: WordApiOnline 1.1]
|
|
75051
|
+
*
|
|
75052
|
+
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
75053
|
+
*/
|
|
75054
|
+
getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;
|
|
75055
|
+
/**
|
|
75056
|
+
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
75057
|
+
*
|
|
75058
|
+
* @remarks
|
|
75059
|
+
* [Api set: WordApiOnline 1.1]
|
|
75060
|
+
*
|
|
75061
|
+
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
75062
|
+
*/
|
|
75063
|
+
getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
|
|
74984
75064
|
/**
|
|
74985
75065
|
* Inserts a break at the specified location in the main document.
|
|
74986
75066
|
*
|
|
@@ -75223,6 +75303,496 @@ declare namespace Word {
|
|
|
75223
75303
|
*/
|
|
75224
75304
|
toJSON(): Word.Interfaces.BodyData;
|
|
75225
75305
|
}
|
|
75306
|
+
/**
|
|
75307
|
+
* Represents a comment in the document.
|
|
75308
|
+
*
|
|
75309
|
+
* @remarks
|
|
75310
|
+
* [Api set: WordApiOnline 1.1]
|
|
75311
|
+
*/
|
|
75312
|
+
class Comment extends OfficeExtension.ClientObject {
|
|
75313
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
75314
|
+
context: RequestContext;
|
|
75315
|
+
/**
|
|
75316
|
+
* Gets or sets the comment's content range.
|
|
75317
|
+
*
|
|
75318
|
+
* @remarks
|
|
75319
|
+
* [Api set: WordApiOnline 1.1]
|
|
75320
|
+
*/
|
|
75321
|
+
contentRange: Word.CommentContentRange;
|
|
75322
|
+
/**
|
|
75323
|
+
* Gets the collection of reply objects associated with the comment.
|
|
75324
|
+
*
|
|
75325
|
+
* @remarks
|
|
75326
|
+
* [Api set: WordApiOnline 1.1]
|
|
75327
|
+
*/
|
|
75328
|
+
readonly replies: Word.CommentReplyCollection;
|
|
75329
|
+
/**
|
|
75330
|
+
* Gets the email of the comment's author.
|
|
75331
|
+
*
|
|
75332
|
+
* @remarks
|
|
75333
|
+
* [Api set: WordApiOnline 1.1]
|
|
75334
|
+
*/
|
|
75335
|
+
readonly authorEmail: string;
|
|
75336
|
+
/**
|
|
75337
|
+
* Gets the name of the comment's author.
|
|
75338
|
+
*
|
|
75339
|
+
* @remarks
|
|
75340
|
+
* [Api set: WordApiOnline 1.1]
|
|
75341
|
+
*/
|
|
75342
|
+
readonly authorName: string;
|
|
75343
|
+
/**
|
|
75344
|
+
* Gets or sets the comment's content as plain text.
|
|
75345
|
+
*
|
|
75346
|
+
* @remarks
|
|
75347
|
+
* [Api set: WordApiOnline 1.1]
|
|
75348
|
+
*/
|
|
75349
|
+
content: string;
|
|
75350
|
+
/**
|
|
75351
|
+
* Gets the creation date of the comment.
|
|
75352
|
+
*
|
|
75353
|
+
* @remarks
|
|
75354
|
+
* [Api set: WordApiOnline 1.1]
|
|
75355
|
+
*/
|
|
75356
|
+
readonly creationDate: Date;
|
|
75357
|
+
/**
|
|
75358
|
+
* Gets the Id of the comment. Read-only.
|
|
75359
|
+
*
|
|
75360
|
+
* @remarks
|
|
75361
|
+
* [Api set: WordApiOnline 1.1]
|
|
75362
|
+
*/
|
|
75363
|
+
readonly id: string;
|
|
75364
|
+
/**
|
|
75365
|
+
* 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.
|
|
75366
|
+
*
|
|
75367
|
+
* @remarks
|
|
75368
|
+
* [Api set: WordApiOnline 1.1]
|
|
75369
|
+
*/
|
|
75370
|
+
resolved: boolean;
|
|
75371
|
+
/**
|
|
75372
|
+
* 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.
|
|
75373
|
+
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
75374
|
+
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
75375
|
+
*/
|
|
75376
|
+
set(properties: Interfaces.CommentUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
75377
|
+
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
75378
|
+
set(properties: Word.Comment): void;
|
|
75379
|
+
/**
|
|
75380
|
+
* Deletes the comment and its replies.
|
|
75381
|
+
*
|
|
75382
|
+
* @remarks
|
|
75383
|
+
* [Api set: WordApiOnline 1.1]
|
|
75384
|
+
*/
|
|
75385
|
+
delete(): void;
|
|
75386
|
+
/**
|
|
75387
|
+
* Gets the range in the main document where the comment is on.
|
|
75388
|
+
*
|
|
75389
|
+
* @remarks
|
|
75390
|
+
* [Api set: WordApiOnline 1.1]
|
|
75391
|
+
*/
|
|
75392
|
+
getRange(): Word.Range;
|
|
75393
|
+
/**
|
|
75394
|
+
* Adds a new reply to the end of the comment thread.
|
|
75395
|
+
*
|
|
75396
|
+
* @remarks
|
|
75397
|
+
* [Api set: WordApiOnline 1.1]
|
|
75398
|
+
*
|
|
75399
|
+
* @param replyText Required. Reply text.
|
|
75400
|
+
*/
|
|
75401
|
+
reply(replyText: string): Word.CommentReply;
|
|
75402
|
+
/**
|
|
75403
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75404
|
+
*
|
|
75405
|
+
* @param options Provides options for which properties of the object to load.
|
|
75406
|
+
*/
|
|
75407
|
+
load(options?: Word.Interfaces.CommentLoadOptions): Word.Comment;
|
|
75408
|
+
/**
|
|
75409
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75410
|
+
*
|
|
75411
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
75412
|
+
*/
|
|
75413
|
+
load(propertyNames?: string | string[]): Word.Comment;
|
|
75414
|
+
/**
|
|
75415
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75416
|
+
*
|
|
75417
|
+
* @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.
|
|
75418
|
+
*/
|
|
75419
|
+
load(propertyNamesAndPaths?: {
|
|
75420
|
+
select?: string;
|
|
75421
|
+
expand?: string;
|
|
75422
|
+
}): Word.Comment;
|
|
75423
|
+
/**
|
|
75424
|
+
* 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.
|
|
75425
|
+
*/
|
|
75426
|
+
track(): Word.Comment;
|
|
75427
|
+
/**
|
|
75428
|
+
* 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.
|
|
75429
|
+
*/
|
|
75430
|
+
untrack(): Word.Comment;
|
|
75431
|
+
/**
|
|
75432
|
+
* 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.)
|
|
75433
|
+
* 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.
|
|
75434
|
+
*/
|
|
75435
|
+
toJSON(): Word.Interfaces.CommentData;
|
|
75436
|
+
}
|
|
75437
|
+
/**
|
|
75438
|
+
* Contains a collection of {@link Word.Comment} objects.
|
|
75439
|
+
*
|
|
75440
|
+
* @remarks
|
|
75441
|
+
* [Api set: WordApiOnline 1.1]
|
|
75442
|
+
*/
|
|
75443
|
+
class CommentCollection extends OfficeExtension.ClientObject {
|
|
75444
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
75445
|
+
context: RequestContext;
|
|
75446
|
+
/** Gets the loaded child items in this collection. */
|
|
75447
|
+
readonly items: Word.Comment[];
|
|
75448
|
+
/**
|
|
75449
|
+
* Gets the first comment in the collection. Throws an error if this collection is empty.
|
|
75450
|
+
*
|
|
75451
|
+
* @remarks
|
|
75452
|
+
* [Api set: WordApiOnline 1.1]
|
|
75453
|
+
*/
|
|
75454
|
+
getFirst(): Word.Comment;
|
|
75455
|
+
/**
|
|
75456
|
+
* Gets the first comment in the collection. If the collection is empty, returns a null object.
|
|
75457
|
+
*
|
|
75458
|
+
* @remarks
|
|
75459
|
+
* [Api set: WordApiOnline 1.1]
|
|
75460
|
+
*/
|
|
75461
|
+
getFirstOrNullObject(): Word.Comment;
|
|
75462
|
+
/**
|
|
75463
|
+
* Gets a comment object by its index in the collection.
|
|
75464
|
+
*
|
|
75465
|
+
* @remarks
|
|
75466
|
+
* [Api set: WordApiOnline 1.1]
|
|
75467
|
+
*
|
|
75468
|
+
* @param index A number that identifies the index location of a comment object.
|
|
75469
|
+
*/
|
|
75470
|
+
getItem(index: number): Word.Comment;
|
|
75471
|
+
/**
|
|
75472
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75473
|
+
*
|
|
75474
|
+
* @param options Provides options for which properties of the object to load.
|
|
75475
|
+
*/
|
|
75476
|
+
load(options?: Word.Interfaces.CommentCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CommentCollection;
|
|
75477
|
+
/**
|
|
75478
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75479
|
+
*
|
|
75480
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
75481
|
+
*/
|
|
75482
|
+
load(propertyNames?: string | string[]): Word.CommentCollection;
|
|
75483
|
+
/**
|
|
75484
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75485
|
+
*
|
|
75486
|
+
* @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.
|
|
75487
|
+
*/
|
|
75488
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CommentCollection;
|
|
75489
|
+
/**
|
|
75490
|
+
* 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.
|
|
75491
|
+
*/
|
|
75492
|
+
track(): Word.CommentCollection;
|
|
75493
|
+
/**
|
|
75494
|
+
* 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.
|
|
75495
|
+
*/
|
|
75496
|
+
untrack(): Word.CommentCollection;
|
|
75497
|
+
/**
|
|
75498
|
+
* 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.)
|
|
75499
|
+
* 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.
|
|
75500
|
+
*/
|
|
75501
|
+
toJSON(): Word.Interfaces.CommentCollectionData;
|
|
75502
|
+
}
|
|
75503
|
+
/**
|
|
75504
|
+
* @remarks
|
|
75505
|
+
* [Api set: WordApiOnline 1.1]
|
|
75506
|
+
*/
|
|
75507
|
+
class CommentContentRange extends OfficeExtension.ClientObject {
|
|
75508
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
75509
|
+
context: RequestContext;
|
|
75510
|
+
/**
|
|
75511
|
+
* Gets or sets a value that indicates whether the comment text is bold.
|
|
75512
|
+
*
|
|
75513
|
+
* @remarks
|
|
75514
|
+
* [Api set: WordApiOnline 1.1]
|
|
75515
|
+
*/
|
|
75516
|
+
bold: boolean;
|
|
75517
|
+
/**
|
|
75518
|
+
* 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.
|
|
75519
|
+
*
|
|
75520
|
+
* @remarks
|
|
75521
|
+
* [Api set: WordApiOnline 1.1]
|
|
75522
|
+
*/
|
|
75523
|
+
hyperlink: string;
|
|
75524
|
+
/**
|
|
75525
|
+
* Checks whether the range length is zero. Read-only.
|
|
75526
|
+
*
|
|
75527
|
+
* @remarks
|
|
75528
|
+
* [Api set: WordApiOnline 1.1]
|
|
75529
|
+
*/
|
|
75530
|
+
readonly isEmpty: boolean;
|
|
75531
|
+
/**
|
|
75532
|
+
* Gets or sets a value that indicates whether the comment text is italicized.
|
|
75533
|
+
*
|
|
75534
|
+
* @remarks
|
|
75535
|
+
* [Api set: WordApiOnline 1.1]
|
|
75536
|
+
*/
|
|
75537
|
+
italic: boolean;
|
|
75538
|
+
/**
|
|
75539
|
+
* Gets or sets a value that indicates whether the comment text has a strikethrough.
|
|
75540
|
+
*
|
|
75541
|
+
* @remarks
|
|
75542
|
+
* [Api set: WordApiOnline 1.1]
|
|
75543
|
+
*/
|
|
75544
|
+
strikeThrough: boolean;
|
|
75545
|
+
/**
|
|
75546
|
+
* Gets the text of the comment range. Read-only.
|
|
75547
|
+
*
|
|
75548
|
+
* @remarks
|
|
75549
|
+
* [Api set: WordApiOnline 1.1]
|
|
75550
|
+
*/
|
|
75551
|
+
readonly text: string;
|
|
75552
|
+
/**
|
|
75553
|
+
* Gets or sets a value that indicates the comment text's underline type. 'None' if the comment text is not underlined.
|
|
75554
|
+
*
|
|
75555
|
+
* @remarks
|
|
75556
|
+
* [Api set: WordApiOnline 1.1]
|
|
75557
|
+
*/
|
|
75558
|
+
underline: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble";
|
|
75559
|
+
/**
|
|
75560
|
+
* 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.
|
|
75561
|
+
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
75562
|
+
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
75563
|
+
*/
|
|
75564
|
+
set(properties: Interfaces.CommentContentRangeUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
75565
|
+
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
75566
|
+
set(properties: Word.CommentContentRange): void;
|
|
75567
|
+
/**
|
|
75568
|
+
* Inserts text into at the specified location.
|
|
75569
|
+
*
|
|
75570
|
+
* @remarks
|
|
75571
|
+
* [Api set: WordApiOnline 1.1]
|
|
75572
|
+
*
|
|
75573
|
+
* @param text Required. The text to be inserted in to the CommentContentRange.
|
|
75574
|
+
* @param insertLocation Required. The value must be 'After', 'Before', 'Replace', 'Start', or 'End'.
|
|
75575
|
+
*/
|
|
75576
|
+
insertText(text: string, insertLocation: Word.InsertLocation): Word.CommentContentRange;
|
|
75577
|
+
/**
|
|
75578
|
+
* Inserts text into at the specified location.
|
|
75579
|
+
*
|
|
75580
|
+
* @remarks
|
|
75581
|
+
* [Api set: WordApiOnline 1.1]
|
|
75582
|
+
*
|
|
75583
|
+
* @param text Required. The text to be inserted in to the CommentContentRange.
|
|
75584
|
+
* @param insertLocation Required. The value must be 'After', 'Before', 'Replace', 'Start', or 'End'.
|
|
75585
|
+
*/
|
|
75586
|
+
insertText(text: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.CommentContentRange;
|
|
75587
|
+
/**
|
|
75588
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75589
|
+
*
|
|
75590
|
+
* @param options Provides options for which properties of the object to load.
|
|
75591
|
+
*/
|
|
75592
|
+
load(options?: Word.Interfaces.CommentContentRangeLoadOptions): Word.CommentContentRange;
|
|
75593
|
+
/**
|
|
75594
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75595
|
+
*
|
|
75596
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
75597
|
+
*/
|
|
75598
|
+
load(propertyNames?: string | string[]): Word.CommentContentRange;
|
|
75599
|
+
/**
|
|
75600
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75601
|
+
*
|
|
75602
|
+
* @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.
|
|
75603
|
+
*/
|
|
75604
|
+
load(propertyNamesAndPaths?: {
|
|
75605
|
+
select?: string;
|
|
75606
|
+
expand?: string;
|
|
75607
|
+
}): Word.CommentContentRange;
|
|
75608
|
+
/**
|
|
75609
|
+
* 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.
|
|
75610
|
+
*/
|
|
75611
|
+
track(): Word.CommentContentRange;
|
|
75612
|
+
/**
|
|
75613
|
+
* 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.
|
|
75614
|
+
*/
|
|
75615
|
+
untrack(): Word.CommentContentRange;
|
|
75616
|
+
/**
|
|
75617
|
+
* 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.)
|
|
75618
|
+
* 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.
|
|
75619
|
+
*/
|
|
75620
|
+
toJSON(): Word.Interfaces.CommentContentRangeData;
|
|
75621
|
+
}
|
|
75622
|
+
/**
|
|
75623
|
+
* Represents a comment reply in the document.
|
|
75624
|
+
*
|
|
75625
|
+
* @remarks
|
|
75626
|
+
* [Api set: WordApiOnline 1.1]
|
|
75627
|
+
*/
|
|
75628
|
+
class CommentReply extends OfficeExtension.ClientObject {
|
|
75629
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
75630
|
+
context: RequestContext;
|
|
75631
|
+
/**
|
|
75632
|
+
* Gets or sets the commentReply's content range.
|
|
75633
|
+
*
|
|
75634
|
+
* @remarks
|
|
75635
|
+
* [Api set: WordApiOnline 1.1]
|
|
75636
|
+
*/
|
|
75637
|
+
contentRange: Word.CommentContentRange;
|
|
75638
|
+
/**
|
|
75639
|
+
* Gets the parent comment of this reply.
|
|
75640
|
+
*
|
|
75641
|
+
* @remarks
|
|
75642
|
+
* [Api set: WordApiOnline 1.1]
|
|
75643
|
+
*/
|
|
75644
|
+
readonly parentComment: Word.Comment;
|
|
75645
|
+
/**
|
|
75646
|
+
* Gets the email of the comment reply's author.
|
|
75647
|
+
*
|
|
75648
|
+
* @remarks
|
|
75649
|
+
* [Api set: WordApiOnline 1.1]
|
|
75650
|
+
*/
|
|
75651
|
+
readonly authorEmail: string;
|
|
75652
|
+
/**
|
|
75653
|
+
* Gets the name of the comment reply's author.
|
|
75654
|
+
*
|
|
75655
|
+
* @remarks
|
|
75656
|
+
* [Api set: WordApiOnline 1.1]
|
|
75657
|
+
*/
|
|
75658
|
+
readonly authorName: string;
|
|
75659
|
+
/**
|
|
75660
|
+
* Gets or sets the comment reply's content. The string is plain text.
|
|
75661
|
+
*
|
|
75662
|
+
* @remarks
|
|
75663
|
+
* [Api set: WordApiOnline 1.1]
|
|
75664
|
+
*/
|
|
75665
|
+
content: string;
|
|
75666
|
+
/**
|
|
75667
|
+
* Gets the creation date of the comment reply.
|
|
75668
|
+
*
|
|
75669
|
+
* @remarks
|
|
75670
|
+
* [Api set: WordApiOnline 1.1]
|
|
75671
|
+
*/
|
|
75672
|
+
readonly creationDate: Date;
|
|
75673
|
+
/**
|
|
75674
|
+
* Gets the Id of the comment reply. Read-only.
|
|
75675
|
+
*
|
|
75676
|
+
* @remarks
|
|
75677
|
+
* [Api set: WordApiOnline 1.1]
|
|
75678
|
+
*/
|
|
75679
|
+
readonly id: string;
|
|
75680
|
+
/**
|
|
75681
|
+
* 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.
|
|
75682
|
+
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
75683
|
+
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
75684
|
+
*/
|
|
75685
|
+
set(properties: Interfaces.CommentReplyUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
75686
|
+
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
75687
|
+
set(properties: Word.CommentReply): void;
|
|
75688
|
+
/**
|
|
75689
|
+
* Deletes the comment reply.
|
|
75690
|
+
*
|
|
75691
|
+
* @remarks
|
|
75692
|
+
* [Api set: WordApiOnline 1.1]
|
|
75693
|
+
*/
|
|
75694
|
+
delete(): void;
|
|
75695
|
+
/**
|
|
75696
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75697
|
+
*
|
|
75698
|
+
* @param options Provides options for which properties of the object to load.
|
|
75699
|
+
*/
|
|
75700
|
+
load(options?: Word.Interfaces.CommentReplyLoadOptions): Word.CommentReply;
|
|
75701
|
+
/**
|
|
75702
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75703
|
+
*
|
|
75704
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
75705
|
+
*/
|
|
75706
|
+
load(propertyNames?: string | string[]): Word.CommentReply;
|
|
75707
|
+
/**
|
|
75708
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75709
|
+
*
|
|
75710
|
+
* @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.
|
|
75711
|
+
*/
|
|
75712
|
+
load(propertyNamesAndPaths?: {
|
|
75713
|
+
select?: string;
|
|
75714
|
+
expand?: string;
|
|
75715
|
+
}): Word.CommentReply;
|
|
75716
|
+
/**
|
|
75717
|
+
* 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.
|
|
75718
|
+
*/
|
|
75719
|
+
track(): Word.CommentReply;
|
|
75720
|
+
/**
|
|
75721
|
+
* 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.
|
|
75722
|
+
*/
|
|
75723
|
+
untrack(): Word.CommentReply;
|
|
75724
|
+
/**
|
|
75725
|
+
* 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.)
|
|
75726
|
+
* 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.
|
|
75727
|
+
*/
|
|
75728
|
+
toJSON(): Word.Interfaces.CommentReplyData;
|
|
75729
|
+
}
|
|
75730
|
+
/**
|
|
75731
|
+
* Contains a collection of {@link Word.CommentReply} objects. Represents all comment replies in one comment thread.
|
|
75732
|
+
*
|
|
75733
|
+
* @remarks
|
|
75734
|
+
* [Api set: WordApiOnline 1.1]
|
|
75735
|
+
*/
|
|
75736
|
+
class CommentReplyCollection extends OfficeExtension.ClientObject {
|
|
75737
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
75738
|
+
context: RequestContext;
|
|
75739
|
+
/** Gets the loaded child items in this collection. */
|
|
75740
|
+
readonly items: Word.CommentReply[];
|
|
75741
|
+
/**
|
|
75742
|
+
* Gets the first comment reply in the collection. Throws an error if this collection is empty.
|
|
75743
|
+
*
|
|
75744
|
+
* @remarks
|
|
75745
|
+
* [Api set: WordApiOnline 1.1]
|
|
75746
|
+
*/
|
|
75747
|
+
getFirst(): Word.CommentReply;
|
|
75748
|
+
/**
|
|
75749
|
+
* Gets the first comment reply in the collection. If the collection is empty, returns a null object.
|
|
75750
|
+
*
|
|
75751
|
+
* @remarks
|
|
75752
|
+
* [Api set: WordApiOnline 1.1]
|
|
75753
|
+
*/
|
|
75754
|
+
getFirstOrNullObject(): Word.CommentReply;
|
|
75755
|
+
/**
|
|
75756
|
+
* Gets a comment reply object by its index in the collection.
|
|
75757
|
+
*
|
|
75758
|
+
* @remarks
|
|
75759
|
+
* [Api set: WordApiOnline 1.1]
|
|
75760
|
+
*
|
|
75761
|
+
* @param index A number that identifies the index location of a comment reply object.
|
|
75762
|
+
*/
|
|
75763
|
+
getItem(index: number): Word.CommentReply;
|
|
75764
|
+
/**
|
|
75765
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75766
|
+
*
|
|
75767
|
+
* @param options Provides options for which properties of the object to load.
|
|
75768
|
+
*/
|
|
75769
|
+
load(options?: Word.Interfaces.CommentReplyCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CommentReplyCollection;
|
|
75770
|
+
/**
|
|
75771
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75772
|
+
*
|
|
75773
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
75774
|
+
*/
|
|
75775
|
+
load(propertyNames?: string | string[]): Word.CommentReplyCollection;
|
|
75776
|
+
/**
|
|
75777
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75778
|
+
*
|
|
75779
|
+
* @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.
|
|
75780
|
+
*/
|
|
75781
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CommentReplyCollection;
|
|
75782
|
+
/**
|
|
75783
|
+
* 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.
|
|
75784
|
+
*/
|
|
75785
|
+
track(): Word.CommentReplyCollection;
|
|
75786
|
+
/**
|
|
75787
|
+
* 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.
|
|
75788
|
+
*/
|
|
75789
|
+
untrack(): Word.CommentReplyCollection;
|
|
75790
|
+
/**
|
|
75791
|
+
* 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.)
|
|
75792
|
+
* 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.
|
|
75793
|
+
*/
|
|
75794
|
+
toJSON(): Word.Interfaces.CommentReplyCollectionData;
|
|
75795
|
+
}
|
|
75226
75796
|
/**
|
|
75227
75797
|
* 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.
|
|
75228
75798
|
*
|
|
@@ -75239,6 +75809,13 @@ declare namespace Word {
|
|
|
75239
75809
|
* [Api set: WordApi 1.1]
|
|
75240
75810
|
*/
|
|
75241
75811
|
readonly contentControls: Word.ContentControlCollection;
|
|
75812
|
+
/**
|
|
75813
|
+
* Gets the collection of endnotes in the contentcontrol. Read-only.
|
|
75814
|
+
*
|
|
75815
|
+
* @remarks
|
|
75816
|
+
* [Api set: WordApiOnline 1.1]
|
|
75817
|
+
*/
|
|
75818
|
+
readonly endnotes: Word.NoteItemCollection;
|
|
75242
75819
|
/**
|
|
75243
75820
|
* Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. Read-only.
|
|
75244
75821
|
*
|
|
@@ -75246,6 +75823,13 @@ declare namespace Word {
|
|
|
75246
75823
|
* [Api set: WordApi 1.1]
|
|
75247
75824
|
*/
|
|
75248
75825
|
readonly font: Word.Font;
|
|
75826
|
+
/**
|
|
75827
|
+
* Gets the collection of footnotes in the contentcontrol. Read-only.
|
|
75828
|
+
*
|
|
75829
|
+
* @remarks
|
|
75830
|
+
* [Api set: WordApiOnline 1.1]
|
|
75831
|
+
*/
|
|
75832
|
+
readonly footnotes: Word.NoteItemCollection;
|
|
75249
75833
|
/**
|
|
75250
75834
|
* Gets the collection of inlinePicture objects in the content control. The collection does not include floating images. Read-only.
|
|
75251
75835
|
*
|
|
@@ -75446,6 +76030,13 @@ declare namespace Word {
|
|
|
75446
76030
|
* @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.
|
|
75447
76031
|
*/
|
|
75448
76032
|
delete(keepContent: boolean): void;
|
|
76033
|
+
/**
|
|
76034
|
+
* Gets comments associated with the body.
|
|
76035
|
+
*
|
|
76036
|
+
* @remarks
|
|
76037
|
+
* [Api set: WordApiOnline 1.1]
|
|
76038
|
+
*/
|
|
76039
|
+
getComments(): Word.CommentCollection;
|
|
75449
76040
|
/**
|
|
75450
76041
|
* 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.
|
|
75451
76042
|
*
|
|
@@ -75478,6 +76069,24 @@ declare namespace Word {
|
|
|
75478
76069
|
* @param rangeLocation Optional. The range location must be 'Whole', 'Before', 'Start', 'End', 'After', or 'Content'.
|
|
75479
76070
|
*/
|
|
75480
76071
|
getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
|
|
76072
|
+
/**
|
|
76073
|
+
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
76074
|
+
*
|
|
76075
|
+
* @remarks
|
|
76076
|
+
* [Api set: WordApiOnline 1.1]
|
|
76077
|
+
*
|
|
76078
|
+
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
76079
|
+
*/
|
|
76080
|
+
getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;
|
|
76081
|
+
/**
|
|
76082
|
+
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
76083
|
+
*
|
|
76084
|
+
* @remarks
|
|
76085
|
+
* [Api set: WordApiOnline 1.1]
|
|
76086
|
+
*
|
|
76087
|
+
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
76088
|
+
*/
|
|
76089
|
+
getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
|
|
75481
76090
|
/**
|
|
75482
76091
|
* Gets the text ranges in the content control by using punctuation marks and/or other ending marks.
|
|
75483
76092
|
*
|
|
@@ -76048,6 +76657,13 @@ declare namespace Word {
|
|
|
76048
76657
|
* [Api set: WordApi 1.1]
|
|
76049
76658
|
*/
|
|
76050
76659
|
readonly sections: Word.SectionCollection;
|
|
76660
|
+
/**
|
|
76661
|
+
* Gets or sets the ChangeTracking mode.
|
|
76662
|
+
*
|
|
76663
|
+
* @remarks
|
|
76664
|
+
* [Api set: WordApiOnline 1.1]
|
|
76665
|
+
*/
|
|
76666
|
+
changeTrackingMode: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly";
|
|
76051
76667
|
/**
|
|
76052
76668
|
* 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
76669
|
*
|
|
@@ -76063,6 +76679,22 @@ declare namespace Word {
|
|
|
76063
76679
|
set(properties: Interfaces.DocumentUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
76064
76680
|
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
76065
76681
|
set(properties: Word.Document): void;
|
|
76682
|
+
/**
|
|
76683
|
+
* Gets the document's endnotes in a single body. Read-only.
|
|
76684
|
+
Not implemented in Word on the web.
|
|
76685
|
+
*
|
|
76686
|
+
* @remarks
|
|
76687
|
+
* [Api set: WordApiOnline 1.1]
|
|
76688
|
+
*/
|
|
76689
|
+
getEndnoteBody(): Word.Body;
|
|
76690
|
+
/**
|
|
76691
|
+
* Gets the document's footnotes in a single body. Read-only.
|
|
76692
|
+
Not implemented in Word on the web.
|
|
76693
|
+
*
|
|
76694
|
+
* @remarks
|
|
76695
|
+
* [Api set: WordApiOnline 1.1]
|
|
76696
|
+
*/
|
|
76697
|
+
getFootnoteBody(): Word.Body;
|
|
76066
76698
|
/**
|
|
76067
76699
|
* Gets the current selection of the document. Multiple selections are not supported.
|
|
76068
76700
|
*
|
|
@@ -76077,6 +76709,21 @@ declare namespace Word {
|
|
|
76077
76709
|
* [Api set: WordApi 1.1]
|
|
76078
76710
|
*/
|
|
76079
76711
|
save(): void;
|
|
76712
|
+
/**
|
|
76713
|
+
* Performs a search with the specified search options on the scope of the whole document. The search results are a collection of range objects.
|
|
76714
|
+
*
|
|
76715
|
+
* @remarks
|
|
76716
|
+
* [Api set: WordApiOnline 1.1]
|
|
76717
|
+
*/
|
|
76718
|
+
search(searchText: string, searchOptions?: Word.SearchOptions | {
|
|
76719
|
+
ignorePunct?: boolean;
|
|
76720
|
+
ignoreSpace?: boolean;
|
|
76721
|
+
matchCase?: boolean;
|
|
76722
|
+
matchPrefix?: boolean;
|
|
76723
|
+
matchSuffix?: boolean;
|
|
76724
|
+
matchWholeWord?: boolean;
|
|
76725
|
+
matchWildcards?: boolean;
|
|
76726
|
+
}): Word.RangeCollection;
|
|
76080
76727
|
/**
|
|
76081
76728
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
76082
76729
|
*
|
|
@@ -77313,6 +77960,157 @@ declare namespace Word {
|
|
|
77313
77960
|
*/
|
|
77314
77961
|
toJSON(): Word.Interfaces.ListItemData;
|
|
77315
77962
|
}
|
|
77963
|
+
/**
|
|
77964
|
+
* Represents a footnote or endnote.
|
|
77965
|
+
*
|
|
77966
|
+
* @remarks
|
|
77967
|
+
* [Api set: WordApiOnline 1.1]
|
|
77968
|
+
*/
|
|
77969
|
+
class NoteItem extends OfficeExtension.ClientObject {
|
|
77970
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
77971
|
+
context: RequestContext;
|
|
77972
|
+
/**
|
|
77973
|
+
* Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
|
|
77974
|
+
*
|
|
77975
|
+
* @remarks
|
|
77976
|
+
* [Api set: WordApiOnline 1.1]
|
|
77977
|
+
*/
|
|
77978
|
+
readonly body: Word.Body;
|
|
77979
|
+
/**
|
|
77980
|
+
* Represents a footnote or endnote reference in the main document.
|
|
77981
|
+
*
|
|
77982
|
+
* @remarks
|
|
77983
|
+
* [Api set: WordApiOnline 1.1]
|
|
77984
|
+
*/
|
|
77985
|
+
readonly reference: Word.Range;
|
|
77986
|
+
/**
|
|
77987
|
+
* Represents the note item type: footnote or endnote.
|
|
77988
|
+
*
|
|
77989
|
+
* @remarks
|
|
77990
|
+
* [Api set: WordApiOnline 1.1]
|
|
77991
|
+
*/
|
|
77992
|
+
readonly type: Word.NoteItemType | "Footnote" | "Endnote";
|
|
77993
|
+
/**
|
|
77994
|
+
* 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.
|
|
77995
|
+
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
77996
|
+
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
77997
|
+
*/
|
|
77998
|
+
set(properties: Interfaces.NoteItemUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
77999
|
+
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
78000
|
+
set(properties: Word.NoteItem): void;
|
|
78001
|
+
/**
|
|
78002
|
+
* Deletes the note item.
|
|
78003
|
+
*
|
|
78004
|
+
* @remarks
|
|
78005
|
+
* [Api set: WordApiOnline 1.1]
|
|
78006
|
+
*/
|
|
78007
|
+
delete(): void;
|
|
78008
|
+
/**
|
|
78009
|
+
* Gets the next note item of the same type. Throws an error if this note item is the last one.
|
|
78010
|
+
*
|
|
78011
|
+
* @remarks
|
|
78012
|
+
* [Api set: WordApiOnline 1.1]
|
|
78013
|
+
*/
|
|
78014
|
+
getNext(): Word.NoteItem;
|
|
78015
|
+
/**
|
|
78016
|
+
* Gets the next note item of the same type. Returns a null object if this note item is the last one.
|
|
78017
|
+
*
|
|
78018
|
+
* @remarks
|
|
78019
|
+
* [Api set: WordApiOnline 1.1]
|
|
78020
|
+
*/
|
|
78021
|
+
getNextOrNullObject(): Word.NoteItem;
|
|
78022
|
+
/**
|
|
78023
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
78024
|
+
*
|
|
78025
|
+
* @param options Provides options for which properties of the object to load.
|
|
78026
|
+
*/
|
|
78027
|
+
load(options?: Word.Interfaces.NoteItemLoadOptions): Word.NoteItem;
|
|
78028
|
+
/**
|
|
78029
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
78030
|
+
*
|
|
78031
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
78032
|
+
*/
|
|
78033
|
+
load(propertyNames?: string | string[]): Word.NoteItem;
|
|
78034
|
+
/**
|
|
78035
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
78036
|
+
*
|
|
78037
|
+
* @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.
|
|
78038
|
+
*/
|
|
78039
|
+
load(propertyNamesAndPaths?: {
|
|
78040
|
+
select?: string;
|
|
78041
|
+
expand?: string;
|
|
78042
|
+
}): Word.NoteItem;
|
|
78043
|
+
/**
|
|
78044
|
+
* 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.
|
|
78045
|
+
*/
|
|
78046
|
+
track(): Word.NoteItem;
|
|
78047
|
+
/**
|
|
78048
|
+
* 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.
|
|
78049
|
+
*/
|
|
78050
|
+
untrack(): Word.NoteItem;
|
|
78051
|
+
/**
|
|
78052
|
+
* 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.)
|
|
78053
|
+
* 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.
|
|
78054
|
+
*/
|
|
78055
|
+
toJSON(): Word.Interfaces.NoteItemData;
|
|
78056
|
+
}
|
|
78057
|
+
/**
|
|
78058
|
+
* Contains a collection of {@link Word.NoteItem} objects.
|
|
78059
|
+
*
|
|
78060
|
+
* @remarks
|
|
78061
|
+
* [Api set: WordApiOnline 1.1]
|
|
78062
|
+
*/
|
|
78063
|
+
class NoteItemCollection extends OfficeExtension.ClientObject {
|
|
78064
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
78065
|
+
context: RequestContext;
|
|
78066
|
+
/** Gets the loaded child items in this collection. */
|
|
78067
|
+
readonly items: Word.NoteItem[];
|
|
78068
|
+
/**
|
|
78069
|
+
* Gets the first note item in this collection. Throws an error if this collection is empty.
|
|
78070
|
+
*
|
|
78071
|
+
* @remarks
|
|
78072
|
+
* [Api set: WordApiOnline 1.1]
|
|
78073
|
+
*/
|
|
78074
|
+
getFirst(): Word.NoteItem;
|
|
78075
|
+
/**
|
|
78076
|
+
* Gets the first note item in this collection. Returns a null object if this collection is empty.
|
|
78077
|
+
*
|
|
78078
|
+
* @remarks
|
|
78079
|
+
* [Api set: WordApiOnline 1.1]
|
|
78080
|
+
*/
|
|
78081
|
+
getFirstOrNullObject(): Word.NoteItem;
|
|
78082
|
+
/**
|
|
78083
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
78084
|
+
*
|
|
78085
|
+
* @param options Provides options for which properties of the object to load.
|
|
78086
|
+
*/
|
|
78087
|
+
load(options?: Word.Interfaces.NoteItemCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.NoteItemCollection;
|
|
78088
|
+
/**
|
|
78089
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
78090
|
+
*
|
|
78091
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
78092
|
+
*/
|
|
78093
|
+
load(propertyNames?: string | string[]): Word.NoteItemCollection;
|
|
78094
|
+
/**
|
|
78095
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
78096
|
+
*
|
|
78097
|
+
* @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.
|
|
78098
|
+
*/
|
|
78099
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.NoteItemCollection;
|
|
78100
|
+
/**
|
|
78101
|
+
* 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.
|
|
78102
|
+
*/
|
|
78103
|
+
track(): Word.NoteItemCollection;
|
|
78104
|
+
/**
|
|
78105
|
+
* 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.
|
|
78106
|
+
*/
|
|
78107
|
+
untrack(): Word.NoteItemCollection;
|
|
78108
|
+
/**
|
|
78109
|
+
* 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.)
|
|
78110
|
+
* 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.
|
|
78111
|
+
*/
|
|
78112
|
+
toJSON(): Word.Interfaces.NoteItemCollectionData;
|
|
78113
|
+
}
|
|
77316
78114
|
/**
|
|
77317
78115
|
* Represents a single paragraph in a selection, range, content control, or document body.
|
|
77318
78116
|
*
|
|
@@ -77329,6 +78127,13 @@ declare namespace Word {
|
|
|
77329
78127
|
* [Api set: WordApi 1.1]
|
|
77330
78128
|
*/
|
|
77331
78129
|
readonly contentControls: Word.ContentControlCollection;
|
|
78130
|
+
/**
|
|
78131
|
+
* Gets the collection of endnotes in the paragraph. Read-only.
|
|
78132
|
+
*
|
|
78133
|
+
* @remarks
|
|
78134
|
+
* [Api set: WordApiOnline 1.1]
|
|
78135
|
+
*/
|
|
78136
|
+
readonly endnotes: Word.NoteItemCollection;
|
|
77332
78137
|
/**
|
|
77333
78138
|
* Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. Read-only.
|
|
77334
78139
|
*
|
|
@@ -77336,6 +78141,13 @@ declare namespace Word {
|
|
|
77336
78141
|
* [Api set: WordApi 1.1]
|
|
77337
78142
|
*/
|
|
77338
78143
|
readonly font: Word.Font;
|
|
78144
|
+
/**
|
|
78145
|
+
* Gets the collection of footnotes in the paragraph. Read-only.
|
|
78146
|
+
*
|
|
78147
|
+
* @remarks
|
|
78148
|
+
* [Api set: WordApiOnline 1.1]
|
|
78149
|
+
*/
|
|
78150
|
+
readonly footnotes: Word.NoteItemCollection;
|
|
77339
78151
|
/**
|
|
77340
78152
|
* Gets the collection of InlinePicture objects in the paragraph. The collection does not include floating images. Read-only.
|
|
77341
78153
|
*
|
|
@@ -77571,6 +78383,13 @@ declare namespace Word {
|
|
|
77571
78383
|
* [Api set: WordApi 1.3]
|
|
77572
78384
|
*/
|
|
77573
78385
|
detachFromList(): void;
|
|
78386
|
+
/**
|
|
78387
|
+
* Gets comments associated with the paragraph.
|
|
78388
|
+
*
|
|
78389
|
+
* @remarks
|
|
78390
|
+
* [Api set: WordApiOnline 1.1]
|
|
78391
|
+
*/
|
|
78392
|
+
getComments(): Word.CommentCollection;
|
|
77574
78393
|
/**
|
|
77575
78394
|
* 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
78395
|
*
|
|
@@ -77631,6 +78450,24 @@ declare namespace Word {
|
|
|
77631
78450
|
* @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
|
|
77632
78451
|
*/
|
|
77633
78452
|
getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
|
|
78453
|
+
/**
|
|
78454
|
+
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
78455
|
+
*
|
|
78456
|
+
* @remarks
|
|
78457
|
+
* [Api set: WordApiOnline 1.1]
|
|
78458
|
+
*
|
|
78459
|
+
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
78460
|
+
*/
|
|
78461
|
+
getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;
|
|
78462
|
+
/**
|
|
78463
|
+
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
78464
|
+
*
|
|
78465
|
+
* @remarks
|
|
78466
|
+
* [Api set: WordApiOnline 1.1]
|
|
78467
|
+
*
|
|
78468
|
+
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
78469
|
+
*/
|
|
78470
|
+
getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
|
|
77634
78471
|
/**
|
|
77635
78472
|
* Gets the text ranges in the paragraph by using punctuation marks and/or other ending marks.
|
|
77636
78473
|
*
|
|
@@ -77988,6 +78825,13 @@ declare namespace Word {
|
|
|
77988
78825
|
* [Api set: WordApi 1.1]
|
|
77989
78826
|
*/
|
|
77990
78827
|
readonly contentControls: Word.ContentControlCollection;
|
|
78828
|
+
/**
|
|
78829
|
+
* Gets the collection of endnotes in the range. Read-only.
|
|
78830
|
+
*
|
|
78831
|
+
* @remarks
|
|
78832
|
+
* [Api set: WordApiOnline 1.1]
|
|
78833
|
+
*/
|
|
78834
|
+
readonly endnotes: Word.NoteItemCollection;
|
|
77991
78835
|
/**
|
|
77992
78836
|
* Gets the text format of the range. Use this to get and set font name, size, color, and other properties. Read-only.
|
|
77993
78837
|
*
|
|
@@ -77995,6 +78839,13 @@ declare namespace Word {
|
|
|
77995
78839
|
* [Api set: WordApi 1.1]
|
|
77996
78840
|
*/
|
|
77997
78841
|
readonly font: Word.Font;
|
|
78842
|
+
/**
|
|
78843
|
+
* Gets the collection of footnotes in the range. Read-only.
|
|
78844
|
+
*
|
|
78845
|
+
* @remarks
|
|
78846
|
+
* [Api set: WordApiOnline 1.1]
|
|
78847
|
+
*/
|
|
78848
|
+
readonly footnotes: Word.NoteItemCollection;
|
|
77998
78849
|
/**
|
|
77999
78850
|
* Gets the collection of inline picture objects in the range. Read-only.
|
|
78000
78851
|
*
|
|
@@ -78156,6 +79007,14 @@ declare namespace Word {
|
|
|
78156
79007
|
* @param range Required. Another range.
|
|
78157
79008
|
*/
|
|
78158
79009
|
expandToOrNullObject(range: Word.Range): Word.Range;
|
|
79010
|
+
/**
|
|
79011
|
+
* Gets comments associated with the range.
|
|
79012
|
+
*
|
|
79013
|
+
* @remarks
|
|
79014
|
+
* [Api set: WordApiOnline 1.1]
|
|
79015
|
+
* @returns
|
|
79016
|
+
*/
|
|
79017
|
+
getComments(): Word.CommentCollection;
|
|
78159
79018
|
/**
|
|
78160
79019
|
* 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
79020
|
*
|
|
@@ -78215,6 +79074,24 @@ declare namespace Word {
|
|
|
78215
79074
|
* @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
|
|
78216
79075
|
*/
|
|
78217
79076
|
getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
|
|
79077
|
+
/**
|
|
79078
|
+
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
79079
|
+
*
|
|
79080
|
+
* @remarks
|
|
79081
|
+
* [Api set: WordApiOnline 1.1]
|
|
79082
|
+
*
|
|
79083
|
+
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
79084
|
+
*/
|
|
79085
|
+
getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;
|
|
79086
|
+
/**
|
|
79087
|
+
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
79088
|
+
*
|
|
79089
|
+
* @remarks
|
|
79090
|
+
* [Api set: WordApiOnline 1.1]
|
|
79091
|
+
*
|
|
79092
|
+
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
79093
|
+
*/
|
|
79094
|
+
getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
|
|
78218
79095
|
/**
|
|
78219
79096
|
* Gets the text child ranges in the range by using punctuation marks and/or other ending marks.
|
|
78220
79097
|
*
|
|
@@ -78245,6 +79122,16 @@ declare namespace Word {
|
|
|
78245
79122
|
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
78246
79123
|
*/
|
|
78247
79124
|
insertBreak(breakType: "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): void;
|
|
79125
|
+
/**
|
|
79126
|
+
* Insert a comment on the range.
|
|
79127
|
+
*
|
|
79128
|
+
* @remarks
|
|
79129
|
+
* [Api set: WordApiOnline 1.1]
|
|
79130
|
+
*
|
|
79131
|
+
* @param commentText Required. The comment text to be inserted.
|
|
79132
|
+
* @returns comment object
|
|
79133
|
+
*/
|
|
79134
|
+
insertComment(commentText: string): Word.Comment;
|
|
78248
79135
|
/**
|
|
78249
79136
|
* Wraps the range object with a rich text content control.
|
|
78250
79137
|
*
|
|
@@ -78252,6 +79139,15 @@ declare namespace Word {
|
|
|
78252
79139
|
* [Api set: WordApi 1.1]
|
|
78253
79140
|
*/
|
|
78254
79141
|
insertContentControl(): Word.ContentControl;
|
|
79142
|
+
/**
|
|
79143
|
+
* Inserts an endnote. The endnote reference is placed after the range.
|
|
79144
|
+
*
|
|
79145
|
+
* @remarks
|
|
79146
|
+
* [Api set: WordApiOnline 1.1]
|
|
79147
|
+
*
|
|
79148
|
+
* @param insertText Optional. Text to be inserted into the endnote body. The default is "".
|
|
79149
|
+
*/
|
|
79150
|
+
insertEndnote(insertText?: string): Word.NoteItem;
|
|
78255
79151
|
/**
|
|
78256
79152
|
* Inserts a document at the specified location.
|
|
78257
79153
|
*
|
|
@@ -78272,6 +79168,15 @@ declare namespace Word {
|
|
|
78272
79168
|
* @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
|
|
78273
79169
|
*/
|
|
78274
79170
|
insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
|
|
79171
|
+
/**
|
|
79172
|
+
* Inserts a footnote. The footnote reference is placed after the range.
|
|
79173
|
+
*
|
|
79174
|
+
* @remarks
|
|
79175
|
+
* [Api set: WordApiOnline 1.1]
|
|
79176
|
+
*
|
|
79177
|
+
* @param insertText Optional. Text to be inserted into the footnote body. The default is "".
|
|
79178
|
+
*/
|
|
79179
|
+
insertFootnote(insertText?: string): Word.NoteItem;
|
|
78275
79180
|
/**
|
|
78276
79181
|
* Inserts HTML at the specified location.
|
|
78277
79182
|
*
|
|
@@ -78828,6 +79733,13 @@ declare namespace Word {
|
|
|
78828
79733
|
class Table extends OfficeExtension.ClientObject {
|
|
78829
79734
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
78830
79735
|
context: RequestContext;
|
|
79736
|
+
/**
|
|
79737
|
+
* Gets the collection of endnotes in the table. Read-only.
|
|
79738
|
+
*
|
|
79739
|
+
* @remarks
|
|
79740
|
+
* [Api set: WordApiOnline 1.1]
|
|
79741
|
+
*/
|
|
79742
|
+
readonly endnotes: Word.NoteItemCollection;
|
|
78831
79743
|
/**
|
|
78832
79744
|
* Gets the font. Use this to get and set font name, size, color, and other properties. Read-only.
|
|
78833
79745
|
*
|
|
@@ -78835,6 +79747,13 @@ declare namespace Word {
|
|
|
78835
79747
|
* [Api set: WordApi 1.3]
|
|
78836
79748
|
*/
|
|
78837
79749
|
readonly font: Word.Font;
|
|
79750
|
+
/**
|
|
79751
|
+
* Gets the collection of footnotes in the table. Read-only.
|
|
79752
|
+
*
|
|
79753
|
+
* @remarks
|
|
79754
|
+
* [Api set: WordApiOnline 1.1]
|
|
79755
|
+
*/
|
|
79756
|
+
readonly footnotes: Word.NoteItemCollection;
|
|
78838
79757
|
/**
|
|
78839
79758
|
* Gets the parent body of the table. Read-only.
|
|
78840
79759
|
*
|
|
@@ -79448,6 +80367,13 @@ declare namespace Word {
|
|
|
79448
80367
|
* [Api set: WordApi 1.3]
|
|
79449
80368
|
*/
|
|
79450
80369
|
readonly cells: Word.TableCellCollection;
|
|
80370
|
+
/**
|
|
80371
|
+
* Gets the collection of endnotes in the table row. Read-only.
|
|
80372
|
+
*
|
|
80373
|
+
* @remarks
|
|
80374
|
+
* [Api set: WordApiOnline 1.1]
|
|
80375
|
+
*/
|
|
80376
|
+
readonly endnotes: Word.NoteItemCollection;
|
|
79451
80377
|
/**
|
|
79452
80378
|
* Gets the font. Use this to get and set font name, size, color, and other properties. Read-only.
|
|
79453
80379
|
*
|
|
@@ -79455,6 +80381,13 @@ declare namespace Word {
|
|
|
79455
80381
|
* [Api set: WordApi 1.3]
|
|
79456
80382
|
*/
|
|
79457
80383
|
readonly font: Word.Font;
|
|
80384
|
+
/**
|
|
80385
|
+
* Gets the collection of footnotes in the table row. Read-only.
|
|
80386
|
+
*
|
|
80387
|
+
* @remarks
|
|
80388
|
+
* [Api set: WordApiOnline 1.1]
|
|
80389
|
+
*/
|
|
80390
|
+
readonly footnotes: Word.NoteItemCollection;
|
|
79458
80391
|
/**
|
|
79459
80392
|
* Gets parent table. Read-only.
|
|
79460
80393
|
*
|
|
@@ -80147,6 +81080,68 @@ declare namespace Word {
|
|
|
80147
81080
|
*/
|
|
80148
81081
|
toJSON(): Word.Interfaces.TableBorderData;
|
|
80149
81082
|
}
|
|
81083
|
+
/**
|
|
81084
|
+
* ChangeTracking mode.
|
|
81085
|
+
*
|
|
81086
|
+
* @remarks
|
|
81087
|
+
* [Api set: WordApiOnline 1.1]
|
|
81088
|
+
*/
|
|
81089
|
+
enum ChangeTrackingMode {
|
|
81090
|
+
/**
|
|
81091
|
+
* ChangeTracking is turned off.
|
|
81092
|
+
* @remarks
|
|
81093
|
+
* [Api set: WordApiOnline 1.1]
|
|
81094
|
+
*/
|
|
81095
|
+
off = "Off",
|
|
81096
|
+
/**
|
|
81097
|
+
* ChangeTracking is turned on for everyone.
|
|
81098
|
+
* @remarks
|
|
81099
|
+
* [Api set: WordApiOnline 1.1]
|
|
81100
|
+
*/
|
|
81101
|
+
trackAll = "TrackAll",
|
|
81102
|
+
/**
|
|
81103
|
+
* Tracking is turned on for my changes only.
|
|
81104
|
+
* @remarks
|
|
81105
|
+
* [Api set: WordApiOnline 1.1]
|
|
81106
|
+
*/
|
|
81107
|
+
trackMineOnly = "TrackMineOnly",
|
|
81108
|
+
}
|
|
81109
|
+
/**
|
|
81110
|
+
* Specify the current version or the original version of the text.
|
|
81111
|
+
*
|
|
81112
|
+
* @remarks
|
|
81113
|
+
* [Api set: WordApiOnline 1.1]
|
|
81114
|
+
*/
|
|
81115
|
+
enum ChangeTrackingVersion {
|
|
81116
|
+
/**
|
|
81117
|
+
* @remarks
|
|
81118
|
+
* [Api set: WordApiOnline 1.1]
|
|
81119
|
+
*/
|
|
81120
|
+
original = "Original",
|
|
81121
|
+
/**
|
|
81122
|
+
* @remarks
|
|
81123
|
+
* [Api set: WordApiOnline 1.1]
|
|
81124
|
+
*/
|
|
81125
|
+
current = "Current",
|
|
81126
|
+
}
|
|
81127
|
+
/**
|
|
81128
|
+
* Note item type
|
|
81129
|
+
*
|
|
81130
|
+
* @remarks
|
|
81131
|
+
* [Api set: WordApiOnline 1.1]
|
|
81132
|
+
*/
|
|
81133
|
+
enum NoteItemType {
|
|
81134
|
+
/**
|
|
81135
|
+
* @remarks
|
|
81136
|
+
* [Api set: WordApiOnline 1.1]
|
|
81137
|
+
*/
|
|
81138
|
+
footnote = "Footnote",
|
|
81139
|
+
/**
|
|
81140
|
+
* @remarks
|
|
81141
|
+
* [Api set: WordApiOnline 1.1]
|
|
81142
|
+
*/
|
|
81143
|
+
endnote = "Endnote",
|
|
81144
|
+
}
|
|
80150
81145
|
/**
|
|
80151
81146
|
* Provides information about the type of a raised event. For each object type, please keep the order of: deleted, selection changed, data changed, added.
|
|
80152
81147
|
*
|
|
@@ -80645,6 +81640,21 @@ declare namespace Word {
|
|
|
80645
81640
|
* [Api set: WordApi 1.3]
|
|
80646
81641
|
*/
|
|
80647
81642
|
tableCell = "TableCell",
|
|
81643
|
+
/**
|
|
81644
|
+
* @remarks
|
|
81645
|
+
* [Api set: WordApiOnline 1.1]
|
|
81646
|
+
*/
|
|
81647
|
+
footnote = "Footnote",
|
|
81648
|
+
/**
|
|
81649
|
+
* @remarks
|
|
81650
|
+
* [Api set: WordApiOnline 1.1]
|
|
81651
|
+
*/
|
|
81652
|
+
endnote = "Endnote",
|
|
81653
|
+
/**
|
|
81654
|
+
* @remarks
|
|
81655
|
+
* [Api set: WordApiOnline 1.1]
|
|
81656
|
+
*/
|
|
81657
|
+
noteItem = "NoteItem",
|
|
80648
81658
|
}
|
|
80649
81659
|
/**
|
|
80650
81660
|
* This enum sets where the cursor (insertion point) in the document is after a selection.
|
|
@@ -81962,6 +82972,100 @@ declare namespace Word {
|
|
|
81962
82972
|
*/
|
|
81963
82973
|
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
82974
|
}
|
|
82975
|
+
/** An interface for updating data on the Comment object, for use in `comment.set({ ... })`. */
|
|
82976
|
+
interface CommentUpdateData {
|
|
82977
|
+
/**
|
|
82978
|
+
* Gets or sets the comment's content range.
|
|
82979
|
+
*
|
|
82980
|
+
* @remarks
|
|
82981
|
+
* [Api set: WordApiOnline 1.1]
|
|
82982
|
+
*/
|
|
82983
|
+
contentRange?: Word.Interfaces.CommentContentRangeUpdateData;
|
|
82984
|
+
/**
|
|
82985
|
+
* Gets or sets the comment's content as plain text.
|
|
82986
|
+
*
|
|
82987
|
+
* @remarks
|
|
82988
|
+
* [Api set: WordApiOnline 1.1]
|
|
82989
|
+
*/
|
|
82990
|
+
content?: string;
|
|
82991
|
+
/**
|
|
82992
|
+
* 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.
|
|
82993
|
+
*
|
|
82994
|
+
* @remarks
|
|
82995
|
+
* [Api set: WordApiOnline 1.1]
|
|
82996
|
+
*/
|
|
82997
|
+
resolved?: boolean;
|
|
82998
|
+
}
|
|
82999
|
+
/** An interface for updating data on the CommentCollection object, for use in `commentCollection.set({ ... })`. */
|
|
83000
|
+
interface CommentCollectionUpdateData {
|
|
83001
|
+
items?: Word.Interfaces.CommentData[];
|
|
83002
|
+
}
|
|
83003
|
+
/** An interface for updating data on the CommentContentRange object, for use in `commentContentRange.set({ ... })`. */
|
|
83004
|
+
interface CommentContentRangeUpdateData {
|
|
83005
|
+
/**
|
|
83006
|
+
* Gets or sets a value that indicates whether the comment text is bold.
|
|
83007
|
+
*
|
|
83008
|
+
* @remarks
|
|
83009
|
+
* [Api set: WordApiOnline 1.1]
|
|
83010
|
+
*/
|
|
83011
|
+
bold?: boolean;
|
|
83012
|
+
/**
|
|
83013
|
+
* 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.
|
|
83014
|
+
*
|
|
83015
|
+
* @remarks
|
|
83016
|
+
* [Api set: WordApiOnline 1.1]
|
|
83017
|
+
*/
|
|
83018
|
+
hyperlink?: string;
|
|
83019
|
+
/**
|
|
83020
|
+
* Gets or sets a value that indicates whether the comment text is italicized.
|
|
83021
|
+
*
|
|
83022
|
+
* @remarks
|
|
83023
|
+
* [Api set: WordApiOnline 1.1]
|
|
83024
|
+
*/
|
|
83025
|
+
italic?: boolean;
|
|
83026
|
+
/**
|
|
83027
|
+
* Gets or sets a value that indicates whether the comment text has a strikethrough.
|
|
83028
|
+
*
|
|
83029
|
+
* @remarks
|
|
83030
|
+
* [Api set: WordApiOnline 1.1]
|
|
83031
|
+
*/
|
|
83032
|
+
strikeThrough?: boolean;
|
|
83033
|
+
/**
|
|
83034
|
+
* Gets or sets a value that indicates the comment text's underline type. 'None' if the comment text is not underlined.
|
|
83035
|
+
*
|
|
83036
|
+
* @remarks
|
|
83037
|
+
* [Api set: WordApiOnline 1.1]
|
|
83038
|
+
*/
|
|
83039
|
+
underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble";
|
|
83040
|
+
}
|
|
83041
|
+
/** An interface for updating data on the CommentReply object, for use in `commentReply.set({ ... })`. */
|
|
83042
|
+
interface CommentReplyUpdateData {
|
|
83043
|
+
/**
|
|
83044
|
+
* Gets or sets the commentReply's content range.
|
|
83045
|
+
*
|
|
83046
|
+
* @remarks
|
|
83047
|
+
* [Api set: WordApiOnline 1.1]
|
|
83048
|
+
*/
|
|
83049
|
+
contentRange?: Word.Interfaces.CommentContentRangeUpdateData;
|
|
83050
|
+
/**
|
|
83051
|
+
* Gets the parent comment of this reply.
|
|
83052
|
+
*
|
|
83053
|
+
* @remarks
|
|
83054
|
+
* [Api set: WordApiOnline 1.1]
|
|
83055
|
+
*/
|
|
83056
|
+
parentComment?: Word.Interfaces.CommentUpdateData;
|
|
83057
|
+
/**
|
|
83058
|
+
* Gets or sets the comment reply's content. The string is plain text.
|
|
83059
|
+
*
|
|
83060
|
+
* @remarks
|
|
83061
|
+
* [Api set: WordApiOnline 1.1]
|
|
83062
|
+
*/
|
|
83063
|
+
content?: string;
|
|
83064
|
+
}
|
|
83065
|
+
/** An interface for updating data on the CommentReplyCollection object, for use in `commentReplyCollection.set({ ... })`. */
|
|
83066
|
+
interface CommentReplyCollectionUpdateData {
|
|
83067
|
+
items?: Word.Interfaces.CommentReplyData[];
|
|
83068
|
+
}
|
|
81965
83069
|
/** An interface for updating data on the ContentControl object, for use in `contentControl.set({ ... })`. */
|
|
81966
83070
|
interface ContentControlUpdateData {
|
|
81967
83071
|
/**
|
|
@@ -82077,6 +83181,13 @@ declare namespace Word {
|
|
|
82077
83181
|
* [Api set: WordApi 1.3]
|
|
82078
83182
|
*/
|
|
82079
83183
|
properties?: Word.Interfaces.DocumentPropertiesUpdateData;
|
|
83184
|
+
/**
|
|
83185
|
+
* Gets or sets the ChangeTracking mode.
|
|
83186
|
+
*
|
|
83187
|
+
* @remarks
|
|
83188
|
+
* [Api set: WordApiOnline 1.1]
|
|
83189
|
+
*/
|
|
83190
|
+
changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly";
|
|
82080
83191
|
}
|
|
82081
83192
|
/** An interface for updating data on the DocumentCreated object, for use in `documentCreated.set({ ... })`. */
|
|
82082
83193
|
interface DocumentCreatedUpdateData {
|
|
@@ -82305,6 +83416,27 @@ declare namespace Word {
|
|
|
82305
83416
|
*/
|
|
82306
83417
|
level?: number;
|
|
82307
83418
|
}
|
|
83419
|
+
/** An interface for updating data on the NoteItem object, for use in `noteItem.set({ ... })`. */
|
|
83420
|
+
interface NoteItemUpdateData {
|
|
83421
|
+
/**
|
|
83422
|
+
* Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
|
|
83423
|
+
*
|
|
83424
|
+
* @remarks
|
|
83425
|
+
* [Api set: WordApiOnline 1.1]
|
|
83426
|
+
*/
|
|
83427
|
+
body?: Word.Interfaces.BodyUpdateData;
|
|
83428
|
+
/**
|
|
83429
|
+
* Represents a footnote or endnote reference in the main document.
|
|
83430
|
+
*
|
|
83431
|
+
* @remarks
|
|
83432
|
+
* [Api set: WordApiOnline 1.1]
|
|
83433
|
+
*/
|
|
83434
|
+
reference?: Word.Interfaces.RangeUpdateData;
|
|
83435
|
+
}
|
|
83436
|
+
/** An interface for updating data on the NoteItemCollection object, for use in `noteItemCollection.set({ ... })`. */
|
|
83437
|
+
interface NoteItemCollectionUpdateData {
|
|
83438
|
+
items?: Word.Interfaces.NoteItemData[];
|
|
83439
|
+
}
|
|
82308
83440
|
/** An interface for updating data on the Paragraph object, for use in `paragraph.set({ ... })`. */
|
|
82309
83441
|
interface ParagraphUpdateData {
|
|
82310
83442
|
/**
|
|
@@ -82823,7 +83955,178 @@ declare namespace Word {
|
|
|
82823
83955
|
* @remarks
|
|
82824
83956
|
* [Api set: WordApi 1.3]
|
|
82825
83957
|
*/
|
|
82826
|
-
type?: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell";
|
|
83958
|
+
type?: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" | "Footnote" | "Endnote" | "NoteItem";
|
|
83959
|
+
}
|
|
83960
|
+
/** An interface describing the data returned by calling `comment.toJSON()`. */
|
|
83961
|
+
interface CommentData {
|
|
83962
|
+
/**
|
|
83963
|
+
* Gets or sets the comment's content range.
|
|
83964
|
+
*
|
|
83965
|
+
* @remarks
|
|
83966
|
+
* [Api set: WordApiOnline 1.1]
|
|
83967
|
+
*/
|
|
83968
|
+
contentRange?: Word.Interfaces.CommentContentRangeData;
|
|
83969
|
+
/**
|
|
83970
|
+
* Gets the collection of reply objects associated with the comment.
|
|
83971
|
+
*
|
|
83972
|
+
* @remarks
|
|
83973
|
+
* [Api set: WordApiOnline 1.1]
|
|
83974
|
+
*/
|
|
83975
|
+
replies?: Word.Interfaces.CommentReplyData[];
|
|
83976
|
+
/**
|
|
83977
|
+
* Gets the email of the comment's author.
|
|
83978
|
+
*
|
|
83979
|
+
* @remarks
|
|
83980
|
+
* [Api set: WordApiOnline 1.1]
|
|
83981
|
+
*/
|
|
83982
|
+
authorEmail?: string;
|
|
83983
|
+
/**
|
|
83984
|
+
* Gets the name of the comment's author.
|
|
83985
|
+
*
|
|
83986
|
+
* @remarks
|
|
83987
|
+
* [Api set: WordApiOnline 1.1]
|
|
83988
|
+
*/
|
|
83989
|
+
authorName?: string;
|
|
83990
|
+
/**
|
|
83991
|
+
* Gets or sets the comment's content as plain text.
|
|
83992
|
+
*
|
|
83993
|
+
* @remarks
|
|
83994
|
+
* [Api set: WordApiOnline 1.1]
|
|
83995
|
+
*/
|
|
83996
|
+
content?: string;
|
|
83997
|
+
/**
|
|
83998
|
+
* Gets the creation date of the comment.
|
|
83999
|
+
*
|
|
84000
|
+
* @remarks
|
|
84001
|
+
* [Api set: WordApiOnline 1.1]
|
|
84002
|
+
*/
|
|
84003
|
+
creationDate?: Date;
|
|
84004
|
+
/**
|
|
84005
|
+
* Gets the Id of the comment. Read-only.
|
|
84006
|
+
*
|
|
84007
|
+
* @remarks
|
|
84008
|
+
* [Api set: WordApiOnline 1.1]
|
|
84009
|
+
*/
|
|
84010
|
+
id?: string;
|
|
84011
|
+
/**
|
|
84012
|
+
* 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.
|
|
84013
|
+
*
|
|
84014
|
+
* @remarks
|
|
84015
|
+
* [Api set: WordApiOnline 1.1]
|
|
84016
|
+
*/
|
|
84017
|
+
resolved?: boolean;
|
|
84018
|
+
}
|
|
84019
|
+
/** An interface describing the data returned by calling `commentCollection.toJSON()`. */
|
|
84020
|
+
interface CommentCollectionData {
|
|
84021
|
+
items?: Word.Interfaces.CommentData[];
|
|
84022
|
+
}
|
|
84023
|
+
/** An interface describing the data returned by calling `commentContentRange.toJSON()`. */
|
|
84024
|
+
interface CommentContentRangeData {
|
|
84025
|
+
/**
|
|
84026
|
+
* Gets or sets a value that indicates whether the comment text is bold.
|
|
84027
|
+
*
|
|
84028
|
+
* @remarks
|
|
84029
|
+
* [Api set: WordApiOnline 1.1]
|
|
84030
|
+
*/
|
|
84031
|
+
bold?: boolean;
|
|
84032
|
+
/**
|
|
84033
|
+
* 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.
|
|
84034
|
+
*
|
|
84035
|
+
* @remarks
|
|
84036
|
+
* [Api set: WordApiOnline 1.1]
|
|
84037
|
+
*/
|
|
84038
|
+
hyperlink?: string;
|
|
84039
|
+
/**
|
|
84040
|
+
* Checks whether the range length is zero. Read-only.
|
|
84041
|
+
*
|
|
84042
|
+
* @remarks
|
|
84043
|
+
* [Api set: WordApiOnline 1.1]
|
|
84044
|
+
*/
|
|
84045
|
+
isEmpty?: boolean;
|
|
84046
|
+
/**
|
|
84047
|
+
* Gets or sets a value that indicates whether the comment text is italicized.
|
|
84048
|
+
*
|
|
84049
|
+
* @remarks
|
|
84050
|
+
* [Api set: WordApiOnline 1.1]
|
|
84051
|
+
*/
|
|
84052
|
+
italic?: boolean;
|
|
84053
|
+
/**
|
|
84054
|
+
* Gets or sets a value that indicates whether the comment text has a strikethrough.
|
|
84055
|
+
*
|
|
84056
|
+
* @remarks
|
|
84057
|
+
* [Api set: WordApiOnline 1.1]
|
|
84058
|
+
*/
|
|
84059
|
+
strikeThrough?: boolean;
|
|
84060
|
+
/**
|
|
84061
|
+
* Gets the text of the comment range. Read-only.
|
|
84062
|
+
*
|
|
84063
|
+
* @remarks
|
|
84064
|
+
* [Api set: WordApiOnline 1.1]
|
|
84065
|
+
*/
|
|
84066
|
+
text?: string;
|
|
84067
|
+
/**
|
|
84068
|
+
* Gets or sets a value that indicates the comment text's underline type. 'None' if the comment text is not underlined.
|
|
84069
|
+
*
|
|
84070
|
+
* @remarks
|
|
84071
|
+
* [Api set: WordApiOnline 1.1]
|
|
84072
|
+
*/
|
|
84073
|
+
underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble";
|
|
84074
|
+
}
|
|
84075
|
+
/** An interface describing the data returned by calling `commentReply.toJSON()`. */
|
|
84076
|
+
interface CommentReplyData {
|
|
84077
|
+
/**
|
|
84078
|
+
* Gets or sets the commentReply's content range.
|
|
84079
|
+
*
|
|
84080
|
+
* @remarks
|
|
84081
|
+
* [Api set: WordApiOnline 1.1]
|
|
84082
|
+
*/
|
|
84083
|
+
contentRange?: Word.Interfaces.CommentContentRangeData;
|
|
84084
|
+
/**
|
|
84085
|
+
* Gets the parent comment of this reply.
|
|
84086
|
+
*
|
|
84087
|
+
* @remarks
|
|
84088
|
+
* [Api set: WordApiOnline 1.1]
|
|
84089
|
+
*/
|
|
84090
|
+
parentComment?: Word.Interfaces.CommentData;
|
|
84091
|
+
/**
|
|
84092
|
+
* Gets the email of the comment reply's author.
|
|
84093
|
+
*
|
|
84094
|
+
* @remarks
|
|
84095
|
+
* [Api set: WordApiOnline 1.1]
|
|
84096
|
+
*/
|
|
84097
|
+
authorEmail?: string;
|
|
84098
|
+
/**
|
|
84099
|
+
* Gets the name of the comment reply's author.
|
|
84100
|
+
*
|
|
84101
|
+
* @remarks
|
|
84102
|
+
* [Api set: WordApiOnline 1.1]
|
|
84103
|
+
*/
|
|
84104
|
+
authorName?: string;
|
|
84105
|
+
/**
|
|
84106
|
+
* Gets or sets the comment reply's content. The string is plain text.
|
|
84107
|
+
*
|
|
84108
|
+
* @remarks
|
|
84109
|
+
* [Api set: WordApiOnline 1.1]
|
|
84110
|
+
*/
|
|
84111
|
+
content?: string;
|
|
84112
|
+
/**
|
|
84113
|
+
* Gets the creation date of the comment reply.
|
|
84114
|
+
*
|
|
84115
|
+
* @remarks
|
|
84116
|
+
* [Api set: WordApiOnline 1.1]
|
|
84117
|
+
*/
|
|
84118
|
+
creationDate?: Date;
|
|
84119
|
+
/**
|
|
84120
|
+
* Gets the Id of the comment reply. Read-only.
|
|
84121
|
+
*
|
|
84122
|
+
* @remarks
|
|
84123
|
+
* [Api set: WordApiOnline 1.1]
|
|
84124
|
+
*/
|
|
84125
|
+
id?: string;
|
|
84126
|
+
}
|
|
84127
|
+
/** An interface describing the data returned by calling `commentReplyCollection.toJSON()`. */
|
|
84128
|
+
interface CommentReplyCollectionData {
|
|
84129
|
+
items?: Word.Interfaces.CommentReplyData[];
|
|
82827
84130
|
}
|
|
82828
84131
|
/** An interface describing the data returned by calling `contentControl.toJSON()`. */
|
|
82829
84132
|
interface ContentControlData {
|
|
@@ -83031,6 +84334,13 @@ declare namespace Word {
|
|
|
83031
84334
|
* [Api set: WordApi 1.1]
|
|
83032
84335
|
*/
|
|
83033
84336
|
sections?: Word.Interfaces.SectionData[];
|
|
84337
|
+
/**
|
|
84338
|
+
* Gets or sets the ChangeTracking mode.
|
|
84339
|
+
*
|
|
84340
|
+
* @remarks
|
|
84341
|
+
* [Api set: WordApiOnline 1.1]
|
|
84342
|
+
*/
|
|
84343
|
+
changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly";
|
|
83034
84344
|
/**
|
|
83035
84345
|
* 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
84346
|
*
|
|
@@ -83395,6 +84705,34 @@ declare namespace Word {
|
|
|
83395
84705
|
*/
|
|
83396
84706
|
siblingIndex?: number;
|
|
83397
84707
|
}
|
|
84708
|
+
/** An interface describing the data returned by calling `noteItem.toJSON()`. */
|
|
84709
|
+
interface NoteItemData {
|
|
84710
|
+
/**
|
|
84711
|
+
* Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
|
|
84712
|
+
*
|
|
84713
|
+
* @remarks
|
|
84714
|
+
* [Api set: WordApiOnline 1.1]
|
|
84715
|
+
*/
|
|
84716
|
+
body?: Word.Interfaces.BodyData;
|
|
84717
|
+
/**
|
|
84718
|
+
* Represents a footnote or endnote reference in the main document.
|
|
84719
|
+
*
|
|
84720
|
+
* @remarks
|
|
84721
|
+
* [Api set: WordApiOnline 1.1]
|
|
84722
|
+
*/
|
|
84723
|
+
reference?: Word.Interfaces.RangeData;
|
|
84724
|
+
/**
|
|
84725
|
+
* Represents the note item type: footnote or endnote.
|
|
84726
|
+
*
|
|
84727
|
+
* @remarks
|
|
84728
|
+
* [Api set: WordApiOnline 1.1]
|
|
84729
|
+
*/
|
|
84730
|
+
type?: Word.NoteItemType | "Footnote" | "Endnote";
|
|
84731
|
+
}
|
|
84732
|
+
/** An interface describing the data returned by calling `noteItemCollection.toJSON()`. */
|
|
84733
|
+
interface NoteItemCollectionData {
|
|
84734
|
+
items?: Word.Interfaces.NoteItemData[];
|
|
84735
|
+
}
|
|
83398
84736
|
/** An interface describing the data returned by calling `paragraph.toJSON()`. */
|
|
83399
84737
|
interface ParagraphData {
|
|
83400
84738
|
/**
|
|
@@ -84071,6 +85409,309 @@ declare namespace Word {
|
|
|
84071
85409
|
*/
|
|
84072
85410
|
type?: boolean;
|
|
84073
85411
|
}
|
|
85412
|
+
/**
|
|
85413
|
+
* Represents a comment in the document.
|
|
85414
|
+
*
|
|
85415
|
+
* @remarks
|
|
85416
|
+
* [Api set: WordApiOnline 1.1]
|
|
85417
|
+
*/
|
|
85418
|
+
interface CommentLoadOptions {
|
|
85419
|
+
/**
|
|
85420
|
+
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`).
|
|
85421
|
+
*/
|
|
85422
|
+
$all?: boolean;
|
|
85423
|
+
/**
|
|
85424
|
+
* Gets or sets the comment's content range.
|
|
85425
|
+
*
|
|
85426
|
+
* @remarks
|
|
85427
|
+
* [Api set: WordApiOnline 1.1]
|
|
85428
|
+
*/
|
|
85429
|
+
contentRange?: Word.Interfaces.CommentContentRangeLoadOptions;
|
|
85430
|
+
/**
|
|
85431
|
+
* Gets the email of the comment's author.
|
|
85432
|
+
*
|
|
85433
|
+
* @remarks
|
|
85434
|
+
* [Api set: WordApiOnline 1.1]
|
|
85435
|
+
*/
|
|
85436
|
+
authorEmail?: boolean;
|
|
85437
|
+
/**
|
|
85438
|
+
* Gets the name of the comment's author.
|
|
85439
|
+
*
|
|
85440
|
+
* @remarks
|
|
85441
|
+
* [Api set: WordApiOnline 1.1]
|
|
85442
|
+
*/
|
|
85443
|
+
authorName?: boolean;
|
|
85444
|
+
/**
|
|
85445
|
+
* Gets or sets the comment's content as plain text.
|
|
85446
|
+
*
|
|
85447
|
+
* @remarks
|
|
85448
|
+
* [Api set: WordApiOnline 1.1]
|
|
85449
|
+
*/
|
|
85450
|
+
content?: boolean;
|
|
85451
|
+
/**
|
|
85452
|
+
* Gets the creation date of the comment.
|
|
85453
|
+
*
|
|
85454
|
+
* @remarks
|
|
85455
|
+
* [Api set: WordApiOnline 1.1]
|
|
85456
|
+
*/
|
|
85457
|
+
creationDate?: boolean;
|
|
85458
|
+
/**
|
|
85459
|
+
* Gets the Id of the comment. Read-only.
|
|
85460
|
+
*
|
|
85461
|
+
* @remarks
|
|
85462
|
+
* [Api set: WordApiOnline 1.1]
|
|
85463
|
+
*/
|
|
85464
|
+
id?: boolean;
|
|
85465
|
+
/**
|
|
85466
|
+
* 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.
|
|
85467
|
+
*
|
|
85468
|
+
* @remarks
|
|
85469
|
+
* [Api set: WordApiOnline 1.1]
|
|
85470
|
+
*/
|
|
85471
|
+
resolved?: boolean;
|
|
85472
|
+
}
|
|
85473
|
+
/**
|
|
85474
|
+
* Contains a collection of {@link Word.Comment} objects.
|
|
85475
|
+
*
|
|
85476
|
+
* @remarks
|
|
85477
|
+
* [Api set: WordApiOnline 1.1]
|
|
85478
|
+
*/
|
|
85479
|
+
interface CommentCollectionLoadOptions {
|
|
85480
|
+
/**
|
|
85481
|
+
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`).
|
|
85482
|
+
*/
|
|
85483
|
+
$all?: boolean;
|
|
85484
|
+
/**
|
|
85485
|
+
* For EACH ITEM in the collection: Gets or sets the comment's content range.
|
|
85486
|
+
*
|
|
85487
|
+
* @remarks
|
|
85488
|
+
* [Api set: WordApiOnline 1.1]
|
|
85489
|
+
*/
|
|
85490
|
+
contentRange?: Word.Interfaces.CommentContentRangeLoadOptions;
|
|
85491
|
+
/**
|
|
85492
|
+
* For EACH ITEM in the collection: Gets the email of the comment's author.
|
|
85493
|
+
*
|
|
85494
|
+
* @remarks
|
|
85495
|
+
* [Api set: WordApiOnline 1.1]
|
|
85496
|
+
*/
|
|
85497
|
+
authorEmail?: boolean;
|
|
85498
|
+
/**
|
|
85499
|
+
* For EACH ITEM in the collection: Gets the name of the comment's author.
|
|
85500
|
+
*
|
|
85501
|
+
* @remarks
|
|
85502
|
+
* [Api set: WordApiOnline 1.1]
|
|
85503
|
+
*/
|
|
85504
|
+
authorName?: boolean;
|
|
85505
|
+
/**
|
|
85506
|
+
* For EACH ITEM in the collection: Gets or sets the comment's content as plain text.
|
|
85507
|
+
*
|
|
85508
|
+
* @remarks
|
|
85509
|
+
* [Api set: WordApiOnline 1.1]
|
|
85510
|
+
*/
|
|
85511
|
+
content?: boolean;
|
|
85512
|
+
/**
|
|
85513
|
+
* For EACH ITEM in the collection: Gets the creation date of the comment.
|
|
85514
|
+
*
|
|
85515
|
+
* @remarks
|
|
85516
|
+
* [Api set: WordApiOnline 1.1]
|
|
85517
|
+
*/
|
|
85518
|
+
creationDate?: boolean;
|
|
85519
|
+
/**
|
|
85520
|
+
* For EACH ITEM in the collection: Gets the Id of the comment. Read-only.
|
|
85521
|
+
*
|
|
85522
|
+
* @remarks
|
|
85523
|
+
* [Api set: WordApiOnline 1.1]
|
|
85524
|
+
*/
|
|
85525
|
+
id?: boolean;
|
|
85526
|
+
/**
|
|
85527
|
+
* 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.
|
|
85528
|
+
*
|
|
85529
|
+
* @remarks
|
|
85530
|
+
* [Api set: WordApiOnline 1.1]
|
|
85531
|
+
*/
|
|
85532
|
+
resolved?: boolean;
|
|
85533
|
+
}
|
|
85534
|
+
/**
|
|
85535
|
+
* @remarks
|
|
85536
|
+
* [Api set: WordApiOnline 1.1]
|
|
85537
|
+
*/
|
|
85538
|
+
interface CommentContentRangeLoadOptions {
|
|
85539
|
+
/**
|
|
85540
|
+
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`).
|
|
85541
|
+
*/
|
|
85542
|
+
$all?: boolean;
|
|
85543
|
+
/**
|
|
85544
|
+
* Gets or sets a value that indicates whether the comment text is bold.
|
|
85545
|
+
*
|
|
85546
|
+
* @remarks
|
|
85547
|
+
* [Api set: WordApiOnline 1.1]
|
|
85548
|
+
*/
|
|
85549
|
+
bold?: boolean;
|
|
85550
|
+
/**
|
|
85551
|
+
* 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.
|
|
85552
|
+
*
|
|
85553
|
+
* @remarks
|
|
85554
|
+
* [Api set: WordApiOnline 1.1]
|
|
85555
|
+
*/
|
|
85556
|
+
hyperlink?: boolean;
|
|
85557
|
+
/**
|
|
85558
|
+
* Checks whether the range length is zero. Read-only.
|
|
85559
|
+
*
|
|
85560
|
+
* @remarks
|
|
85561
|
+
* [Api set: WordApiOnline 1.1]
|
|
85562
|
+
*/
|
|
85563
|
+
isEmpty?: boolean;
|
|
85564
|
+
/**
|
|
85565
|
+
* Gets or sets a value that indicates whether the comment text is italicized.
|
|
85566
|
+
*
|
|
85567
|
+
* @remarks
|
|
85568
|
+
* [Api set: WordApiOnline 1.1]
|
|
85569
|
+
*/
|
|
85570
|
+
italic?: boolean;
|
|
85571
|
+
/**
|
|
85572
|
+
* Gets or sets a value that indicates whether the comment text has a strikethrough.
|
|
85573
|
+
*
|
|
85574
|
+
* @remarks
|
|
85575
|
+
* [Api set: WordApiOnline 1.1]
|
|
85576
|
+
*/
|
|
85577
|
+
strikeThrough?: boolean;
|
|
85578
|
+
/**
|
|
85579
|
+
* Gets the text of the comment range. Read-only.
|
|
85580
|
+
*
|
|
85581
|
+
* @remarks
|
|
85582
|
+
* [Api set: WordApiOnline 1.1]
|
|
85583
|
+
*/
|
|
85584
|
+
text?: boolean;
|
|
85585
|
+
/**
|
|
85586
|
+
* Gets or sets a value that indicates the comment text's underline type. 'None' if the comment text is not underlined.
|
|
85587
|
+
*
|
|
85588
|
+
* @remarks
|
|
85589
|
+
* [Api set: WordApiOnline 1.1]
|
|
85590
|
+
*/
|
|
85591
|
+
underline?: boolean;
|
|
85592
|
+
}
|
|
85593
|
+
/**
|
|
85594
|
+
* Represents a comment reply in the document.
|
|
85595
|
+
*
|
|
85596
|
+
* @remarks
|
|
85597
|
+
* [Api set: WordApiOnline 1.1]
|
|
85598
|
+
*/
|
|
85599
|
+
interface CommentReplyLoadOptions {
|
|
85600
|
+
/**
|
|
85601
|
+
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`).
|
|
85602
|
+
*/
|
|
85603
|
+
$all?: boolean;
|
|
85604
|
+
/**
|
|
85605
|
+
* Gets or sets the commentReply's content range.
|
|
85606
|
+
*
|
|
85607
|
+
* @remarks
|
|
85608
|
+
* [Api set: WordApiOnline 1.1]
|
|
85609
|
+
*/
|
|
85610
|
+
contentRange?: Word.Interfaces.CommentContentRangeLoadOptions;
|
|
85611
|
+
/**
|
|
85612
|
+
* Gets the parent comment of this reply.
|
|
85613
|
+
*
|
|
85614
|
+
* @remarks
|
|
85615
|
+
* [Api set: WordApiOnline 1.1]
|
|
85616
|
+
*/
|
|
85617
|
+
parentComment?: Word.Interfaces.CommentLoadOptions;
|
|
85618
|
+
/**
|
|
85619
|
+
* Gets the email of the comment reply's author.
|
|
85620
|
+
*
|
|
85621
|
+
* @remarks
|
|
85622
|
+
* [Api set: WordApiOnline 1.1]
|
|
85623
|
+
*/
|
|
85624
|
+
authorEmail?: boolean;
|
|
85625
|
+
/**
|
|
85626
|
+
* Gets the name of the comment reply's author.
|
|
85627
|
+
*
|
|
85628
|
+
* @remarks
|
|
85629
|
+
* [Api set: WordApiOnline 1.1]
|
|
85630
|
+
*/
|
|
85631
|
+
authorName?: boolean;
|
|
85632
|
+
/**
|
|
85633
|
+
* Gets or sets the comment reply's content. The string is plain text.
|
|
85634
|
+
*
|
|
85635
|
+
* @remarks
|
|
85636
|
+
* [Api set: WordApiOnline 1.1]
|
|
85637
|
+
*/
|
|
85638
|
+
content?: boolean;
|
|
85639
|
+
/**
|
|
85640
|
+
* Gets the creation date of the comment reply.
|
|
85641
|
+
*
|
|
85642
|
+
* @remarks
|
|
85643
|
+
* [Api set: WordApiOnline 1.1]
|
|
85644
|
+
*/
|
|
85645
|
+
creationDate?: boolean;
|
|
85646
|
+
/**
|
|
85647
|
+
* Gets the Id of the comment reply. Read-only.
|
|
85648
|
+
*
|
|
85649
|
+
* @remarks
|
|
85650
|
+
* [Api set: WordApiOnline 1.1]
|
|
85651
|
+
*/
|
|
85652
|
+
id?: boolean;
|
|
85653
|
+
}
|
|
85654
|
+
/**
|
|
85655
|
+
* Contains a collection of {@link Word.CommentReply} objects. Represents all comment replies in one comment thread.
|
|
85656
|
+
*
|
|
85657
|
+
* @remarks
|
|
85658
|
+
* [Api set: WordApiOnline 1.1]
|
|
85659
|
+
*/
|
|
85660
|
+
interface CommentReplyCollectionLoadOptions {
|
|
85661
|
+
/**
|
|
85662
|
+
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`).
|
|
85663
|
+
*/
|
|
85664
|
+
$all?: boolean;
|
|
85665
|
+
/**
|
|
85666
|
+
* For EACH ITEM in the collection: Gets or sets the commentReply's content range.
|
|
85667
|
+
*
|
|
85668
|
+
* @remarks
|
|
85669
|
+
* [Api set: WordApiOnline 1.1]
|
|
85670
|
+
*/
|
|
85671
|
+
contentRange?: Word.Interfaces.CommentContentRangeLoadOptions;
|
|
85672
|
+
/**
|
|
85673
|
+
* For EACH ITEM in the collection: Gets the parent comment of this reply.
|
|
85674
|
+
*
|
|
85675
|
+
* @remarks
|
|
85676
|
+
* [Api set: WordApiOnline 1.1]
|
|
85677
|
+
*/
|
|
85678
|
+
parentComment?: Word.Interfaces.CommentLoadOptions;
|
|
85679
|
+
/**
|
|
85680
|
+
* For EACH ITEM in the collection: Gets the email of the comment reply's author.
|
|
85681
|
+
*
|
|
85682
|
+
* @remarks
|
|
85683
|
+
* [Api set: WordApiOnline 1.1]
|
|
85684
|
+
*/
|
|
85685
|
+
authorEmail?: boolean;
|
|
85686
|
+
/**
|
|
85687
|
+
* For EACH ITEM in the collection: Gets the name of the comment reply's author.
|
|
85688
|
+
*
|
|
85689
|
+
* @remarks
|
|
85690
|
+
* [Api set: WordApiOnline 1.1]
|
|
85691
|
+
*/
|
|
85692
|
+
authorName?: boolean;
|
|
85693
|
+
/**
|
|
85694
|
+
* For EACH ITEM in the collection: Gets or sets the comment reply's content. The string is plain text.
|
|
85695
|
+
*
|
|
85696
|
+
* @remarks
|
|
85697
|
+
* [Api set: WordApiOnline 1.1]
|
|
85698
|
+
*/
|
|
85699
|
+
content?: boolean;
|
|
85700
|
+
/**
|
|
85701
|
+
* For EACH ITEM in the collection: Gets the creation date of the comment reply.
|
|
85702
|
+
*
|
|
85703
|
+
* @remarks
|
|
85704
|
+
* [Api set: WordApiOnline 1.1]
|
|
85705
|
+
*/
|
|
85706
|
+
creationDate?: boolean;
|
|
85707
|
+
/**
|
|
85708
|
+
* For EACH ITEM in the collection: Gets the Id of the comment reply. Read-only.
|
|
85709
|
+
*
|
|
85710
|
+
* @remarks
|
|
85711
|
+
* [Api set: WordApiOnline 1.1]
|
|
85712
|
+
*/
|
|
85713
|
+
id?: boolean;
|
|
85714
|
+
}
|
|
84074
85715
|
/**
|
|
84075
85716
|
* 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.
|
|
84076
85717
|
*
|
|
@@ -84496,6 +86137,13 @@ declare namespace Word {
|
|
|
84496
86137
|
* [Api set: WordApi 1.3]
|
|
84497
86138
|
*/
|
|
84498
86139
|
properties?: Word.Interfaces.DocumentPropertiesLoadOptions;
|
|
86140
|
+
/**
|
|
86141
|
+
* Gets or sets the ChangeTracking mode.
|
|
86142
|
+
*
|
|
86143
|
+
* @remarks
|
|
86144
|
+
* [Api set: WordApiOnline 1.1]
|
|
86145
|
+
*/
|
|
86146
|
+
changeTrackingMode?: boolean;
|
|
84499
86147
|
/**
|
|
84500
86148
|
* 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
86149
|
*
|
|
@@ -85063,6 +86711,72 @@ declare namespace Word {
|
|
|
85063
86711
|
*/
|
|
85064
86712
|
siblingIndex?: boolean;
|
|
85065
86713
|
}
|
|
86714
|
+
/**
|
|
86715
|
+
* Represents a footnote or endnote.
|
|
86716
|
+
*
|
|
86717
|
+
* @remarks
|
|
86718
|
+
* [Api set: WordApiOnline 1.1]
|
|
86719
|
+
*/
|
|
86720
|
+
interface NoteItemLoadOptions {
|
|
86721
|
+
/**
|
|
86722
|
+
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`).
|
|
86723
|
+
*/
|
|
86724
|
+
$all?: boolean;
|
|
86725
|
+
/**
|
|
86726
|
+
* Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
|
|
86727
|
+
*
|
|
86728
|
+
* @remarks
|
|
86729
|
+
* [Api set: WordApiOnline 1.1]
|
|
86730
|
+
*/
|
|
86731
|
+
body?: Word.Interfaces.BodyLoadOptions;
|
|
86732
|
+
/**
|
|
86733
|
+
* Represents a footnote or endnote reference in the main document.
|
|
86734
|
+
*
|
|
86735
|
+
* @remarks
|
|
86736
|
+
* [Api set: WordApiOnline 1.1]
|
|
86737
|
+
*/
|
|
86738
|
+
reference?: Word.Interfaces.RangeLoadOptions;
|
|
86739
|
+
/**
|
|
86740
|
+
* Represents the note item type: footnote or endnote.
|
|
86741
|
+
*
|
|
86742
|
+
* @remarks
|
|
86743
|
+
* [Api set: WordApiOnline 1.1]
|
|
86744
|
+
*/
|
|
86745
|
+
type?: boolean;
|
|
86746
|
+
}
|
|
86747
|
+
/**
|
|
86748
|
+
* Contains a collection of {@link Word.NoteItem} objects.
|
|
86749
|
+
*
|
|
86750
|
+
* @remarks
|
|
86751
|
+
* [Api set: WordApiOnline 1.1]
|
|
86752
|
+
*/
|
|
86753
|
+
interface NoteItemCollectionLoadOptions {
|
|
86754
|
+
/**
|
|
86755
|
+
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`).
|
|
86756
|
+
*/
|
|
86757
|
+
$all?: boolean;
|
|
86758
|
+
/**
|
|
86759
|
+
* 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.
|
|
86760
|
+
*
|
|
86761
|
+
* @remarks
|
|
86762
|
+
* [Api set: WordApiOnline 1.1]
|
|
86763
|
+
*/
|
|
86764
|
+
body?: Word.Interfaces.BodyLoadOptions;
|
|
86765
|
+
/**
|
|
86766
|
+
* For EACH ITEM in the collection: Represents a footnote or endnote reference in the main document.
|
|
86767
|
+
*
|
|
86768
|
+
* @remarks
|
|
86769
|
+
* [Api set: WordApiOnline 1.1]
|
|
86770
|
+
*/
|
|
86771
|
+
reference?: Word.Interfaces.RangeLoadOptions;
|
|
86772
|
+
/**
|
|
86773
|
+
* For EACH ITEM in the collection: Represents the note item type: footnote or endnote.
|
|
86774
|
+
*
|
|
86775
|
+
* @remarks
|
|
86776
|
+
* [Api set: WordApiOnline 1.1]
|
|
86777
|
+
*/
|
|
86778
|
+
type?: boolean;
|
|
86779
|
+
}
|
|
85066
86780
|
/**
|
|
85067
86781
|
* Represents a single paragraph in a selection, range, content control, or document body.
|
|
85068
86782
|
*
|