@types/office-js 1.0.356 → 1.0.358
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 +1426 -415
- office-js/package.json +2 -2
office-js/index.d.ts
CHANGED
|
@@ -83795,6 +83795,22 @@ declare namespace Word {
|
|
|
83795
83795
|
* @param base64File Optional. The Base64-encoded .docx file. The default value is null.
|
|
83796
83796
|
*/
|
|
83797
83797
|
createDocument(base64File?: string): Word.DocumentCreated;
|
|
83798
|
+
/**
|
|
83799
|
+
* Opens a document and displays it in a new tab or window.
|
|
83800
|
+
The following are examples for the various supported clients and platforms.
|
|
83801
|
+
|
|
83802
|
+
- Remote or cloud location example: `https://microsoft.sharepoint.com/some/path/Document.docx`
|
|
83803
|
+
|
|
83804
|
+
- Local location examples for Windows: `C:\\Users\\Someone\\Documents\\Document.docx` (includes required escaped backslashes), `file://mycomputer/myfolder/Document.docx`
|
|
83805
|
+
|
|
83806
|
+
- Local location example for Mac and iOS: `/User/someone/document.docx`
|
|
83807
|
+
*
|
|
83808
|
+
* @remarks
|
|
83809
|
+
* [Api set: WordApi 1.6]
|
|
83810
|
+
*
|
|
83811
|
+
* @param filePath Required. The absolute path of the .docx file. Word on the web only supports remote (cloud) locations, while Word on Windows, on Mac, and on iOS support local and remote locations.
|
|
83812
|
+
*/
|
|
83813
|
+
openDocument(filePath: string): void;
|
|
83798
83814
|
/**
|
|
83799
83815
|
* Parse styles from template Base64 file and return JSON format of retrieved styles as a string.
|
|
83800
83816
|
*
|
|
@@ -83861,7 +83877,7 @@ declare namespace Word {
|
|
|
83861
83877
|
*/
|
|
83862
83878
|
readonly footnotes: Word.NoteItemCollection;
|
|
83863
83879
|
/**
|
|
83864
|
-
* Gets the collection of InlinePicture objects in the body. The collection
|
|
83880
|
+
* Gets the collection of InlinePicture objects in the body. The collection doesn't include floating images.
|
|
83865
83881
|
*
|
|
83866
83882
|
* @remarks
|
|
83867
83883
|
* [Api set: WordApi 1.1]
|
|
@@ -83875,10 +83891,12 @@ declare namespace Word {
|
|
|
83875
83891
|
*/
|
|
83876
83892
|
readonly lists: Word.ListCollection;
|
|
83877
83893
|
/**
|
|
83878
|
-
* Gets the collection of paragraph objects in the body.
|
|
83894
|
+
* Gets the collection of paragraph objects in the body.
|
|
83879
83895
|
*
|
|
83880
83896
|
* @remarks
|
|
83881
83897
|
* [Api set: WordApi 1.1]
|
|
83898
|
+
*
|
|
83899
|
+
* Important: Paragraphs in tables aren't returned for requirement sets 1.1 and 1.2. From requirement set 1.3, paragraphs in tables are also returned.
|
|
83882
83900
|
*/
|
|
83883
83901
|
readonly paragraphs: Word.ParagraphCollection;
|
|
83884
83902
|
/**
|
|
@@ -83981,18 +83999,20 @@ declare namespace Word {
|
|
|
83981
83999
|
*/
|
|
83982
84000
|
getComments(): Word.CommentCollection;
|
|
83983
84001
|
/**
|
|
83984
|
-
* Gets the currently supported content controls in the body.
|
|
83985
|
-
Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type.
|
|
83986
|
-
With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
|
|
84002
|
+
* Gets the currently supported content controls in the body.
|
|
83987
84003
|
*
|
|
83988
84004
|
* @remarks
|
|
83989
84005
|
* [Api set: WordApi 1.5]
|
|
83990
84006
|
*
|
|
84007
|
+
* Important: If specific types are provided in the options parameter, only content controls of supported types are returned.
|
|
84008
|
+
* Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type.
|
|
84009
|
+
* With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
|
|
84010
|
+
*
|
|
83991
84011
|
* @param options Optional. Options that define which content controls are returned.
|
|
83992
84012
|
*/
|
|
83993
84013
|
getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;
|
|
83994
84014
|
/**
|
|
83995
|
-
* 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
|
|
84015
|
+
* 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 doesn't 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.
|
|
83996
84016
|
*
|
|
83997
84017
|
* @remarks
|
|
83998
84018
|
* [Api set: WordApi 1.1]
|
|
@@ -84032,6 +84052,13 @@ declare namespace Word {
|
|
|
84032
84052
|
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
84033
84053
|
*/
|
|
84034
84054
|
getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
|
|
84055
|
+
/**
|
|
84056
|
+
* Gets the collection of the TrackedChange objects in the body.
|
|
84057
|
+
*
|
|
84058
|
+
* @remarks
|
|
84059
|
+
* [Api set: WordApi 1.6]
|
|
84060
|
+
*/
|
|
84061
|
+
getTrackedChanges(): Word.TrackedChangeCollection;
|
|
84035
84062
|
/**
|
|
84036
84063
|
* Inserts a break at the specified location in the main document.
|
|
84037
84064
|
*
|
|
@@ -84436,7 +84463,7 @@ declare namespace Word {
|
|
|
84436
84463
|
*/
|
|
84437
84464
|
readonly text: string;
|
|
84438
84465
|
/**
|
|
84439
|
-
* Specifies a value that indicates the comment text's underline type. 'None' if the comment text
|
|
84466
|
+
* Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined.
|
|
84440
84467
|
*
|
|
84441
84468
|
* @remarks
|
|
84442
84469
|
* [Api set: WordApi 1.4]
|
|
@@ -84705,7 +84732,7 @@ declare namespace Word {
|
|
|
84705
84732
|
*/
|
|
84706
84733
|
readonly footnotes: Word.NoteItemCollection;
|
|
84707
84734
|
/**
|
|
84708
|
-
* Gets the collection of InlinePicture objects in the content control. The collection
|
|
84735
|
+
* Gets the collection of InlinePicture objects in the content control. The collection doesn't include floating images.
|
|
84709
84736
|
*
|
|
84710
84737
|
* @remarks
|
|
84711
84738
|
* [Api set: WordApi 1.1]
|
|
@@ -84719,10 +84746,12 @@ declare namespace Word {
|
|
|
84719
84746
|
*/
|
|
84720
84747
|
readonly lists: Word.ListCollection;
|
|
84721
84748
|
/**
|
|
84722
|
-
* Gets the collection of paragraph objects in the content control.
|
|
84749
|
+
* Gets the collection of paragraph objects in the content control.
|
|
84723
84750
|
*
|
|
84724
84751
|
* @remarks
|
|
84725
84752
|
* [Api set: WordApi 1.1]
|
|
84753
|
+
*
|
|
84754
|
+
* Important: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this content control aren't returned. From requirement set 1.3, paragraphs in such tables are also returned.
|
|
84726
84755
|
*/
|
|
84727
84756
|
readonly paragraphs: Word.ParagraphCollection;
|
|
84728
84757
|
/**
|
|
@@ -84747,28 +84776,28 @@ declare namespace Word {
|
|
|
84747
84776
|
*/
|
|
84748
84777
|
readonly parentContentControlOrNullObject: Word.ContentControl;
|
|
84749
84778
|
/**
|
|
84750
|
-
* Gets the table that contains the content control. Throws an `ItemNotFound` error if it
|
|
84779
|
+
* Gets the table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table.
|
|
84751
84780
|
*
|
|
84752
84781
|
* @remarks
|
|
84753
84782
|
* [Api set: WordApi 1.3]
|
|
84754
84783
|
*/
|
|
84755
84784
|
readonly parentTable: Word.Table;
|
|
84756
84785
|
/**
|
|
84757
|
-
* Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it
|
|
84786
|
+
* Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell.
|
|
84758
84787
|
*
|
|
84759
84788
|
* @remarks
|
|
84760
84789
|
* [Api set: WordApi 1.3]
|
|
84761
84790
|
*/
|
|
84762
84791
|
readonly parentTableCell: Word.TableCell;
|
|
84763
84792
|
/**
|
|
84764
|
-
* Gets the table cell that contains the content control. If it
|
|
84793
|
+
* Gets the table cell that contains the content control. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
84765
84794
|
*
|
|
84766
84795
|
* @remarks
|
|
84767
84796
|
* [Api set: WordApi 1.3]
|
|
84768
84797
|
*/
|
|
84769
84798
|
readonly parentTableCellOrNullObject: Word.TableCell;
|
|
84770
84799
|
/**
|
|
84771
|
-
* Gets the table that contains the content control. If it
|
|
84800
|
+
* Gets the table that contains the content control. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
84772
84801
|
*
|
|
84773
84802
|
* @remarks
|
|
84774
84803
|
* [Api set: WordApi 1.3]
|
|
@@ -84817,7 +84846,9 @@ declare namespace Word {
|
|
|
84817
84846
|
*/
|
|
84818
84847
|
readonly id: number;
|
|
84819
84848
|
/**
|
|
84820
|
-
* Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty.
|
|
84849
|
+
* Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty.
|
|
84850
|
+
|
|
84851
|
+
Note: The set operation for this property isn't supported in Word on the web.
|
|
84821
84852
|
*
|
|
84822
84853
|
* @remarks
|
|
84823
84854
|
* [Api set: WordApi 1.1]
|
|
@@ -84895,12 +84926,12 @@ declare namespace Word {
|
|
|
84895
84926
|
*/
|
|
84896
84927
|
clear(): void;
|
|
84897
84928
|
/**
|
|
84898
|
-
* Deletes the content control and its content. If keepContent is set to true, the content
|
|
84929
|
+
* Deletes the content control and its content. If `keepContent` is set to true, the content isn't deleted.
|
|
84899
84930
|
*
|
|
84900
84931
|
* @remarks
|
|
84901
84932
|
* [Api set: WordApi 1.1]
|
|
84902
84933
|
*
|
|
84903
|
-
* @param keepContent Required. Indicates whether the content should be deleted with the content control. If keepContent is set to true, the content
|
|
84934
|
+
* @param keepContent Required. Indicates whether the content should be deleted with the content control. If `keepContent` is set to true, the content isn't deleted.
|
|
84904
84935
|
*/
|
|
84905
84936
|
delete(keepContent: boolean): void;
|
|
84906
84937
|
/**
|
|
@@ -84911,18 +84942,20 @@ declare namespace Word {
|
|
|
84911
84942
|
*/
|
|
84912
84943
|
getComments(): Word.CommentCollection;
|
|
84913
84944
|
/**
|
|
84914
|
-
* Gets the currently supported child content controls in this content control.
|
|
84915
|
-
Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type.
|
|
84916
|
-
With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
|
|
84945
|
+
* Gets the currently supported child content controls in this content control.
|
|
84917
84946
|
*
|
|
84918
84947
|
* @remarks
|
|
84919
84948
|
* [Api set: WordApi 1.5]
|
|
84920
84949
|
*
|
|
84950
|
+
* Important: If specific types are provided in the options parameter, only content controls of supported types are returned.
|
|
84951
|
+
* Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type.
|
|
84952
|
+
* With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
|
|
84953
|
+
*
|
|
84921
84954
|
* @param options Optional. Options that define which content controls are returned.
|
|
84922
84955
|
*/
|
|
84923
84956
|
getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;
|
|
84924
84957
|
/**
|
|
84925
|
-
* 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
|
|
84958
|
+
* 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 doesn't 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.
|
|
84926
84959
|
*
|
|
84927
84960
|
* @remarks
|
|
84928
84961
|
* [Api set: WordApi 1.1]
|
|
@@ -84972,6 +85005,13 @@ declare namespace Word {
|
|
|
84972
85005
|
* @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection.
|
|
84973
85006
|
*/
|
|
84974
85007
|
getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection;
|
|
85008
|
+
/**
|
|
85009
|
+
* Gets the collection of the TrackedChange objects in the content control.
|
|
85010
|
+
*
|
|
85011
|
+
* @remarks
|
|
85012
|
+
* [Api set: WordApi 1.6]
|
|
85013
|
+
*/
|
|
85014
|
+
getTrackedChanges(): Word.TrackedChangeCollection;
|
|
84975
85015
|
/**
|
|
84976
85016
|
* Inserts a break at the specified location in the main document. This method cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls.
|
|
84977
85017
|
*
|
|
@@ -85437,7 +85477,7 @@ declare namespace Word {
|
|
|
85437
85477
|
*/
|
|
85438
85478
|
getCount(): OfficeExtension.ClientResult<number>;
|
|
85439
85479
|
/**
|
|
85440
|
-
* Gets a custom property object by its key, which is case-insensitive. Throws an `ItemNotFound` error if the custom property
|
|
85480
|
+
* Gets a custom property object by its key, which is case-insensitive. Throws an `ItemNotFound` error if the custom property doesn't exist.
|
|
85441
85481
|
*
|
|
85442
85482
|
* @remarks
|
|
85443
85483
|
* [Api set: WordApi 1.3]
|
|
@@ -85446,7 +85486,7 @@ declare namespace Word {
|
|
|
85446
85486
|
*/
|
|
85447
85487
|
getItem(key: string): Word.CustomProperty;
|
|
85448
85488
|
/**
|
|
85449
|
-
* Gets a custom property object by its key, which is case-insensitive. If the custom property
|
|
85489
|
+
* Gets a custom property object by its key, which is case-insensitive. If the custom property doesn't exist, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
85450
85490
|
*
|
|
85451
85491
|
* @remarks
|
|
85452
85492
|
* [Api set: WordApi 1.3]
|
|
@@ -85538,7 +85578,7 @@ declare namespace Word {
|
|
|
85538
85578
|
* "http:\/\/calendartypes.org\/xsds\/GregorianCalendar" in the namespaceMappings parameter.
|
|
85539
85579
|
*
|
|
85540
85580
|
* @param xpath Required. Absolute path to the single element in XPath notation.
|
|
85541
|
-
* @param namespaceMappings Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that
|
|
85581
|
+
* @param namespaceMappings Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/".
|
|
85542
85582
|
* @param name Required. Name of the attribute.
|
|
85543
85583
|
*/
|
|
85544
85584
|
deleteAttribute(xpath: string, namespaceMappings: {
|
|
@@ -85566,7 +85606,7 @@ declare namespace Word {
|
|
|
85566
85606
|
* "http:\/\/calendartypes.org\/xsds\/GregorianCalendar" in the namespaceMappings parameter.
|
|
85567
85607
|
*
|
|
85568
85608
|
* @param xpath Required. Absolute path to the single element in XPath notation.
|
|
85569
|
-
* @param namespaceMappings Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that
|
|
85609
|
+
* @param namespaceMappings Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/".
|
|
85570
85610
|
*/
|
|
85571
85611
|
deleteElement(xpath: string, namespaceMappings: {
|
|
85572
85612
|
[key: string]: string;
|
|
@@ -85600,7 +85640,7 @@ declare namespace Word {
|
|
|
85600
85640
|
* "http:\/\/calendartypes.org\/xsds\/GregorianCalendar" in the namespaceMappings parameter.
|
|
85601
85641
|
*
|
|
85602
85642
|
* @param xpath Required. Absolute path to the single element in XPath notation.
|
|
85603
|
-
* @param namespaceMappings Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that
|
|
85643
|
+
* @param namespaceMappings Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/".
|
|
85604
85644
|
* @param name Required. Name of the attribute.
|
|
85605
85645
|
* @param value Required. Value of the attribute.
|
|
85606
85646
|
*/
|
|
@@ -85630,7 +85670,7 @@ declare namespace Word {
|
|
|
85630
85670
|
*
|
|
85631
85671
|
* @param xpath Required. Absolute path to the single parent element in XPath notation.
|
|
85632
85672
|
* @param xml Required. XML content to be inserted.
|
|
85633
|
-
* @param namespaceMappings Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that
|
|
85673
|
+
* @param namespaceMappings Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/".
|
|
85634
85674
|
* @param index Optional. Zero-based position at which the new XML to be inserted. If omitted, the XML will be appended as the last child of this parent.
|
|
85635
85675
|
*/
|
|
85636
85676
|
insertElement(xpath: string, xml: string, namespaceMappings: {
|
|
@@ -85658,7 +85698,7 @@ declare namespace Word {
|
|
|
85658
85698
|
* "http:\/\/calendartypes.org\/xsds\/GregorianCalendar" in the namespaceMappings parameter.
|
|
85659
85699
|
*
|
|
85660
85700
|
* @param xpath Required. An XPath query.
|
|
85661
|
-
* @param namespaceMappings Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that
|
|
85701
|
+
* @param namespaceMappings Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/".
|
|
85662
85702
|
* @returns An array where each item represents an entry matched by the XPath query.
|
|
85663
85703
|
*/
|
|
85664
85704
|
query(xpath: string, namespaceMappings: {
|
|
@@ -85695,7 +85735,7 @@ declare namespace Word {
|
|
|
85695
85735
|
* "http:\/\/calendartypes.org\/xsds\/GregorianCalendar" in the namespaceMappings parameter.
|
|
85696
85736
|
*
|
|
85697
85737
|
* @param xpath Required. Absolute path to the single element in XPath notation.
|
|
85698
|
-
* @param namespaceMappings Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that
|
|
85738
|
+
* @param namespaceMappings Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/".
|
|
85699
85739
|
* @param name Required. Name of the attribute.
|
|
85700
85740
|
* @param value Required. New value of the attribute.
|
|
85701
85741
|
*/
|
|
@@ -85725,7 +85765,7 @@ declare namespace Word {
|
|
|
85725
85765
|
*
|
|
85726
85766
|
* @param xpath Required. Absolute path to the single element in XPath notation.
|
|
85727
85767
|
* @param xml Required. New XML content to be stored.
|
|
85728
|
-
* @param namespaceMappings Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that
|
|
85768
|
+
* @param namespaceMappings Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/".
|
|
85729
85769
|
*/
|
|
85730
85770
|
updateElement(xpath: string, xml: string, namespaceMappings: {
|
|
85731
85771
|
[key: string]: string;
|
|
@@ -85811,7 +85851,7 @@ declare namespace Word {
|
|
|
85811
85851
|
*/
|
|
85812
85852
|
getItem(id: string): Word.CustomXmlPart;
|
|
85813
85853
|
/**
|
|
85814
|
-
* Gets a custom XML part based on its ID. If the CustomXmlPart
|
|
85854
|
+
* Gets a custom XML part based on its ID. If the CustomXmlPart doesn't exist, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
85815
85855
|
*
|
|
85816
85856
|
* @remarks
|
|
85817
85857
|
* [Api set: WordApi 1.4]
|
|
@@ -85879,7 +85919,7 @@ declare namespace Word {
|
|
|
85879
85919
|
*/
|
|
85880
85920
|
getItem(id: string): Word.CustomXmlPart;
|
|
85881
85921
|
/**
|
|
85882
|
-
* Gets a custom XML part based on its ID. If the CustomXmlPart
|
|
85922
|
+
* Gets a custom XML part based on its ID. If the CustomXmlPart doesn't exist in the collection, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
85883
85923
|
*
|
|
85884
85924
|
* @remarks
|
|
85885
85925
|
* [Api set: WordApi 1.4]
|
|
@@ -86027,7 +86067,7 @@ declare namespace Word {
|
|
|
86027
86067
|
*/
|
|
86028
86068
|
addStyle(name: string, type: "Character" | "List" | "Paragraph" | "Table"): Word.Style;
|
|
86029
86069
|
/**
|
|
86030
|
-
*
|
|
86070
|
+
* Closes the current document.
|
|
86031
86071
|
*
|
|
86032
86072
|
* @remarks
|
|
86033
86073
|
* [Api set: WordApi 1.5]
|
|
@@ -86036,7 +86076,7 @@ declare namespace Word {
|
|
|
86036
86076
|
*/
|
|
86037
86077
|
close(closeBehavior?: Word.CloseBehavior): void;
|
|
86038
86078
|
/**
|
|
86039
|
-
*
|
|
86079
|
+
* Closes the current document.
|
|
86040
86080
|
*
|
|
86041
86081
|
* @remarks
|
|
86042
86082
|
* [Api set: WordApi 1.5]
|
|
@@ -86054,7 +86094,7 @@ declare namespace Word {
|
|
|
86054
86094
|
*/
|
|
86055
86095
|
deleteBookmark(name: string): void;
|
|
86056
86096
|
/**
|
|
86057
|
-
* Gets a bookmark's range. Throws an `ItemNotFound` error if the bookmark
|
|
86097
|
+
* Gets a bookmark's range. Throws an `ItemNotFound` error if the bookmark doesn't exist.
|
|
86058
86098
|
*
|
|
86059
86099
|
* @remarks
|
|
86060
86100
|
* [Api set: WordApi 1.4]
|
|
@@ -86063,7 +86103,7 @@ declare namespace Word {
|
|
|
86063
86103
|
*/
|
|
86064
86104
|
getBookmarkRange(name: string): Word.Range;
|
|
86065
86105
|
/**
|
|
86066
|
-
* Gets a bookmark's range. If the bookmark
|
|
86106
|
+
* Gets a bookmark's range. If the bookmark doesn't exist, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
86067
86107
|
*
|
|
86068
86108
|
* @remarks
|
|
86069
86109
|
* [Api set: WordApi 1.4]
|
|
@@ -86072,13 +86112,15 @@ declare namespace Word {
|
|
|
86072
86112
|
*/
|
|
86073
86113
|
getBookmarkRangeOrNullObject(name: string): Word.Range;
|
|
86074
86114
|
/**
|
|
86075
|
-
* Gets the currently supported content controls in the document.
|
|
86076
|
-
Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type.
|
|
86077
|
-
With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
|
|
86115
|
+
* Gets the currently supported content controls in the document.
|
|
86078
86116
|
*
|
|
86079
86117
|
* @remarks
|
|
86080
86118
|
* [Api set: WordApi 1.5]
|
|
86081
86119
|
*
|
|
86120
|
+
* Important: If specific types are provided in the options parameter, only content controls of supported types are returned.
|
|
86121
|
+
* Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type.
|
|
86122
|
+
* With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
|
|
86123
|
+
*
|
|
86082
86124
|
* @param options Optional. Options that define which content controls are returned.
|
|
86083
86125
|
*/
|
|
86084
86126
|
getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;
|
|
@@ -86099,7 +86141,16 @@ declare namespace Word {
|
|
|
86099
86141
|
*/
|
|
86100
86142
|
getFootnoteBody(): Word.Body;
|
|
86101
86143
|
/**
|
|
86102
|
-
* Gets the
|
|
86144
|
+
* Gets the paragraph by its unique local ID. Throws an `ItemNotFound` error if the collection is empty.
|
|
86145
|
+
*
|
|
86146
|
+
* @remarks
|
|
86147
|
+
* [Api set: WordApi 1.6]
|
|
86148
|
+
*
|
|
86149
|
+
* @param id Required. Unique local ID in standard 8-4-4-4-12 GUID format without curly braces. Note that the ID differs across sessions and coauthors.
|
|
86150
|
+
*/
|
|
86151
|
+
getParagraphByUniqueLocalId(id: string): Word.Paragraph;
|
|
86152
|
+
/**
|
|
86153
|
+
* Gets the current selection of the document. Multiple selections aren't supported.
|
|
86103
86154
|
*
|
|
86104
86155
|
* @remarks
|
|
86105
86156
|
* [Api set: WordApi 1.1]
|
|
@@ -86112,6 +86163,15 @@ declare namespace Word {
|
|
|
86112
86163
|
* [Api set: WordApi 1.5]
|
|
86113
86164
|
*/
|
|
86114
86165
|
getStyles(): Word.StyleCollection;
|
|
86166
|
+
/**
|
|
86167
|
+
* Import styles from a JSON-formatted string.
|
|
86168
|
+
*
|
|
86169
|
+
* @remarks
|
|
86170
|
+
* [Api set: WordApi 1.6]
|
|
86171
|
+
*
|
|
86172
|
+
* @param stylesJson Required. A JSON-formatted string representing the styles.
|
|
86173
|
+
*/
|
|
86174
|
+
importStylesFromJson(stylesJson: string): OfficeExtension.ClientResult<string[]>;
|
|
86115
86175
|
/**
|
|
86116
86176
|
* Inserts a document into the target document at a specific location with additional properties.
|
|
86117
86177
|
Headers, footers, watermarks, and other section properties are copied by default.
|
|
@@ -86195,6 +86255,33 @@ declare namespace Word {
|
|
|
86195
86255
|
* @eventproperty
|
|
86196
86256
|
*/
|
|
86197
86257
|
readonly onContentControlAdded: OfficeExtension.EventHandlers<Word.ContentControlAddedEventArgs>;
|
|
86258
|
+
/**
|
|
86259
|
+
* Occurs when the user adds new paragraphs.
|
|
86260
|
+
*
|
|
86261
|
+
* @remarks
|
|
86262
|
+
* [Api set: WordApi 1.6]
|
|
86263
|
+
*
|
|
86264
|
+
* @eventproperty
|
|
86265
|
+
*/
|
|
86266
|
+
readonly onParagraphAdded: OfficeExtension.EventHandlers<Word.ParagraphAddedEventArgs>;
|
|
86267
|
+
/**
|
|
86268
|
+
* Occurs when the user changes paragraphs.
|
|
86269
|
+
*
|
|
86270
|
+
* @remarks
|
|
86271
|
+
* [Api set: WordApi 1.6]
|
|
86272
|
+
*
|
|
86273
|
+
* @eventproperty
|
|
86274
|
+
*/
|
|
86275
|
+
readonly onParagraphChanged: OfficeExtension.EventHandlers<Word.ParagraphChangedEventArgs>;
|
|
86276
|
+
/**
|
|
86277
|
+
* Occurs when the user deletes paragraphs.
|
|
86278
|
+
*
|
|
86279
|
+
* @remarks
|
|
86280
|
+
* [Api set: WordApi 1.6]
|
|
86281
|
+
*
|
|
86282
|
+
* @eventproperty
|
|
86283
|
+
*/
|
|
86284
|
+
readonly onParagraphDeleted: OfficeExtension.EventHandlers<Word.ParagraphDeletedEventArgs>;
|
|
86198
86285
|
/**
|
|
86199
86286
|
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're 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 need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
86200
86287
|
*/
|
|
@@ -86305,7 +86392,7 @@ declare namespace Word {
|
|
|
86305
86392
|
*/
|
|
86306
86393
|
deleteBookmark(name: string): void;
|
|
86307
86394
|
/**
|
|
86308
|
-
* Gets a bookmark's range. Throws an `ItemNotFound` error if the bookmark
|
|
86395
|
+
* Gets a bookmark's range. Throws an `ItemNotFound` error if the bookmark doesn't exist.
|
|
86309
86396
|
*
|
|
86310
86397
|
* @remarks
|
|
86311
86398
|
* [Api set: WordApiHiddenDocument 1.4]
|
|
@@ -86314,22 +86401,24 @@ declare namespace Word {
|
|
|
86314
86401
|
*/
|
|
86315
86402
|
getBookmarkRange(name: string): Word.Range;
|
|
86316
86403
|
/**
|
|
86317
|
-
* Gets a bookmark's range. If the bookmark
|
|
86404
|
+
* Gets a bookmark's range. If the bookmark doesn't exist, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
86318
86405
|
*
|
|
86319
86406
|
* @remarks
|
|
86320
86407
|
* [Api set: WordApiHiddenDocument 1.4]
|
|
86321
86408
|
*
|
|
86322
|
-
* @param name Required. The case-insensitive bookmark name.
|
|
86409
|
+
* @param name Required. The case-insensitive bookmark name. Only alphanumeric and underscore characters are supported. It must begin with a letter but if you want to tag the bookmark as hidden, then start the name with an underscore character. Names can't be longer than 40 characters.
|
|
86323
86410
|
*/
|
|
86324
86411
|
getBookmarkRangeOrNullObject(name: string): Word.Range;
|
|
86325
86412
|
/**
|
|
86326
|
-
* Gets the currently supported content controls in the document.
|
|
86327
|
-
Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type.
|
|
86328
|
-
With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
|
|
86413
|
+
* Gets the currently supported content controls in the document.
|
|
86329
86414
|
*
|
|
86330
86415
|
* @remarks
|
|
86331
86416
|
* [Api set: WordApiHiddenDocument 1.5]
|
|
86332
86417
|
*
|
|
86418
|
+
* Important: If specific types are provided in the options parameter, only content controls of supported types are returned.
|
|
86419
|
+
* Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type.
|
|
86420
|
+
* With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
|
|
86421
|
+
*
|
|
86333
86422
|
* @param options Optional. Options that define which content controls are returned.
|
|
86334
86423
|
*/
|
|
86335
86424
|
getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;
|
|
@@ -86631,14 +86720,14 @@ declare namespace Word {
|
|
|
86631
86720
|
*/
|
|
86632
86721
|
readonly parentContentControlOrNullObject: Word.ContentControl;
|
|
86633
86722
|
/**
|
|
86634
|
-
* Gets the table that contains the field. Throws an `ItemNotFound` error if it
|
|
86723
|
+
* Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table.
|
|
86635
86724
|
*
|
|
86636
86725
|
* @remarks
|
|
86637
86726
|
* [Api set: WordApi 1.4]
|
|
86638
86727
|
*/
|
|
86639
86728
|
readonly parentTable: Word.Table;
|
|
86640
86729
|
/**
|
|
86641
|
-
* Gets the table cell that contains the field. Throws an `ItemNotFound` error if it
|
|
86730
|
+
* Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell.
|
|
86642
86731
|
*
|
|
86643
86732
|
* @remarks
|
|
86644
86733
|
* [Api set: WordApi 1.4]
|
|
@@ -86939,7 +87028,7 @@ declare namespace Word {
|
|
|
86939
87028
|
*/
|
|
86940
87029
|
superscript: boolean;
|
|
86941
87030
|
/**
|
|
86942
|
-
* Specifies a value that indicates the font's underline type. 'None' if the font
|
|
87031
|
+
* Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined.
|
|
86943
87032
|
*
|
|
86944
87033
|
* @remarks
|
|
86945
87034
|
* [Api set: WordApi 1.1]
|
|
@@ -87019,14 +87108,14 @@ declare namespace Word {
|
|
|
87019
87108
|
*/
|
|
87020
87109
|
readonly parentContentControlOrNullObject: Word.ContentControl;
|
|
87021
87110
|
/**
|
|
87022
|
-
* Gets the table that contains the inline image. Throws an `ItemNotFound` error if it
|
|
87111
|
+
* Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table.
|
|
87023
87112
|
*
|
|
87024
87113
|
* @remarks
|
|
87025
87114
|
* [Api set: WordApi 1.3]
|
|
87026
87115
|
*/
|
|
87027
87116
|
readonly parentTable: Word.Table;
|
|
87028
87117
|
/**
|
|
87029
|
-
* Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it
|
|
87118
|
+
* Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table cell.
|
|
87030
87119
|
*
|
|
87031
87120
|
* @remarks
|
|
87032
87121
|
* [Api set: WordApi 1.3]
|
|
@@ -87632,7 +87721,7 @@ declare namespace Word {
|
|
|
87632
87721
|
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
87633
87722
|
set(properties: Word.ListItem): void;
|
|
87634
87723
|
/**
|
|
87635
|
-
* Gets the list item parent, or the closest ancestor if the parent
|
|
87724
|
+
* Gets the list item parent, or the closest ancestor if the parent doesn't exist. Throws an `ItemNotFound` error if the list item has no ancestor.
|
|
87636
87725
|
*
|
|
87637
87726
|
* @remarks
|
|
87638
87727
|
* [Api set: WordApi 1.3]
|
|
@@ -87641,7 +87730,7 @@ declare namespace Word {
|
|
|
87641
87730
|
*/
|
|
87642
87731
|
getAncestor(parentOnly?: boolean): Word.Paragraph;
|
|
87643
87732
|
/**
|
|
87644
|
-
* Gets the list item parent, or the closest ancestor if the parent
|
|
87733
|
+
* Gets the list item parent, or the closest ancestor if the parent doesn't exist. If the list item has no ancestor, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
87645
87734
|
*
|
|
87646
87735
|
* @remarks
|
|
87647
87736
|
* [Api set: WordApi 1.3]
|
|
@@ -87889,21 +87978,21 @@ declare namespace Word {
|
|
|
87889
87978
|
*/
|
|
87890
87979
|
readonly footnotes: Word.NoteItemCollection;
|
|
87891
87980
|
/**
|
|
87892
|
-
* Gets the collection of InlinePicture objects in the paragraph. The collection
|
|
87981
|
+
* Gets the collection of InlinePicture objects in the paragraph. The collection doesn't include floating images.
|
|
87893
87982
|
*
|
|
87894
87983
|
* @remarks
|
|
87895
87984
|
* [Api set: WordApi 1.1]
|
|
87896
87985
|
*/
|
|
87897
87986
|
readonly inlinePictures: Word.InlinePictureCollection;
|
|
87898
87987
|
/**
|
|
87899
|
-
* Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph
|
|
87988
|
+
* Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list.
|
|
87900
87989
|
*
|
|
87901
87990
|
* @remarks
|
|
87902
87991
|
* [Api set: WordApi 1.3]
|
|
87903
87992
|
*/
|
|
87904
87993
|
readonly list: Word.List;
|
|
87905
87994
|
/**
|
|
87906
|
-
* Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph
|
|
87995
|
+
* Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list.
|
|
87907
87996
|
*
|
|
87908
87997
|
* @remarks
|
|
87909
87998
|
* [Api set: WordApi 1.3]
|
|
@@ -87945,14 +88034,14 @@ declare namespace Word {
|
|
|
87945
88034
|
*/
|
|
87946
88035
|
readonly parentContentControlOrNullObject: Word.ContentControl;
|
|
87947
88036
|
/**
|
|
87948
|
-
* Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it
|
|
88037
|
+
* Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table.
|
|
87949
88038
|
*
|
|
87950
88039
|
* @remarks
|
|
87951
88040
|
* [Api set: WordApi 1.3]
|
|
87952
88041
|
*/
|
|
87953
88042
|
readonly parentTable: Word.Table;
|
|
87954
88043
|
/**
|
|
87955
|
-
* Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it
|
|
88044
|
+
* Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell.
|
|
87956
88045
|
*
|
|
87957
88046
|
* @remarks
|
|
87958
88047
|
* [Api set: WordApi 1.3]
|
|
@@ -88071,7 +88160,7 @@ declare namespace Word {
|
|
|
88071
88160
|
*/
|
|
88072
88161
|
styleBuiltIn: Word.BuiltInStyleName | "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";
|
|
88073
88162
|
/**
|
|
88074
|
-
* Gets the level of the paragraph's table. It returns 0 if the paragraph
|
|
88163
|
+
* Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table.
|
|
88075
88164
|
*
|
|
88076
88165
|
* @remarks
|
|
88077
88166
|
* [Api set: WordApi 1.3]
|
|
@@ -88084,6 +88173,13 @@ declare namespace Word {
|
|
|
88084
88173
|
* [Api set: WordApi 1.1]
|
|
88085
88174
|
*/
|
|
88086
88175
|
readonly text: string;
|
|
88176
|
+
/**
|
|
88177
|
+
* Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors.
|
|
88178
|
+
*
|
|
88179
|
+
* @remarks
|
|
88180
|
+
* [Api set: WordApi 1.6]
|
|
88181
|
+
*/
|
|
88182
|
+
readonly uniqueLocalId: string;
|
|
88087
88183
|
/**
|
|
88088
88184
|
* 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.
|
|
88089
88185
|
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
@@ -88131,18 +88227,20 @@ declare namespace Word {
|
|
|
88131
88227
|
*/
|
|
88132
88228
|
getComments(): Word.CommentCollection;
|
|
88133
88229
|
/**
|
|
88134
|
-
* Gets the currently supported content controls in the paragraph.
|
|
88135
|
-
Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type.
|
|
88136
|
-
With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
|
|
88230
|
+
* Gets the currently supported content controls in the paragraph.
|
|
88137
88231
|
*
|
|
88138
88232
|
* @remarks
|
|
88139
88233
|
* [Api set: WordApi 1.5]
|
|
88140
88234
|
*
|
|
88235
|
+
* Important: If specific types are provided in the options parameter, only content controls of supported types are returned.
|
|
88236
|
+
* Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type.
|
|
88237
|
+
* With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
|
|
88238
|
+
*
|
|
88141
88239
|
* @param options Optional. Options that define which content controls are returned.
|
|
88142
88240
|
*/
|
|
88143
88241
|
getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;
|
|
88144
88242
|
/**
|
|
88145
|
-
* 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
|
|
88243
|
+
* 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 doesn't 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.
|
|
88146
88244
|
*
|
|
88147
88245
|
* @remarks
|
|
88148
88246
|
* [Api set: WordApi 1.1]
|
|
@@ -88220,6 +88318,13 @@ declare namespace Word {
|
|
|
88220
88318
|
* @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection.
|
|
88221
88319
|
*/
|
|
88222
88320
|
getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection;
|
|
88321
|
+
/**
|
|
88322
|
+
* Gets the collection of the TrackedChange objects in the paragraph.
|
|
88323
|
+
*
|
|
88324
|
+
* @remarks
|
|
88325
|
+
* [Api set: WordApi 1.6]
|
|
88326
|
+
*/
|
|
88327
|
+
getTrackedChanges(): Word.TrackedChangeCollection;
|
|
88223
88328
|
/**
|
|
88224
88329
|
* Inserts a break at the specified location in the main document.
|
|
88225
88330
|
*
|
|
@@ -88684,10 +88789,12 @@ declare namespace Word {
|
|
|
88684
88789
|
*/
|
|
88685
88790
|
readonly lists: Word.ListCollection;
|
|
88686
88791
|
/**
|
|
88687
|
-
* Gets the collection of paragraph objects in the range.
|
|
88792
|
+
* Gets the collection of paragraph objects in the range.
|
|
88688
88793
|
*
|
|
88689
88794
|
* @remarks
|
|
88690
88795
|
* [Api set: WordApi 1.1]
|
|
88796
|
+
*
|
|
88797
|
+
* Important: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this range aren't returned. From requirement set 1.3, paragraphs in such tables are also returned.
|
|
88691
88798
|
*/
|
|
88692
88799
|
readonly paragraphs: Word.ParagraphCollection;
|
|
88693
88800
|
/**
|
|
@@ -88712,14 +88819,14 @@ declare namespace Word {
|
|
|
88712
88819
|
*/
|
|
88713
88820
|
readonly parentContentControlOrNullObject: Word.ContentControl;
|
|
88714
88821
|
/**
|
|
88715
|
-
* Gets the table that contains the range. Throws an `ItemNotFound` error if it
|
|
88822
|
+
* Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table.
|
|
88716
88823
|
*
|
|
88717
88824
|
* @remarks
|
|
88718
88825
|
* [Api set: WordApi 1.3]
|
|
88719
88826
|
*/
|
|
88720
88827
|
readonly parentTable: Word.Table;
|
|
88721
88828
|
/**
|
|
88722
|
-
* Gets the table cell that contains the range. Throws an `ItemNotFound` error if it
|
|
88829
|
+
* Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell.
|
|
88723
88830
|
*
|
|
88724
88831
|
* @remarks
|
|
88725
88832
|
* [Api set: WordApi 1.3]
|
|
@@ -88813,7 +88920,7 @@ declare namespace Word {
|
|
|
88813
88920
|
*/
|
|
88814
88921
|
delete(): void;
|
|
88815
88922
|
/**
|
|
88816
|
-
* Returns a new range that extends from this range in either direction to cover another range. This range
|
|
88923
|
+
* Returns a new range that extends from this range in either direction to cover another range. This range isn't changed. Throws an `ItemNotFound` error if the two ranges do not have a union.
|
|
88817
88924
|
*
|
|
88818
88925
|
* @remarks
|
|
88819
88926
|
* [Api set: WordApi 1.3]
|
|
@@ -88849,18 +88956,20 @@ declare namespace Word {
|
|
|
88849
88956
|
*/
|
|
88850
88957
|
getComments(): Word.CommentCollection;
|
|
88851
88958
|
/**
|
|
88852
|
-
* Gets the currently supported content controls in the range.
|
|
88853
|
-
Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type.
|
|
88854
|
-
With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
|
|
88959
|
+
* Gets the currently supported content controls in the range.
|
|
88855
88960
|
*
|
|
88856
88961
|
* @remarks
|
|
88857
88962
|
* [Api set: WordApi 1.5]
|
|
88858
88963
|
*
|
|
88964
|
+
* **Important**: If specific types are provided in the options parameter, only content controls of supported types are returned.
|
|
88965
|
+
* Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type.
|
|
88966
|
+
* With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
|
|
88967
|
+
*
|
|
88859
88968
|
* @param options Optional. Options that define which content controls are returned.
|
|
88860
88969
|
*/
|
|
88861
88970
|
getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;
|
|
88862
88971
|
/**
|
|
88863
|
-
* 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
|
|
88972
|
+
* 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 doesn't 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.
|
|
88864
88973
|
*
|
|
88865
88974
|
* @remarks
|
|
88866
88975
|
* [Api set: WordApi 1.1]
|
|
@@ -88937,6 +89046,13 @@ declare namespace Word {
|
|
|
88937
89046
|
* @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection.
|
|
88938
89047
|
*/
|
|
88939
89048
|
getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection;
|
|
89049
|
+
/**
|
|
89050
|
+
* Gets the collection of the TrackedChange objects in the range.
|
|
89051
|
+
*
|
|
89052
|
+
* @remarks
|
|
89053
|
+
* [Api set: WordApi 1.6]
|
|
89054
|
+
*/
|
|
89055
|
+
getTrackedChanges(): Word.TrackedChangeCollection;
|
|
88940
89056
|
/**
|
|
88941
89057
|
* Inserts a bookmark on the range. If a bookmark of the same name exists somewhere, it is deleted first.
|
|
88942
89058
|
*
|
|
@@ -89124,7 +89240,7 @@ declare namespace Word {
|
|
|
89124
89240
|
*/
|
|
89125
89241
|
insertText(text: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;
|
|
89126
89242
|
/**
|
|
89127
|
-
* Returns a new range as the intersection of this range with another range. This range
|
|
89243
|
+
* Returns a new range as the intersection of this range with another range. This range isn't changed. Throws an `ItemNotFound` error if the two ranges aren't overlapped or adjacent.
|
|
89128
89244
|
*
|
|
89129
89245
|
* @remarks
|
|
89130
89246
|
* [Api set: WordApi 1.3]
|
|
@@ -89295,6 +89411,20 @@ declare namespace Word {
|
|
|
89295
89411
|
* [Api set: WordApi 1.5]
|
|
89296
89412
|
*/
|
|
89297
89413
|
importChangeTrackingMode?: boolean;
|
|
89414
|
+
/**
|
|
89415
|
+
* Represents whether the custom properties from the source document should be imported. Overwrites existing properties with the same name.
|
|
89416
|
+
*
|
|
89417
|
+
* @remarks
|
|
89418
|
+
* [Api set: WordApi 1.6]
|
|
89419
|
+
*/
|
|
89420
|
+
importCustomProperties?: boolean;
|
|
89421
|
+
/**
|
|
89422
|
+
* Represents whether the custom XML parts from the source document should be imported.
|
|
89423
|
+
*
|
|
89424
|
+
* @remarks
|
|
89425
|
+
* [Api set: WordApi 1.6]
|
|
89426
|
+
*/
|
|
89427
|
+
importCustomXmlParts?: boolean;
|
|
89298
89428
|
/**
|
|
89299
89429
|
* Represents whether the page color and other background information from the source document should be imported.
|
|
89300
89430
|
*
|
|
@@ -89432,7 +89562,7 @@ declare namespace Word {
|
|
|
89432
89562
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
89433
89563
|
context: RequestContext;
|
|
89434
89564
|
/**
|
|
89435
|
-
* Gets the body object of the section. This
|
|
89565
|
+
* Gets the body object of the section. This doesn't include the header/footer and other section metadata.
|
|
89436
89566
|
*
|
|
89437
89567
|
* @remarks
|
|
89438
89568
|
* [Api set: WordApi 1.1]
|
|
@@ -89697,7 +89827,7 @@ declare namespace Word {
|
|
|
89697
89827
|
*/
|
|
89698
89828
|
getCount(): OfficeExtension.ClientResult<number>;
|
|
89699
89829
|
/**
|
|
89700
|
-
* Gets a setting object by its key, which is case-sensitive. Throws an `ItemNotFound` error if the setting
|
|
89830
|
+
* Gets a setting object by its key, which is case-sensitive. Throws an `ItemNotFound` error if the setting doesn't exist.
|
|
89701
89831
|
*
|
|
89702
89832
|
* @remarks
|
|
89703
89833
|
* [Api set: WordApi 1.4]
|
|
@@ -89847,12 +89977,28 @@ declare namespace Word {
|
|
|
89847
89977
|
*/
|
|
89848
89978
|
readonly paragraphFormat: Word.ParagraphFormat;
|
|
89849
89979
|
/**
|
|
89850
|
-
* Gets
|
|
89980
|
+
* Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
|
|
89981
|
+
*
|
|
89982
|
+
* @remarks
|
|
89983
|
+
* [Api set: WordApi 1.6]
|
|
89984
|
+
*/
|
|
89985
|
+
readonly shading: Word.Shading;
|
|
89986
|
+
/**
|
|
89987
|
+
* Gets a TableStyle object representing Style properties that can be applied to a table.
|
|
89988
|
+
*
|
|
89989
|
+
* @remarks
|
|
89990
|
+
* [Api set: WordApi 1.6]
|
|
89991
|
+
*/
|
|
89992
|
+
readonly tableStyle: Word.TableStyle;
|
|
89993
|
+
/**
|
|
89994
|
+
* Specifies the name of an existing style to use as the base formatting of another style.
|
|
89851
89995
|
*
|
|
89852
89996
|
* @remarks
|
|
89853
89997
|
* [Api set: WordApi 1.5]
|
|
89998
|
+
*
|
|
89999
|
+
* Note: The ability to set `baseStyle` was introduced in WordApi 1.6.
|
|
89854
90000
|
*/
|
|
89855
|
-
|
|
90001
|
+
baseStyle: string;
|
|
89856
90002
|
/**
|
|
89857
90003
|
* Gets whether the specified style is a built-in style.
|
|
89858
90004
|
*
|
|
@@ -89882,12 +90028,14 @@ declare namespace Word {
|
|
|
89882
90028
|
*/
|
|
89883
90029
|
readonly nameLocal: string;
|
|
89884
90030
|
/**
|
|
89885
|
-
*
|
|
90031
|
+
* Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style.
|
|
89886
90032
|
*
|
|
89887
90033
|
* @remarks
|
|
89888
90034
|
* [Api set: WordApi 1.5]
|
|
90035
|
+
*
|
|
90036
|
+
* Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6.
|
|
89889
90037
|
*/
|
|
89890
|
-
|
|
90038
|
+
nextParagraphStyle: string;
|
|
89891
90039
|
/**
|
|
89892
90040
|
* Specifies the priority.
|
|
89893
90041
|
*
|
|
@@ -89973,6 +90121,65 @@ declare namespace Word {
|
|
|
89973
90121
|
*/
|
|
89974
90122
|
toJSON(): Word.Interfaces.StyleData;
|
|
89975
90123
|
}
|
|
90124
|
+
/**
|
|
90125
|
+
* Represents the shading object.
|
|
90126
|
+
*
|
|
90127
|
+
* @remarks
|
|
90128
|
+
* [Api set: WordApi 1.6]
|
|
90129
|
+
*/
|
|
90130
|
+
class Shading extends OfficeExtension.ClientObject {
|
|
90131
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
90132
|
+
context: RequestContext;
|
|
90133
|
+
/**
|
|
90134
|
+
* Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name.
|
|
90135
|
+
*
|
|
90136
|
+
* @remarks
|
|
90137
|
+
* [Api set: WordApi 1.6]
|
|
90138
|
+
*/
|
|
90139
|
+
backgroundPatternColor: string;
|
|
90140
|
+
/**
|
|
90141
|
+
* 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.
|
|
90142
|
+
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
90143
|
+
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
90144
|
+
*/
|
|
90145
|
+
set(properties: Interfaces.ShadingUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
90146
|
+
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
90147
|
+
set(properties: Word.Shading): void;
|
|
90148
|
+
/**
|
|
90149
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
90150
|
+
*
|
|
90151
|
+
* @param options Provides options for which properties of the object to load.
|
|
90152
|
+
*/
|
|
90153
|
+
load(options?: Word.Interfaces.ShadingLoadOptions): Word.Shading;
|
|
90154
|
+
/**
|
|
90155
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
90156
|
+
*
|
|
90157
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
90158
|
+
*/
|
|
90159
|
+
load(propertyNames?: string | string[]): Word.Shading;
|
|
90160
|
+
/**
|
|
90161
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
90162
|
+
*
|
|
90163
|
+
* @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.
|
|
90164
|
+
*/
|
|
90165
|
+
load(propertyNamesAndPaths?: {
|
|
90166
|
+
select?: string;
|
|
90167
|
+
expand?: string;
|
|
90168
|
+
}): Word.Shading;
|
|
90169
|
+
/**
|
|
90170
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're 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 need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
90171
|
+
*/
|
|
90172
|
+
track(): Word.Shading;
|
|
90173
|
+
/**
|
|
90174
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.
|
|
90175
|
+
*/
|
|
90176
|
+
untrack(): Word.Shading;
|
|
90177
|
+
/**
|
|
90178
|
+
* 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.)
|
|
90179
|
+
* Whereas the original Word.Shading object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShadingData`) that contains shallow copies of any loaded child properties from the original object.
|
|
90180
|
+
*/
|
|
90181
|
+
toJSON(): Word.Interfaces.ShadingData;
|
|
90182
|
+
}
|
|
89976
90183
|
/**
|
|
89977
90184
|
* Represents a table in a Word document.
|
|
89978
90185
|
*
|
|
@@ -90032,14 +90239,14 @@ declare namespace Word {
|
|
|
90032
90239
|
*/
|
|
90033
90240
|
readonly parentContentControlOrNullObject: Word.ContentControl;
|
|
90034
90241
|
/**
|
|
90035
|
-
* Gets the table that contains this table. Throws an `ItemNotFound` error if it
|
|
90242
|
+
* Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table.
|
|
90036
90243
|
*
|
|
90037
90244
|
* @remarks
|
|
90038
90245
|
* [Api set: WordApi 1.3]
|
|
90039
90246
|
*/
|
|
90040
90247
|
readonly parentTable: Word.Table;
|
|
90041
90248
|
/**
|
|
90042
|
-
* Gets the table cell that contains this table. Throws an `ItemNotFound` error if it
|
|
90249
|
+
* Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell.
|
|
90043
90250
|
*
|
|
90044
90251
|
* @remarks
|
|
90045
90252
|
* [Api set: WordApi 1.3]
|
|
@@ -90289,7 +90496,7 @@ declare namespace Word {
|
|
|
90289
90496
|
*/
|
|
90290
90497
|
getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder;
|
|
90291
90498
|
/**
|
|
90292
|
-
* Gets the table cell at a specified row and column. Throws an `ItemNotFound` error if the specified table cell
|
|
90499
|
+
* Gets the table cell at a specified row and column. Throws an `ItemNotFound` error if the specified table cell doesn't exist.
|
|
90293
90500
|
*
|
|
90294
90501
|
* @remarks
|
|
90295
90502
|
* [Api set: WordApi 1.3]
|
|
@@ -90509,6 +90716,93 @@ declare namespace Word {
|
|
|
90509
90716
|
*/
|
|
90510
90717
|
toJSON(): Word.Interfaces.TableData;
|
|
90511
90718
|
}
|
|
90719
|
+
/**
|
|
90720
|
+
* Represents the TableStyle object.
|
|
90721
|
+
*
|
|
90722
|
+
* @remarks
|
|
90723
|
+
* [Api set: WordApi 1.6]
|
|
90724
|
+
*/
|
|
90725
|
+
class TableStyle extends OfficeExtension.ClientObject {
|
|
90726
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
90727
|
+
context: RequestContext;
|
|
90728
|
+
/**
|
|
90729
|
+
* Specifies the amount of space to add between the contents and the bottom borders of the cells.
|
|
90730
|
+
*
|
|
90731
|
+
* @remarks
|
|
90732
|
+
* [Api set: WordApi 1.6]
|
|
90733
|
+
*/
|
|
90734
|
+
bottomCellMargin: number;
|
|
90735
|
+
/**
|
|
90736
|
+
* Specifies the spacing (in points) between the cells in a table style.
|
|
90737
|
+
*
|
|
90738
|
+
* @remarks
|
|
90739
|
+
* [Api set: WordApi 1.6]
|
|
90740
|
+
*/
|
|
90741
|
+
cellSpacing: number;
|
|
90742
|
+
/**
|
|
90743
|
+
* Specifies the amount of space to add between the contents and the left borders of the cells.
|
|
90744
|
+
*
|
|
90745
|
+
* @remarks
|
|
90746
|
+
* [Api set: WordApi 1.6]
|
|
90747
|
+
*/
|
|
90748
|
+
leftCellMargin: number;
|
|
90749
|
+
/**
|
|
90750
|
+
* Specifies the amount of space to add between the contents and the right borders of the cells.
|
|
90751
|
+
*
|
|
90752
|
+
* @remarks
|
|
90753
|
+
* [Api set: WordApi 1.6]
|
|
90754
|
+
*/
|
|
90755
|
+
rightCellMargin: number;
|
|
90756
|
+
/**
|
|
90757
|
+
* Specifies the amount of space to add between the contents and the top borders of the cells.
|
|
90758
|
+
*
|
|
90759
|
+
* @remarks
|
|
90760
|
+
* [Api set: WordApi 1.6]
|
|
90761
|
+
*/
|
|
90762
|
+
topCellMargin: number;
|
|
90763
|
+
/**
|
|
90764
|
+
* 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.
|
|
90765
|
+
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
90766
|
+
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
90767
|
+
*/
|
|
90768
|
+
set(properties: Interfaces.TableStyleUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
90769
|
+
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
90770
|
+
set(properties: Word.TableStyle): void;
|
|
90771
|
+
/**
|
|
90772
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
90773
|
+
*
|
|
90774
|
+
* @param options Provides options for which properties of the object to load.
|
|
90775
|
+
*/
|
|
90776
|
+
load(options?: Word.Interfaces.TableStyleLoadOptions): Word.TableStyle;
|
|
90777
|
+
/**
|
|
90778
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
90779
|
+
*
|
|
90780
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
90781
|
+
*/
|
|
90782
|
+
load(propertyNames?: string | string[]): Word.TableStyle;
|
|
90783
|
+
/**
|
|
90784
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
90785
|
+
*
|
|
90786
|
+
* @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.
|
|
90787
|
+
*/
|
|
90788
|
+
load(propertyNamesAndPaths?: {
|
|
90789
|
+
select?: string;
|
|
90790
|
+
expand?: string;
|
|
90791
|
+
}): Word.TableStyle;
|
|
90792
|
+
/**
|
|
90793
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're 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 need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
90794
|
+
*/
|
|
90795
|
+
track(): Word.TableStyle;
|
|
90796
|
+
/**
|
|
90797
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.
|
|
90798
|
+
*/
|
|
90799
|
+
untrack(): Word.TableStyle;
|
|
90800
|
+
/**
|
|
90801
|
+
* 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.)
|
|
90802
|
+
* Whereas the original Word.TableStyle object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableStyleData`) that contains shallow copies of any loaded child properties from the original object.
|
|
90803
|
+
*/
|
|
90804
|
+
toJSON(): Word.Interfaces.TableStyleData;
|
|
90805
|
+
}
|
|
90512
90806
|
/**
|
|
90513
90807
|
* Contains the collection of the document's Table objects.
|
|
90514
90808
|
*
|
|
@@ -91287,88 +91581,298 @@ declare namespace Word {
|
|
|
91287
91581
|
toJSON(): Word.Interfaces.TableBorderData;
|
|
91288
91582
|
}
|
|
91289
91583
|
/**
|
|
91290
|
-
*
|
|
91584
|
+
* Represents a tracked change in a Word document.
|
|
91291
91585
|
*
|
|
91292
91586
|
* @remarks
|
|
91293
|
-
* [Api set: WordApi 1.
|
|
91587
|
+
* [Api set: WordApi 1.6]
|
|
91294
91588
|
*/
|
|
91295
|
-
|
|
91589
|
+
class TrackedChange extends OfficeExtension.ClientObject {
|
|
91590
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
91591
|
+
context: RequestContext;
|
|
91296
91592
|
/**
|
|
91297
|
-
*
|
|
91593
|
+
* Gets the author of the tracked change.
|
|
91594
|
+
*
|
|
91298
91595
|
* @remarks
|
|
91299
|
-
* [Api set: WordApi 1.
|
|
91596
|
+
* [Api set: WordApi 1.6]
|
|
91300
91597
|
*/
|
|
91301
|
-
|
|
91598
|
+
readonly author: string;
|
|
91302
91599
|
/**
|
|
91303
|
-
*
|
|
91600
|
+
* Gets the date of the tracked change.
|
|
91601
|
+
*
|
|
91304
91602
|
* @remarks
|
|
91305
|
-
* [Api set: WordApi 1.
|
|
91603
|
+
* [Api set: WordApi 1.6]
|
|
91306
91604
|
*/
|
|
91307
|
-
|
|
91605
|
+
readonly date: Date;
|
|
91308
91606
|
/**
|
|
91309
|
-
*
|
|
91607
|
+
* Gets the text of the tracked change.
|
|
91608
|
+
*
|
|
91310
91609
|
* @remarks
|
|
91311
|
-
* [Api set: WordApi 1.
|
|
91610
|
+
* [Api set: WordApi 1.6]
|
|
91312
91611
|
*/
|
|
91313
|
-
|
|
91314
|
-
}
|
|
91315
|
-
/**
|
|
91316
|
-
* Specify the current version or the original version of the text.
|
|
91317
|
-
*
|
|
91318
|
-
* @remarks
|
|
91319
|
-
* [Api set: WordApi 1.4]
|
|
91320
|
-
*/
|
|
91321
|
-
enum ChangeTrackingVersion {
|
|
91612
|
+
readonly text: string;
|
|
91322
91613
|
/**
|
|
91614
|
+
* Gets the type of the tracked change.
|
|
91615
|
+
*
|
|
91323
91616
|
* @remarks
|
|
91324
|
-
* [Api set: WordApi 1.
|
|
91617
|
+
* [Api set: WordApi 1.6]
|
|
91325
91618
|
*/
|
|
91326
|
-
|
|
91619
|
+
readonly type: Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted";
|
|
91327
91620
|
/**
|
|
91621
|
+
* Accepts the tracked change.
|
|
91622
|
+
*
|
|
91328
91623
|
* @remarks
|
|
91329
|
-
* [Api set: WordApi 1.
|
|
91624
|
+
* [Api set: WordApi 1.6]
|
|
91330
91625
|
*/
|
|
91331
|
-
|
|
91332
|
-
}
|
|
91333
|
-
/**
|
|
91334
|
-
* Specify the track state when ChangeTracking is on.
|
|
91335
|
-
*
|
|
91336
|
-
* @remarks
|
|
91337
|
-
* [Api set: WordApi 1.5]
|
|
91338
|
-
*/
|
|
91339
|
-
enum ChangeTrackingState {
|
|
91626
|
+
accept(): void;
|
|
91340
91627
|
/**
|
|
91628
|
+
* Gets the next tracked change. Throws an `ItemNotFound` error if this tracked change is the last one.
|
|
91629
|
+
*
|
|
91341
91630
|
* @remarks
|
|
91342
|
-
* [Api set: WordApi 1.
|
|
91631
|
+
* [Api set: WordApi 1.6]
|
|
91343
91632
|
*/
|
|
91344
|
-
|
|
91633
|
+
getNext(): Word.TrackedChange;
|
|
91345
91634
|
/**
|
|
91635
|
+
* Gets the next tracked change. If this tracked change is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
91636
|
+
*
|
|
91346
91637
|
* @remarks
|
|
91347
|
-
* [Api set: WordApi 1.
|
|
91638
|
+
* [Api set: WordApi 1.6]
|
|
91348
91639
|
*/
|
|
91349
|
-
|
|
91640
|
+
getNextOrNullObject(): Word.TrackedChange;
|
|
91350
91641
|
/**
|
|
91642
|
+
* Gets the range of the tracked change.
|
|
91643
|
+
*
|
|
91351
91644
|
* @remarks
|
|
91352
|
-
* [Api set: WordApi 1.
|
|
91645
|
+
* [Api set: WordApi 1.6]
|
|
91353
91646
|
*/
|
|
91354
|
-
|
|
91647
|
+
getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range;
|
|
91355
91648
|
/**
|
|
91649
|
+
* Rejects the tracked change.
|
|
91650
|
+
*
|
|
91356
91651
|
* @remarks
|
|
91357
|
-
* [Api set: WordApi 1.
|
|
91652
|
+
* [Api set: WordApi 1.6]
|
|
91358
91653
|
*/
|
|
91359
|
-
|
|
91360
|
-
}
|
|
91361
|
-
/**
|
|
91362
|
-
* Note item type
|
|
91363
|
-
*
|
|
91364
|
-
* @remarks
|
|
91365
|
-
* [Api set: WordApi 1.5]
|
|
91366
|
-
*/
|
|
91367
|
-
enum NoteItemType {
|
|
91654
|
+
reject(): void;
|
|
91368
91655
|
/**
|
|
91369
|
-
*
|
|
91370
|
-
*
|
|
91371
|
-
|
|
91656
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
91657
|
+
*
|
|
91658
|
+
* @param options Provides options for which properties of the object to load.
|
|
91659
|
+
*/
|
|
91660
|
+
load(options?: Word.Interfaces.TrackedChangeLoadOptions): Word.TrackedChange;
|
|
91661
|
+
/**
|
|
91662
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
91663
|
+
*
|
|
91664
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
91665
|
+
*/
|
|
91666
|
+
load(propertyNames?: string | string[]): Word.TrackedChange;
|
|
91667
|
+
/**
|
|
91668
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
91669
|
+
*
|
|
91670
|
+
* @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.
|
|
91671
|
+
*/
|
|
91672
|
+
load(propertyNamesAndPaths?: {
|
|
91673
|
+
select?: string;
|
|
91674
|
+
expand?: string;
|
|
91675
|
+
}): Word.TrackedChange;
|
|
91676
|
+
/**
|
|
91677
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're 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 need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
91678
|
+
*/
|
|
91679
|
+
track(): Word.TrackedChange;
|
|
91680
|
+
/**
|
|
91681
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.
|
|
91682
|
+
*/
|
|
91683
|
+
untrack(): Word.TrackedChange;
|
|
91684
|
+
/**
|
|
91685
|
+
* 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.)
|
|
91686
|
+
* Whereas the original Word.TrackedChange object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TrackedChangeData`) that contains shallow copies of any loaded child properties from the original object.
|
|
91687
|
+
*/
|
|
91688
|
+
toJSON(): Word.Interfaces.TrackedChangeData;
|
|
91689
|
+
}
|
|
91690
|
+
/**
|
|
91691
|
+
* Contains a collection of {@link Word.TrackedChange} objects.
|
|
91692
|
+
*
|
|
91693
|
+
* @remarks
|
|
91694
|
+
* [Api set: WordApi 1.6]
|
|
91695
|
+
*/
|
|
91696
|
+
class TrackedChangeCollection extends OfficeExtension.ClientObject {
|
|
91697
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
91698
|
+
context: RequestContext;
|
|
91699
|
+
/** Gets the loaded child items in this collection. */
|
|
91700
|
+
readonly items: Word.TrackedChange[];
|
|
91701
|
+
/**
|
|
91702
|
+
* Accepts all the tracked changes in the collection.
|
|
91703
|
+
*
|
|
91704
|
+
* @remarks
|
|
91705
|
+
* [Api set: WordApi 1.6]
|
|
91706
|
+
*/
|
|
91707
|
+
acceptAll(): void;
|
|
91708
|
+
/**
|
|
91709
|
+
* Gets the first TrackedChange in this collection. Throws an `ItemNotFound` error if this collection is empty.
|
|
91710
|
+
*
|
|
91711
|
+
* @remarks
|
|
91712
|
+
* [Api set: WordApi 1.6]
|
|
91713
|
+
*/
|
|
91714
|
+
getFirst(): Word.TrackedChange;
|
|
91715
|
+
/**
|
|
91716
|
+
* Gets the first TrackedChange in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
91717
|
+
*
|
|
91718
|
+
* @remarks
|
|
91719
|
+
* [Api set: WordApi 1.6]
|
|
91720
|
+
*/
|
|
91721
|
+
getFirstOrNullObject(): Word.TrackedChange;
|
|
91722
|
+
/**
|
|
91723
|
+
* Rejects all the tracked changes in the collection.
|
|
91724
|
+
*
|
|
91725
|
+
* @remarks
|
|
91726
|
+
* [Api set: WordApi 1.6]
|
|
91727
|
+
*/
|
|
91728
|
+
rejectAll(): void;
|
|
91729
|
+
/**
|
|
91730
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
91731
|
+
*
|
|
91732
|
+
* @param options Provides options for which properties of the object to load.
|
|
91733
|
+
*/
|
|
91734
|
+
load(options?: Word.Interfaces.TrackedChangeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TrackedChangeCollection;
|
|
91735
|
+
/**
|
|
91736
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
91737
|
+
*
|
|
91738
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
91739
|
+
*/
|
|
91740
|
+
load(propertyNames?: string | string[]): Word.TrackedChangeCollection;
|
|
91741
|
+
/**
|
|
91742
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
91743
|
+
*
|
|
91744
|
+
* @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.
|
|
91745
|
+
*/
|
|
91746
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TrackedChangeCollection;
|
|
91747
|
+
/**
|
|
91748
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're 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 need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
91749
|
+
*/
|
|
91750
|
+
track(): Word.TrackedChangeCollection;
|
|
91751
|
+
/**
|
|
91752
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.
|
|
91753
|
+
*/
|
|
91754
|
+
untrack(): Word.TrackedChangeCollection;
|
|
91755
|
+
/**
|
|
91756
|
+
* 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.)
|
|
91757
|
+
* Whereas the original `Word.TrackedChangeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TrackedChangeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
91758
|
+
*/
|
|
91759
|
+
toJSON(): Word.Interfaces.TrackedChangeCollectionData;
|
|
91760
|
+
}
|
|
91761
|
+
/**
|
|
91762
|
+
* ChangeTracking mode.
|
|
91763
|
+
*
|
|
91764
|
+
* @remarks
|
|
91765
|
+
* [Api set: WordApi 1.4]
|
|
91766
|
+
*/
|
|
91767
|
+
enum ChangeTrackingMode {
|
|
91768
|
+
/**
|
|
91769
|
+
* ChangeTracking is turned off.
|
|
91770
|
+
* @remarks
|
|
91771
|
+
* [Api set: WordApi 1.4]
|
|
91772
|
+
*/
|
|
91773
|
+
off = "Off",
|
|
91774
|
+
/**
|
|
91775
|
+
* ChangeTracking is turned on for everyone.
|
|
91776
|
+
* @remarks
|
|
91777
|
+
* [Api set: WordApi 1.4]
|
|
91778
|
+
*/
|
|
91779
|
+
trackAll = "TrackAll",
|
|
91780
|
+
/**
|
|
91781
|
+
* Tracking is turned on for my changes only.
|
|
91782
|
+
* @remarks
|
|
91783
|
+
* [Api set: WordApi 1.4]
|
|
91784
|
+
*/
|
|
91785
|
+
trackMineOnly = "TrackMineOnly",
|
|
91786
|
+
}
|
|
91787
|
+
/**
|
|
91788
|
+
* Specify the current version or the original version of the text.
|
|
91789
|
+
*
|
|
91790
|
+
* @remarks
|
|
91791
|
+
* [Api set: WordApi 1.4]
|
|
91792
|
+
*/
|
|
91793
|
+
enum ChangeTrackingVersion {
|
|
91794
|
+
/**
|
|
91795
|
+
* @remarks
|
|
91796
|
+
* [Api set: WordApi 1.4]
|
|
91797
|
+
*/
|
|
91798
|
+
original = "Original",
|
|
91799
|
+
/**
|
|
91800
|
+
* @remarks
|
|
91801
|
+
* [Api set: WordApi 1.4]
|
|
91802
|
+
*/
|
|
91803
|
+
current = "Current",
|
|
91804
|
+
}
|
|
91805
|
+
/**
|
|
91806
|
+
* Specify the track state when ChangeTracking is on.
|
|
91807
|
+
*
|
|
91808
|
+
* @remarks
|
|
91809
|
+
* [Api set: WordApi 1.5]
|
|
91810
|
+
*/
|
|
91811
|
+
enum ChangeTrackingState {
|
|
91812
|
+
/**
|
|
91813
|
+
* @remarks
|
|
91814
|
+
* [Api set: WordApi 1.5]
|
|
91815
|
+
*/
|
|
91816
|
+
unknown = "Unknown",
|
|
91817
|
+
/**
|
|
91818
|
+
* @remarks
|
|
91819
|
+
* [Api set: WordApi 1.5]
|
|
91820
|
+
*/
|
|
91821
|
+
normal = "Normal",
|
|
91822
|
+
/**
|
|
91823
|
+
* @remarks
|
|
91824
|
+
* [Api set: WordApi 1.5]
|
|
91825
|
+
*/
|
|
91826
|
+
added = "Added",
|
|
91827
|
+
/**
|
|
91828
|
+
* @remarks
|
|
91829
|
+
* [Api set: WordApi 1.5]
|
|
91830
|
+
*/
|
|
91831
|
+
deleted = "Deleted",
|
|
91832
|
+
}
|
|
91833
|
+
/**
|
|
91834
|
+
* TrackedChange type.
|
|
91835
|
+
*
|
|
91836
|
+
* @remarks
|
|
91837
|
+
* [Api set: WordApi 1.6]
|
|
91838
|
+
*/
|
|
91839
|
+
enum TrackedChangeType {
|
|
91840
|
+
/**
|
|
91841
|
+
* No revision.
|
|
91842
|
+
* @remarks
|
|
91843
|
+
* [Api set: WordApi 1.6]
|
|
91844
|
+
*/
|
|
91845
|
+
none = "None",
|
|
91846
|
+
/**
|
|
91847
|
+
* Add change.
|
|
91848
|
+
* @remarks
|
|
91849
|
+
* [Api set: WordApi 1.6]
|
|
91850
|
+
*/
|
|
91851
|
+
added = "Added",
|
|
91852
|
+
/**
|
|
91853
|
+
* Delete change.
|
|
91854
|
+
* @remarks
|
|
91855
|
+
* [Api set: WordApi 1.6]
|
|
91856
|
+
*/
|
|
91857
|
+
deleted = "Deleted",
|
|
91858
|
+
/**
|
|
91859
|
+
* Format change.
|
|
91860
|
+
* @remarks
|
|
91861
|
+
* [Api set: WordApi 1.6]
|
|
91862
|
+
*/
|
|
91863
|
+
formatted = "Formatted",
|
|
91864
|
+
}
|
|
91865
|
+
/**
|
|
91866
|
+
* Note item type
|
|
91867
|
+
*
|
|
91868
|
+
* @remarks
|
|
91869
|
+
* [Api set: WordApi 1.5]
|
|
91870
|
+
*/
|
|
91871
|
+
enum NoteItemType {
|
|
91872
|
+
/**
|
|
91873
|
+
* @remarks
|
|
91874
|
+
* [Api set: WordApi 1.5]
|
|
91875
|
+
*/
|
|
91372
91876
|
footnote = "Footnote",
|
|
91373
91877
|
/**
|
|
91374
91878
|
* @remarks
|
|
@@ -91419,6 +91923,24 @@ declare namespace Word {
|
|
|
91419
91923
|
* [Api set: WordApi 1.5]
|
|
91420
91924
|
*/
|
|
91421
91925
|
contentControlExited = "ContentControlExited",
|
|
91926
|
+
/**
|
|
91927
|
+
* Represents that one or more new paragraphs were added.
|
|
91928
|
+
* @remarks
|
|
91929
|
+
* [Api set: WordApi 1.6]
|
|
91930
|
+
*/
|
|
91931
|
+
paragraphAdded = "ParagraphAdded",
|
|
91932
|
+
/**
|
|
91933
|
+
* Represents that one or more paragraphs were changed.
|
|
91934
|
+
* @remarks
|
|
91935
|
+
* [Api set: WordApi 1.6]
|
|
91936
|
+
*/
|
|
91937
|
+
paragraphChanged = "ParagraphChanged",
|
|
91938
|
+
/**
|
|
91939
|
+
* Represents that one or more paragraphs were deleted.
|
|
91940
|
+
* @remarks
|
|
91941
|
+
* [Api set: WordApi 1.6]
|
|
91942
|
+
*/
|
|
91943
|
+
paragraphDeleted = "ParagraphDeleted",
|
|
91422
91944
|
}
|
|
91423
91945
|
/**
|
|
91424
91946
|
* An enum that specifies an event's source. It can be local or remote (through coauthoring).
|
|
@@ -91451,7 +91973,7 @@ declare namespace Word {
|
|
|
91451
91973
|
* @remarks
|
|
91452
91974
|
* [Api set: WordApi 1.5]
|
|
91453
91975
|
*/
|
|
91454
|
-
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited";
|
|
91976
|
+
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted";
|
|
91455
91977
|
/**
|
|
91456
91978
|
* Gets the content control IDs.
|
|
91457
91979
|
*
|
|
@@ -91480,7 +92002,7 @@ declare namespace Word {
|
|
|
91480
92002
|
* @remarks
|
|
91481
92003
|
* [Api set: WordApi 1.5]
|
|
91482
92004
|
*/
|
|
91483
|
-
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited";
|
|
92005
|
+
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted";
|
|
91484
92006
|
/**
|
|
91485
92007
|
* Gets the content control IDs.
|
|
91486
92008
|
*
|
|
@@ -91509,7 +92031,7 @@ declare namespace Word {
|
|
|
91509
92031
|
* @remarks
|
|
91510
92032
|
* [Api set: WordApi 1.5]
|
|
91511
92033
|
*/
|
|
91512
|
-
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited";
|
|
92034
|
+
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted";
|
|
91513
92035
|
/**
|
|
91514
92036
|
* Gets the content control IDs.
|
|
91515
92037
|
*
|
|
@@ -91538,7 +92060,7 @@ declare namespace Word {
|
|
|
91538
92060
|
* @remarks
|
|
91539
92061
|
* [Api set: WordApi 1.5]
|
|
91540
92062
|
*/
|
|
91541
|
-
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited";
|
|
92063
|
+
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted";
|
|
91542
92064
|
/**
|
|
91543
92065
|
* Gets the content control IDs.
|
|
91544
92066
|
*
|
|
@@ -91567,7 +92089,7 @@ declare namespace Word {
|
|
|
91567
92089
|
* @remarks
|
|
91568
92090
|
* [Api set: WordApi 1.5]
|
|
91569
92091
|
*/
|
|
91570
|
-
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited";
|
|
92092
|
+
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted";
|
|
91571
92093
|
/**
|
|
91572
92094
|
* Gets the content control IDs.
|
|
91573
92095
|
*
|
|
@@ -91596,7 +92118,7 @@ declare namespace Word {
|
|
|
91596
92118
|
* @remarks
|
|
91597
92119
|
* [Api set: WordApi 1.5]
|
|
91598
92120
|
*/
|
|
91599
|
-
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited";
|
|
92121
|
+
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted";
|
|
91600
92122
|
/**
|
|
91601
92123
|
* Gets the content control IDs.
|
|
91602
92124
|
*
|
|
@@ -91612,6 +92134,93 @@ declare namespace Word {
|
|
|
91612
92134
|
*/
|
|
91613
92135
|
source: Word.EventSource | "Local" | "Remote";
|
|
91614
92136
|
}
|
|
92137
|
+
/**
|
|
92138
|
+
* Provides information about the paragraphs that raised the paragraphAdded event.
|
|
92139
|
+
*
|
|
92140
|
+
* @remarks
|
|
92141
|
+
* [Api set: WordApi 1.6]
|
|
92142
|
+
*/
|
|
92143
|
+
interface ParagraphAddedEventArgs {
|
|
92144
|
+
/**
|
|
92145
|
+
* The source of the event. It can be local or remote (through coauthoring).
|
|
92146
|
+
*
|
|
92147
|
+
* @remarks
|
|
92148
|
+
* [Api set: WordApi 1.6]
|
|
92149
|
+
*/
|
|
92150
|
+
source: Word.EventSource | "Local" | "Remote";
|
|
92151
|
+
/**
|
|
92152
|
+
* The event type. See Word.EventType for details.
|
|
92153
|
+
*
|
|
92154
|
+
* @remarks
|
|
92155
|
+
* [Api set: WordApi 1.6]
|
|
92156
|
+
*/
|
|
92157
|
+
type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted";
|
|
92158
|
+
/**
|
|
92159
|
+
* Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors.
|
|
92160
|
+
*
|
|
92161
|
+
* @remarks
|
|
92162
|
+
* [Api set: WordApi 1.6]
|
|
92163
|
+
*/
|
|
92164
|
+
uniqueLocalIds: string[];
|
|
92165
|
+
}
|
|
92166
|
+
/**
|
|
92167
|
+
* Provides information about the paragraphs that raised the paragraphChanged event.
|
|
92168
|
+
*
|
|
92169
|
+
* @remarks
|
|
92170
|
+
* [Api set: WordApi 1.6]
|
|
92171
|
+
*/
|
|
92172
|
+
interface ParagraphChangedEventArgs {
|
|
92173
|
+
/**
|
|
92174
|
+
* The source of the event. It can be local or remote (through coauthoring).
|
|
92175
|
+
*
|
|
92176
|
+
* @remarks
|
|
92177
|
+
* [Api set: WordApi 1.6]
|
|
92178
|
+
*/
|
|
92179
|
+
source: Word.EventSource | "Local" | "Remote";
|
|
92180
|
+
/**
|
|
92181
|
+
* The event type. See Word.EventType for details.
|
|
92182
|
+
*
|
|
92183
|
+
* @remarks
|
|
92184
|
+
* [Api set: WordApi 1.6]
|
|
92185
|
+
*/
|
|
92186
|
+
type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted";
|
|
92187
|
+
/**
|
|
92188
|
+
* Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors.
|
|
92189
|
+
*
|
|
92190
|
+
* @remarks
|
|
92191
|
+
* [Api set: WordApi 1.6]
|
|
92192
|
+
*/
|
|
92193
|
+
uniqueLocalIds: string[];
|
|
92194
|
+
}
|
|
92195
|
+
/**
|
|
92196
|
+
* Provides information about the paragraphs that raised the paragraphDeleted event.
|
|
92197
|
+
*
|
|
92198
|
+
* @remarks
|
|
92199
|
+
* [Api set: WordApi 1.6]
|
|
92200
|
+
*/
|
|
92201
|
+
interface ParagraphDeletedEventArgs {
|
|
92202
|
+
/**
|
|
92203
|
+
* The source of the event. It can be local or remote (through coauthoring).
|
|
92204
|
+
*
|
|
92205
|
+
* @remarks
|
|
92206
|
+
* [Api set: WordApi 1.6]
|
|
92207
|
+
*/
|
|
92208
|
+
source: Word.EventSource | "Local" | "Remote";
|
|
92209
|
+
/**
|
|
92210
|
+
* The event type. See Word.EventType for details.
|
|
92211
|
+
*
|
|
92212
|
+
* @remarks
|
|
92213
|
+
* [Api set: WordApi 1.6]
|
|
92214
|
+
*/
|
|
92215
|
+
type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted";
|
|
92216
|
+
/**
|
|
92217
|
+
* Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors.
|
|
92218
|
+
*
|
|
92219
|
+
* @remarks
|
|
92220
|
+
* [Api set: WordApi 1.6]
|
|
92221
|
+
*/
|
|
92222
|
+
uniqueLocalIds: string[];
|
|
92223
|
+
}
|
|
91615
92224
|
/**
|
|
91616
92225
|
* Specifies supported content control types and subtypes.
|
|
91617
92226
|
*
|
|
@@ -91731,7 +92340,7 @@ declare namespace Word {
|
|
|
91731
92340
|
*/
|
|
91732
92341
|
tags = "Tags",
|
|
91733
92342
|
/**
|
|
91734
|
-
* Represents a content control that
|
|
92343
|
+
* Represents a content control that isn't shown.
|
|
91735
92344
|
* @remarks
|
|
91736
92345
|
* [Api set: WordApi 1.1]
|
|
91737
92346
|
*/
|
|
@@ -92159,13 +92768,13 @@ declare namespace Word {
|
|
|
92159
92768
|
*/
|
|
92160
92769
|
equal = "Equal",
|
|
92161
92770
|
/**
|
|
92162
|
-
* Indicates that this instance contains the range and that it shares the same start character. The range
|
|
92771
|
+
* Indicates that this instance contains the range and that it shares the same start character. The range doesn't share the same end character as this instance.
|
|
92163
92772
|
* @remarks
|
|
92164
92773
|
* [Api set: WordApi 1.3]
|
|
92165
92774
|
*/
|
|
92166
92775
|
containsStart = "ContainsStart",
|
|
92167
92776
|
/**
|
|
92168
|
-
* Indicates that this instance contains the range and that it shares the same end character. The range
|
|
92777
|
+
* Indicates that this instance contains the range and that it shares the same end character. The range doesn't share the same start character as this instance.
|
|
92169
92778
|
* @remarks
|
|
92170
92779
|
* [Api set: WordApi 1.3]
|
|
92171
92780
|
*/
|
|
@@ -92177,19 +92786,19 @@ declare namespace Word {
|
|
|
92177
92786
|
*/
|
|
92178
92787
|
contains = "Contains",
|
|
92179
92788
|
/**
|
|
92180
|
-
* Indicates that this instance is inside the range and that it shares the same start character. The range
|
|
92789
|
+
* Indicates that this instance is inside the range and that it shares the same start character. The range doesn't share the same end character as this instance.
|
|
92181
92790
|
* @remarks
|
|
92182
92791
|
* [Api set: WordApi 1.3]
|
|
92183
92792
|
*/
|
|
92184
92793
|
insideStart = "InsideStart",
|
|
92185
92794
|
/**
|
|
92186
|
-
* Indicates that this instance is inside the range and that it shares the same end character. The range
|
|
92795
|
+
* Indicates that this instance is inside the range and that it shares the same end character. The range doesn't share the same start character as this instance.
|
|
92187
92796
|
* @remarks
|
|
92188
92797
|
* [Api set: WordApi 1.3]
|
|
92189
92798
|
*/
|
|
92190
92799
|
insideEnd = "InsideEnd",
|
|
92191
92800
|
/**
|
|
92192
|
-
* Indicates that this instance is inside the range. The range
|
|
92801
|
+
* Indicates that this instance is inside the range. The range doesn't share the same start and end characters as this instance.
|
|
92193
92802
|
* @remarks
|
|
92194
92803
|
* [Api set: WordApi 1.3]
|
|
92195
92804
|
*/
|
|
@@ -92201,7 +92810,7 @@ declare namespace Word {
|
|
|
92201
92810
|
*/
|
|
92202
92811
|
adjacentBefore = "AdjacentBefore",
|
|
92203
92812
|
/**
|
|
92204
|
-
* Indicates that this instance starts before the range and overlaps the range
|
|
92813
|
+
* Indicates that this instance starts before the range and overlaps the range's first character.
|
|
92205
92814
|
* @remarks
|
|
92206
92815
|
* [Api set: WordApi 1.3]
|
|
92207
92816
|
*/
|
|
@@ -92561,10 +93170,10 @@ declare namespace Word {
|
|
|
92561
93170
|
/**
|
|
92562
93171
|
* Represents the built-in style in a Word document.
|
|
92563
93172
|
*
|
|
92564
|
-
* Important: This enum was renamed from `Style` to `BuiltInStyleName` in WordApi 1.5.
|
|
92565
|
-
*
|
|
92566
93173
|
* @remarks
|
|
92567
93174
|
* [Api set: WordApi 1.3]
|
|
93175
|
+
*
|
|
93176
|
+
* Important: This enum was renamed from `Style` to `BuiltInStyleName` in WordApi 1.5.
|
|
92568
93177
|
*/
|
|
92569
93178
|
enum BuiltInStyleName {
|
|
92570
93179
|
/**
|
|
@@ -93454,7 +94063,7 @@ declare namespace Word {
|
|
|
93454
94063
|
*/
|
|
93455
94064
|
enum CloseBehavior {
|
|
93456
94065
|
/**
|
|
93457
|
-
*
|
|
94066
|
+
* Saves the changes before closing the document.
|
|
93458
94067
|
* @remarks
|
|
93459
94068
|
* [Api set: WordApi 1.5]
|
|
93460
94069
|
*/
|
|
@@ -94174,7 +94783,7 @@ declare namespace Word {
|
|
|
94174
94783
|
*/
|
|
94175
94784
|
strikeThrough?: boolean;
|
|
94176
94785
|
/**
|
|
94177
|
-
* Specifies a value that indicates the comment text's underline type. 'None' if the comment text
|
|
94786
|
+
* Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined.
|
|
94178
94787
|
*
|
|
94179
94788
|
* @remarks
|
|
94180
94789
|
* [Api set: WordApi 1.4]
|
|
@@ -94247,7 +94856,9 @@ declare namespace Word {
|
|
|
94247
94856
|
*/
|
|
94248
94857
|
color?: string;
|
|
94249
94858
|
/**
|
|
94250
|
-
* Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty.
|
|
94859
|
+
* Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty.
|
|
94860
|
+
|
|
94861
|
+
Note: The set operation for this property isn't supported in Word on the web.
|
|
94251
94862
|
*
|
|
94252
94863
|
* @remarks
|
|
94253
94864
|
* [Api set: WordApi 1.1]
|
|
@@ -94436,6 +95047,8 @@ declare namespace Word {
|
|
|
94436
95047
|
*
|
|
94437
95048
|
* @remarks
|
|
94438
95049
|
* [Api set: WordApi 1.4]
|
|
95050
|
+
*
|
|
95051
|
+
* Note: The ability to set the code was introduced in WordApi 1.5.
|
|
94439
95052
|
*/
|
|
94440
95053
|
code?: string;
|
|
94441
95054
|
/**
|
|
@@ -94530,7 +95143,7 @@ declare namespace Word {
|
|
|
94530
95143
|
*/
|
|
94531
95144
|
superscript?: boolean;
|
|
94532
95145
|
/**
|
|
94533
|
-
* Specifies a value that indicates the font's underline type. 'None' if the font
|
|
95146
|
+
* Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined.
|
|
94534
95147
|
*
|
|
94535
95148
|
* @remarks
|
|
94536
95149
|
* [Api set: WordApi 1.1]
|
|
@@ -94631,7 +95244,7 @@ declare namespace Word {
|
|
|
94631
95244
|
*/
|
|
94632
95245
|
font?: Word.Interfaces.FontUpdateData;
|
|
94633
95246
|
/**
|
|
94634
|
-
* Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph
|
|
95247
|
+
* Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list.
|
|
94635
95248
|
*
|
|
94636
95249
|
* @remarks
|
|
94637
95250
|
* [Api set: WordApi 1.3]
|
|
@@ -94924,7 +95537,7 @@ declare namespace Word {
|
|
|
94924
95537
|
/** An interface for updating data on the Section object, for use in `section.set({ ... })`. */
|
|
94925
95538
|
interface SectionUpdateData {
|
|
94926
95539
|
/**
|
|
94927
|
-
* Gets the body object of the section. This
|
|
95540
|
+
* Gets the body object of the section. This doesn't include the header/footer and other section metadata.
|
|
94928
95541
|
*
|
|
94929
95542
|
* @remarks
|
|
94930
95543
|
* [Api set: WordApi 1.1]
|
|
@@ -94970,8 +95583,40 @@ declare namespace Word {
|
|
|
94970
95583
|
*/
|
|
94971
95584
|
paragraphFormat?: Word.Interfaces.ParagraphFormatUpdateData;
|
|
94972
95585
|
/**
|
|
94973
|
-
|
|
94974
|
-
|
|
95586
|
+
* Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
|
|
95587
|
+
*
|
|
95588
|
+
* @remarks
|
|
95589
|
+
* [Api set: WordApi 1.6]
|
|
95590
|
+
*/
|
|
95591
|
+
shading?: Word.Interfaces.ShadingUpdateData;
|
|
95592
|
+
/**
|
|
95593
|
+
* Gets a TableStyle object representing Style properties that can be applied to a table.
|
|
95594
|
+
*
|
|
95595
|
+
* @remarks
|
|
95596
|
+
* [Api set: WordApi 1.6]
|
|
95597
|
+
*/
|
|
95598
|
+
tableStyle?: Word.Interfaces.TableStyleUpdateData;
|
|
95599
|
+
/**
|
|
95600
|
+
* Specifies the name of an existing style to use as the base formatting of another style.
|
|
95601
|
+
*
|
|
95602
|
+
* @remarks
|
|
95603
|
+
* [Api set: WordApi 1.5]
|
|
95604
|
+
*
|
|
95605
|
+
* Note: The ability to set `baseStyle` was introduced in WordApi 1.6.
|
|
95606
|
+
*/
|
|
95607
|
+
baseStyle?: string;
|
|
95608
|
+
/**
|
|
95609
|
+
* Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style.
|
|
95610
|
+
*
|
|
95611
|
+
* @remarks
|
|
95612
|
+
* [Api set: WordApi 1.5]
|
|
95613
|
+
*
|
|
95614
|
+
* Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6.
|
|
95615
|
+
*/
|
|
95616
|
+
nextParagraphStyle?: string;
|
|
95617
|
+
/**
|
|
95618
|
+
* Specifies the priority.
|
|
95619
|
+
*
|
|
94975
95620
|
* @remarks
|
|
94976
95621
|
* [Api set: WordApi 1.5]
|
|
94977
95622
|
*/
|
|
@@ -94998,6 +95643,16 @@ declare namespace Word {
|
|
|
94998
95643
|
*/
|
|
94999
95644
|
visibility?: boolean;
|
|
95000
95645
|
}
|
|
95646
|
+
/** An interface for updating data on the Shading object, for use in `shading.set({ ... })`. */
|
|
95647
|
+
interface ShadingUpdateData {
|
|
95648
|
+
/**
|
|
95649
|
+
* Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name.
|
|
95650
|
+
*
|
|
95651
|
+
* @remarks
|
|
95652
|
+
* [Api set: WordApi 1.6]
|
|
95653
|
+
*/
|
|
95654
|
+
backgroundPatternColor?: string;
|
|
95655
|
+
}
|
|
95001
95656
|
/** An interface for updating data on the Table object, for use in `table.set({ ... })`. */
|
|
95002
95657
|
interface TableUpdateData {
|
|
95003
95658
|
/**
|
|
@@ -95106,6 +95761,44 @@ declare namespace Word {
|
|
|
95106
95761
|
*/
|
|
95107
95762
|
width?: number;
|
|
95108
95763
|
}
|
|
95764
|
+
/** An interface for updating data on the TableStyle object, for use in `tableStyle.set({ ... })`. */
|
|
95765
|
+
interface TableStyleUpdateData {
|
|
95766
|
+
/**
|
|
95767
|
+
* Specifies the amount of space to add between the contents and the bottom borders of the cells.
|
|
95768
|
+
*
|
|
95769
|
+
* @remarks
|
|
95770
|
+
* [Api set: WordApi 1.6]
|
|
95771
|
+
*/
|
|
95772
|
+
bottomCellMargin?: number;
|
|
95773
|
+
/**
|
|
95774
|
+
* Specifies the spacing (in points) between the cells in a table style.
|
|
95775
|
+
*
|
|
95776
|
+
* @remarks
|
|
95777
|
+
* [Api set: WordApi 1.6]
|
|
95778
|
+
*/
|
|
95779
|
+
cellSpacing?: number;
|
|
95780
|
+
/**
|
|
95781
|
+
* Specifies the amount of space to add between the contents and the left borders of the cells.
|
|
95782
|
+
*
|
|
95783
|
+
* @remarks
|
|
95784
|
+
* [Api set: WordApi 1.6]
|
|
95785
|
+
*/
|
|
95786
|
+
leftCellMargin?: number;
|
|
95787
|
+
/**
|
|
95788
|
+
* Specifies the amount of space to add between the contents and the right borders of the cells.
|
|
95789
|
+
*
|
|
95790
|
+
* @remarks
|
|
95791
|
+
* [Api set: WordApi 1.6]
|
|
95792
|
+
*/
|
|
95793
|
+
rightCellMargin?: number;
|
|
95794
|
+
/**
|
|
95795
|
+
* Specifies the amount of space to add between the contents and the top borders of the cells.
|
|
95796
|
+
*
|
|
95797
|
+
* @remarks
|
|
95798
|
+
* [Api set: WordApi 1.6]
|
|
95799
|
+
*/
|
|
95800
|
+
topCellMargin?: number;
|
|
95801
|
+
}
|
|
95109
95802
|
/** An interface for updating data on the TableCollection object, for use in `tableCollection.set({ ... })`. */
|
|
95110
95803
|
interface TableCollectionUpdateData {
|
|
95111
95804
|
items?: Word.Interfaces.TableData[];
|
|
@@ -95232,6 +95925,10 @@ declare namespace Word {
|
|
|
95232
95925
|
*/
|
|
95233
95926
|
width?: number;
|
|
95234
95927
|
}
|
|
95928
|
+
/** An interface for updating data on the TrackedChangeCollection object, for use in `trackedChangeCollection.set({ ... })`. */
|
|
95929
|
+
interface TrackedChangeCollectionUpdateData {
|
|
95930
|
+
items?: Word.Interfaces.TrackedChangeData[];
|
|
95931
|
+
}
|
|
95235
95932
|
/** An interface describing the data returned by calling `body.toJSON()`. */
|
|
95236
95933
|
interface BodyData {
|
|
95237
95934
|
/**
|
|
@@ -95256,7 +95953,7 @@ declare namespace Word {
|
|
|
95256
95953
|
*/
|
|
95257
95954
|
font?: Word.Interfaces.FontData;
|
|
95258
95955
|
/**
|
|
95259
|
-
* Gets the collection of InlinePicture objects in the body. The collection
|
|
95956
|
+
* Gets the collection of InlinePicture objects in the body. The collection doesn't include floating images.
|
|
95260
95957
|
*
|
|
95261
95958
|
* @remarks
|
|
95262
95959
|
* [Api set: WordApi 1.1]
|
|
@@ -95270,10 +95967,12 @@ declare namespace Word {
|
|
|
95270
95967
|
*/
|
|
95271
95968
|
lists?: Word.Interfaces.ListData[];
|
|
95272
95969
|
/**
|
|
95273
|
-
* Gets the collection of paragraph objects in the body.
|
|
95970
|
+
* Gets the collection of paragraph objects in the body.
|
|
95274
95971
|
*
|
|
95275
95972
|
* @remarks
|
|
95276
95973
|
* [Api set: WordApi 1.1]
|
|
95974
|
+
*
|
|
95975
|
+
* Important: Paragraphs in tables aren't returned for requirement sets 1.1 and 1.2. From requirement set 1.3, paragraphs in tables are also returned.
|
|
95277
95976
|
*/
|
|
95278
95977
|
paragraphs?: Word.Interfaces.ParagraphData[];
|
|
95279
95978
|
/**
|
|
@@ -95420,7 +96119,7 @@ declare namespace Word {
|
|
|
95420
96119
|
*/
|
|
95421
96120
|
text?: string;
|
|
95422
96121
|
/**
|
|
95423
|
-
* Specifies a value that indicates the comment text's underline type. 'None' if the comment text
|
|
96122
|
+
* Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined.
|
|
95424
96123
|
*
|
|
95425
96124
|
* @remarks
|
|
95426
96125
|
* [Api set: WordApi 1.4]
|
|
@@ -95507,7 +96206,7 @@ declare namespace Word {
|
|
|
95507
96206
|
*/
|
|
95508
96207
|
font?: Word.Interfaces.FontData;
|
|
95509
96208
|
/**
|
|
95510
|
-
* Gets the collection of InlinePicture objects in the content control. The collection
|
|
96209
|
+
* Gets the collection of InlinePicture objects in the content control. The collection doesn't include floating images.
|
|
95511
96210
|
*
|
|
95512
96211
|
* @remarks
|
|
95513
96212
|
* [Api set: WordApi 1.1]
|
|
@@ -95521,10 +96220,12 @@ declare namespace Word {
|
|
|
95521
96220
|
*/
|
|
95522
96221
|
lists?: Word.Interfaces.ListData[];
|
|
95523
96222
|
/**
|
|
95524
|
-
* Gets the collection of paragraph objects in the content control.
|
|
96223
|
+
* Gets the collection of paragraph objects in the content control.
|
|
95525
96224
|
*
|
|
95526
96225
|
* @remarks
|
|
95527
96226
|
* [Api set: WordApi 1.1]
|
|
96227
|
+
*
|
|
96228
|
+
* Important: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this content control aren't returned. From requirement set 1.3, paragraphs in such tables are also returned.
|
|
95528
96229
|
*/
|
|
95529
96230
|
paragraphs?: Word.Interfaces.ParagraphData[];
|
|
95530
96231
|
/**
|
|
@@ -95570,7 +96271,9 @@ declare namespace Word {
|
|
|
95570
96271
|
*/
|
|
95571
96272
|
id?: number;
|
|
95572
96273
|
/**
|
|
95573
|
-
* Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty.
|
|
96274
|
+
* Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty.
|
|
96275
|
+
|
|
96276
|
+
Note: The set operation for this property isn't supported in Word on the web.
|
|
95574
96277
|
*
|
|
95575
96278
|
* @remarks
|
|
95576
96279
|
* [Api set: WordApi 1.1]
|
|
@@ -96054,7 +96757,7 @@ declare namespace Word {
|
|
|
96054
96757
|
*/
|
|
96055
96758
|
superscript?: boolean;
|
|
96056
96759
|
/**
|
|
96057
|
-
* Specifies a value that indicates the font's underline type. 'None' if the font
|
|
96760
|
+
* Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined.
|
|
96058
96761
|
*
|
|
96059
96762
|
* @remarks
|
|
96060
96763
|
* [Api set: WordApi 1.1]
|
|
@@ -96214,14 +96917,14 @@ declare namespace Word {
|
|
|
96214
96917
|
*/
|
|
96215
96918
|
font?: Word.Interfaces.FontData;
|
|
96216
96919
|
/**
|
|
96217
|
-
* Gets the collection of InlinePicture objects in the paragraph. The collection
|
|
96920
|
+
* Gets the collection of InlinePicture objects in the paragraph. The collection doesn't include floating images.
|
|
96218
96921
|
*
|
|
96219
96922
|
* @remarks
|
|
96220
96923
|
* [Api set: WordApi 1.1]
|
|
96221
96924
|
*/
|
|
96222
96925
|
inlinePictures?: Word.Interfaces.InlinePictureData[];
|
|
96223
96926
|
/**
|
|
96224
|
-
* Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph
|
|
96927
|
+
* Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list.
|
|
96225
96928
|
*
|
|
96226
96929
|
* @remarks
|
|
96227
96930
|
* [Api set: WordApi 1.3]
|
|
@@ -96333,7 +97036,7 @@ declare namespace Word {
|
|
|
96333
97036
|
*/
|
|
96334
97037
|
styleBuiltIn?: Word.BuiltInStyleName | "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";
|
|
96335
97038
|
/**
|
|
96336
|
-
* Gets the level of the paragraph's table. It returns 0 if the paragraph
|
|
97039
|
+
* Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table.
|
|
96337
97040
|
*
|
|
96338
97041
|
* @remarks
|
|
96339
97042
|
* [Api set: WordApi 1.3]
|
|
@@ -96346,6 +97049,13 @@ declare namespace Word {
|
|
|
96346
97049
|
* [Api set: WordApi 1.1]
|
|
96347
97050
|
*/
|
|
96348
97051
|
text?: string;
|
|
97052
|
+
/**
|
|
97053
|
+
* Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors.
|
|
97054
|
+
*
|
|
97055
|
+
* @remarks
|
|
97056
|
+
* [Api set: WordApi 1.6]
|
|
97057
|
+
*/
|
|
97058
|
+
uniqueLocalId?: string;
|
|
96349
97059
|
}
|
|
96350
97060
|
/** An interface describing the data returned by calling `paragraphCollection.toJSON()`. */
|
|
96351
97061
|
interface ParagraphCollectionData {
|
|
@@ -96570,7 +97280,7 @@ declare namespace Word {
|
|
|
96570
97280
|
/** An interface describing the data returned by calling `section.toJSON()`. */
|
|
96571
97281
|
interface SectionData {
|
|
96572
97282
|
/**
|
|
96573
|
-
* Gets the body object of the section. This
|
|
97283
|
+
* Gets the body object of the section. This doesn't include the header/footer and other section metadata.
|
|
96574
97284
|
*
|
|
96575
97285
|
* @remarks
|
|
96576
97286
|
* [Api set: WordApi 1.1]
|
|
@@ -96623,10 +97333,26 @@ declare namespace Word {
|
|
|
96623
97333
|
*/
|
|
96624
97334
|
paragraphFormat?: Word.Interfaces.ParagraphFormatData;
|
|
96625
97335
|
/**
|
|
96626
|
-
|
|
97336
|
+
* Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
|
|
97337
|
+
*
|
|
97338
|
+
* @remarks
|
|
97339
|
+
* [Api set: WordApi 1.6]
|
|
97340
|
+
*/
|
|
97341
|
+
shading?: Word.Interfaces.ShadingData;
|
|
97342
|
+
/**
|
|
97343
|
+
* Gets a TableStyle object representing Style properties that can be applied to a table.
|
|
97344
|
+
*
|
|
97345
|
+
* @remarks
|
|
97346
|
+
* [Api set: WordApi 1.6]
|
|
97347
|
+
*/
|
|
97348
|
+
tableStyle?: Word.Interfaces.TableStyleData;
|
|
97349
|
+
/**
|
|
97350
|
+
* Specifies the name of an existing style to use as the base formatting of another style.
|
|
96627
97351
|
*
|
|
96628
97352
|
* @remarks
|
|
96629
97353
|
* [Api set: WordApi 1.5]
|
|
97354
|
+
*
|
|
97355
|
+
* Note: The ability to set `baseStyle` was introduced in WordApi 1.6.
|
|
96630
97356
|
*/
|
|
96631
97357
|
baseStyle?: string;
|
|
96632
97358
|
/**
|
|
@@ -96658,10 +97384,12 @@ declare namespace Word {
|
|
|
96658
97384
|
*/
|
|
96659
97385
|
nameLocal?: string;
|
|
96660
97386
|
/**
|
|
96661
|
-
*
|
|
97387
|
+
* Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style.
|
|
96662
97388
|
*
|
|
96663
97389
|
* @remarks
|
|
96664
97390
|
* [Api set: WordApi 1.5]
|
|
97391
|
+
*
|
|
97392
|
+
* Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6.
|
|
96665
97393
|
*/
|
|
96666
97394
|
nextParagraphStyle?: string;
|
|
96667
97395
|
/**
|
|
@@ -96700,6 +97428,16 @@ declare namespace Word {
|
|
|
96700
97428
|
*/
|
|
96701
97429
|
visibility?: boolean;
|
|
96702
97430
|
}
|
|
97431
|
+
/** An interface describing the data returned by calling `shading.toJSON()`. */
|
|
97432
|
+
interface ShadingData {
|
|
97433
|
+
/**
|
|
97434
|
+
* Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name.
|
|
97435
|
+
*
|
|
97436
|
+
* @remarks
|
|
97437
|
+
* [Api set: WordApi 1.6]
|
|
97438
|
+
*/
|
|
97439
|
+
backgroundPatternColor?: string;
|
|
97440
|
+
}
|
|
96703
97441
|
/** An interface describing the data returned by calling `table.toJSON()`. */
|
|
96704
97442
|
interface TableData {
|
|
96705
97443
|
/**
|
|
@@ -96850,6 +97588,44 @@ declare namespace Word {
|
|
|
96850
97588
|
*/
|
|
96851
97589
|
width?: number;
|
|
96852
97590
|
}
|
|
97591
|
+
/** An interface describing the data returned by calling `tableStyle.toJSON()`. */
|
|
97592
|
+
interface TableStyleData {
|
|
97593
|
+
/**
|
|
97594
|
+
* Specifies the amount of space to add between the contents and the bottom borders of the cells.
|
|
97595
|
+
*
|
|
97596
|
+
* @remarks
|
|
97597
|
+
* [Api set: WordApi 1.6]
|
|
97598
|
+
*/
|
|
97599
|
+
bottomCellMargin?: number;
|
|
97600
|
+
/**
|
|
97601
|
+
* Specifies the spacing (in points) between the cells in a table style.
|
|
97602
|
+
*
|
|
97603
|
+
* @remarks
|
|
97604
|
+
* [Api set: WordApi 1.6]
|
|
97605
|
+
*/
|
|
97606
|
+
cellSpacing?: number;
|
|
97607
|
+
/**
|
|
97608
|
+
* Specifies the amount of space to add between the contents and the left borders of the cells.
|
|
97609
|
+
*
|
|
97610
|
+
* @remarks
|
|
97611
|
+
* [Api set: WordApi 1.6]
|
|
97612
|
+
*/
|
|
97613
|
+
leftCellMargin?: number;
|
|
97614
|
+
/**
|
|
97615
|
+
* Specifies the amount of space to add between the contents and the right borders of the cells.
|
|
97616
|
+
*
|
|
97617
|
+
* @remarks
|
|
97618
|
+
* [Api set: WordApi 1.6]
|
|
97619
|
+
*/
|
|
97620
|
+
rightCellMargin?: number;
|
|
97621
|
+
/**
|
|
97622
|
+
* Specifies the amount of space to add between the contents and the top borders of the cells.
|
|
97623
|
+
*
|
|
97624
|
+
* @remarks
|
|
97625
|
+
* [Api set: WordApi 1.6]
|
|
97626
|
+
*/
|
|
97627
|
+
topCellMargin?: number;
|
|
97628
|
+
}
|
|
96853
97629
|
/** An interface describing the data returned by calling `tableCollection.toJSON()`. */
|
|
96854
97630
|
interface TableCollectionData {
|
|
96855
97631
|
items?: Word.Interfaces.TableData[];
|
|
@@ -97032,6 +97808,41 @@ declare namespace Word {
|
|
|
97032
97808
|
*/
|
|
97033
97809
|
width?: number;
|
|
97034
97810
|
}
|
|
97811
|
+
/** An interface describing the data returned by calling `trackedChange.toJSON()`. */
|
|
97812
|
+
interface TrackedChangeData {
|
|
97813
|
+
/**
|
|
97814
|
+
* Gets the author of the tracked change.
|
|
97815
|
+
*
|
|
97816
|
+
* @remarks
|
|
97817
|
+
* [Api set: WordApi 1.6]
|
|
97818
|
+
*/
|
|
97819
|
+
author?: string;
|
|
97820
|
+
/**
|
|
97821
|
+
* Gets the date of the tracked change.
|
|
97822
|
+
*
|
|
97823
|
+
* @remarks
|
|
97824
|
+
* [Api set: WordApi 1.6]
|
|
97825
|
+
*/
|
|
97826
|
+
date?: Date;
|
|
97827
|
+
/**
|
|
97828
|
+
* Gets the text of the tracked change.
|
|
97829
|
+
*
|
|
97830
|
+
* @remarks
|
|
97831
|
+
* [Api set: WordApi 1.6]
|
|
97832
|
+
*/
|
|
97833
|
+
text?: string;
|
|
97834
|
+
/**
|
|
97835
|
+
* Gets the type of the tracked change.
|
|
97836
|
+
*
|
|
97837
|
+
* @remarks
|
|
97838
|
+
* [Api set: WordApi 1.6]
|
|
97839
|
+
*/
|
|
97840
|
+
type?: Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted";
|
|
97841
|
+
}
|
|
97842
|
+
/** An interface describing the data returned by calling `trackedChangeCollection.toJSON()`. */
|
|
97843
|
+
interface TrackedChangeCollectionData {
|
|
97844
|
+
items?: Word.Interfaces.TrackedChangeData[];
|
|
97845
|
+
}
|
|
97035
97846
|
/**
|
|
97036
97847
|
* Represents the body of a document or a section.
|
|
97037
97848
|
*
|
|
@@ -97295,7 +98106,7 @@ declare namespace Word {
|
|
|
97295
98106
|
*/
|
|
97296
98107
|
text?: boolean;
|
|
97297
98108
|
/**
|
|
97298
|
-
* Specifies a value that indicates the comment text's underline type. 'None' if the comment text
|
|
98109
|
+
* Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined.
|
|
97299
98110
|
*
|
|
97300
98111
|
* @remarks
|
|
97301
98112
|
* [Api set: WordApi 1.4]
|
|
@@ -97464,14 +98275,14 @@ declare namespace Word {
|
|
|
97464
98275
|
*/
|
|
97465
98276
|
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
|
|
97466
98277
|
/**
|
|
97467
|
-
* Gets the table that contains the content control. Throws an `ItemNotFound` error if it
|
|
98278
|
+
* Gets the table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table.
|
|
97468
98279
|
*
|
|
97469
98280
|
* @remarks
|
|
97470
98281
|
* [Api set: WordApi 1.3]
|
|
97471
98282
|
*/
|
|
97472
98283
|
parentTable?: Word.Interfaces.TableLoadOptions;
|
|
97473
98284
|
/**
|
|
97474
|
-
* Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it
|
|
98285
|
+
* Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell.
|
|
97475
98286
|
*
|
|
97476
98287
|
* @remarks
|
|
97477
98288
|
* [Api set: WordApi 1.3]
|
|
@@ -97527,7 +98338,9 @@ declare namespace Word {
|
|
|
97527
98338
|
*/
|
|
97528
98339
|
id?: boolean;
|
|
97529
98340
|
/**
|
|
97530
|
-
* Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty.
|
|
98341
|
+
* Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty.
|
|
98342
|
+
|
|
98343
|
+
Note: The set operation for this property isn't supported in Word on the web.
|
|
97531
98344
|
*
|
|
97532
98345
|
* @remarks
|
|
97533
98346
|
* [Api set: WordApi 1.1]
|
|
@@ -97630,14 +98443,14 @@ declare namespace Word {
|
|
|
97630
98443
|
*/
|
|
97631
98444
|
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
|
|
97632
98445
|
/**
|
|
97633
|
-
* For EACH ITEM in the collection: Gets the table that contains the content control. Throws an `ItemNotFound` error if it
|
|
98446
|
+
* For EACH ITEM in the collection: Gets the table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table.
|
|
97634
98447
|
*
|
|
97635
98448
|
* @remarks
|
|
97636
98449
|
* [Api set: WordApi 1.3]
|
|
97637
98450
|
*/
|
|
97638
98451
|
parentTable?: Word.Interfaces.TableLoadOptions;
|
|
97639
98452
|
/**
|
|
97640
|
-
* For EACH ITEM in the collection: Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it
|
|
98453
|
+
* For EACH ITEM in the collection: Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell.
|
|
97641
98454
|
*
|
|
97642
98455
|
* @remarks
|
|
97643
98456
|
* [Api set: WordApi 1.3]
|
|
@@ -97693,7 +98506,9 @@ declare namespace Word {
|
|
|
97693
98506
|
*/
|
|
97694
98507
|
id?: boolean;
|
|
97695
98508
|
/**
|
|
97696
|
-
* For EACH ITEM in the collection: Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty.
|
|
98509
|
+
* For EACH ITEM in the collection: Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty.
|
|
98510
|
+
|
|
98511
|
+
Note: The set operation for this property isn't supported in Word on the web.
|
|
97697
98512
|
*
|
|
97698
98513
|
* @remarks
|
|
97699
98514
|
* [Api set: WordApi 1.1]
|
|
@@ -98137,14 +98952,14 @@ declare namespace Word {
|
|
|
98137
98952
|
*/
|
|
98138
98953
|
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
|
|
98139
98954
|
/**
|
|
98140
|
-
* Gets the table that contains the field. Throws an `ItemNotFound` error if it
|
|
98955
|
+
* Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table.
|
|
98141
98956
|
*
|
|
98142
98957
|
* @remarks
|
|
98143
98958
|
* [Api set: WordApi 1.4]
|
|
98144
98959
|
*/
|
|
98145
98960
|
parentTable?: Word.Interfaces.TableLoadOptions;
|
|
98146
98961
|
/**
|
|
98147
|
-
* Gets the table cell that contains the field. Throws an `ItemNotFound` error if it
|
|
98962
|
+
* Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell.
|
|
98148
98963
|
*
|
|
98149
98964
|
* @remarks
|
|
98150
98965
|
* [Api set: WordApi 1.4]
|
|
@@ -98242,14 +99057,14 @@ declare namespace Word {
|
|
|
98242
99057
|
*/
|
|
98243
99058
|
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
|
|
98244
99059
|
/**
|
|
98245
|
-
* For EACH ITEM in the collection: Gets the table that contains the field. Throws an `ItemNotFound` error if it
|
|
99060
|
+
* For EACH ITEM in the collection: Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table.
|
|
98246
99061
|
*
|
|
98247
99062
|
* @remarks
|
|
98248
99063
|
* [Api set: WordApi 1.4]
|
|
98249
99064
|
*/
|
|
98250
99065
|
parentTable?: Word.Interfaces.TableLoadOptions;
|
|
98251
99066
|
/**
|
|
98252
|
-
* For EACH ITEM in the collection: Gets the table cell that contains the field. Throws an `ItemNotFound` error if it
|
|
99067
|
+
* For EACH ITEM in the collection: Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell.
|
|
98253
99068
|
*
|
|
98254
99069
|
* @remarks
|
|
98255
99070
|
* [Api set: WordApi 1.4]
|
|
@@ -98396,7 +99211,7 @@ declare namespace Word {
|
|
|
98396
99211
|
*/
|
|
98397
99212
|
superscript?: boolean;
|
|
98398
99213
|
/**
|
|
98399
|
-
* Specifies a value that indicates the font's underline type. 'None' if the font
|
|
99214
|
+
* Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined.
|
|
98400
99215
|
*
|
|
98401
99216
|
* @remarks
|
|
98402
99217
|
* [Api set: WordApi 1.1]
|
|
@@ -98415,53 +99230,53 @@ declare namespace Word {
|
|
|
98415
99230
|
*/
|
|
98416
99231
|
$all?: boolean;
|
|
98417
99232
|
/**
|
|
98418
|
-
|
|
98419
|
-
|
|
98420
|
-
|
|
98421
|
-
|
|
98422
|
-
|
|
99233
|
+
* Gets the parent paragraph that contains the inline image.
|
|
99234
|
+
*
|
|
99235
|
+
* @remarks
|
|
99236
|
+
* [Api set: WordApi 1.2]
|
|
99237
|
+
*/
|
|
98423
99238
|
paragraph?: Word.Interfaces.ParagraphLoadOptions;
|
|
98424
99239
|
/**
|
|
98425
|
-
|
|
98426
|
-
|
|
98427
|
-
|
|
98428
|
-
|
|
98429
|
-
|
|
99240
|
+
* Gets the content control that contains the inline image. Throws an `ItemNotFound` error if there isn't a parent content control.
|
|
99241
|
+
*
|
|
99242
|
+
* @remarks
|
|
99243
|
+
* [Api set: WordApi 1.1]
|
|
99244
|
+
*/
|
|
98430
99245
|
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
|
|
98431
99246
|
/**
|
|
98432
|
-
|
|
98433
|
-
|
|
98434
|
-
|
|
98435
|
-
|
|
98436
|
-
|
|
99247
|
+
* Gets the content control that contains the inline image. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
99248
|
+
*
|
|
99249
|
+
* @remarks
|
|
99250
|
+
* [Api set: WordApi 1.3]
|
|
99251
|
+
*/
|
|
98437
99252
|
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
|
|
98438
99253
|
/**
|
|
98439
|
-
|
|
98440
|
-
|
|
98441
|
-
|
|
98442
|
-
|
|
98443
|
-
|
|
99254
|
+
* Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table.
|
|
99255
|
+
*
|
|
99256
|
+
* @remarks
|
|
99257
|
+
* [Api set: WordApi 1.3]
|
|
99258
|
+
*/
|
|
98444
99259
|
parentTable?: Word.Interfaces.TableLoadOptions;
|
|
98445
99260
|
/**
|
|
98446
|
-
|
|
98447
|
-
|
|
98448
|
-
|
|
98449
|
-
|
|
98450
|
-
|
|
99261
|
+
* Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table cell.
|
|
99262
|
+
*
|
|
99263
|
+
* @remarks
|
|
99264
|
+
* [Api set: WordApi 1.3]
|
|
99265
|
+
*/
|
|
98451
99266
|
parentTableCell?: Word.Interfaces.TableCellLoadOptions;
|
|
98452
99267
|
/**
|
|
98453
|
-
|
|
98454
|
-
|
|
98455
|
-
|
|
98456
|
-
|
|
98457
|
-
|
|
99268
|
+
* Gets the table cell that contains the inline image. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
99269
|
+
*
|
|
99270
|
+
* @remarks
|
|
99271
|
+
* [Api set: WordApi 1.3]
|
|
99272
|
+
*/
|
|
98458
99273
|
parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
|
|
98459
99274
|
/**
|
|
98460
|
-
|
|
98461
|
-
|
|
98462
|
-
|
|
98463
|
-
|
|
98464
|
-
|
|
99275
|
+
* Gets the table that contains the inline image. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
99276
|
+
*
|
|
99277
|
+
* @remarks
|
|
99278
|
+
* [Api set: WordApi 1.3]
|
|
99279
|
+
*/
|
|
98465
99280
|
parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
|
|
98466
99281
|
/**
|
|
98467
99282
|
* Specifies a string that represents the alternative text associated with the inline image.
|
|
@@ -98518,53 +99333,53 @@ declare namespace Word {
|
|
|
98518
99333
|
*/
|
|
98519
99334
|
$all?: boolean;
|
|
98520
99335
|
/**
|
|
98521
|
-
|
|
98522
|
-
|
|
98523
|
-
|
|
98524
|
-
|
|
98525
|
-
|
|
99336
|
+
* For EACH ITEM in the collection: Gets the parent paragraph that contains the inline image.
|
|
99337
|
+
*
|
|
99338
|
+
* @remarks
|
|
99339
|
+
* [Api set: WordApi 1.2]
|
|
99340
|
+
*/
|
|
98526
99341
|
paragraph?: Word.Interfaces.ParagraphLoadOptions;
|
|
98527
99342
|
/**
|
|
98528
|
-
|
|
98529
|
-
|
|
98530
|
-
|
|
98531
|
-
|
|
98532
|
-
|
|
99343
|
+
* For EACH ITEM in the collection: Gets the content control that contains the inline image. Throws an `ItemNotFound` error if there isn't a parent content control.
|
|
99344
|
+
*
|
|
99345
|
+
* @remarks
|
|
99346
|
+
* [Api set: WordApi 1.1]
|
|
99347
|
+
*/
|
|
98533
99348
|
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
|
|
98534
99349
|
/**
|
|
98535
|
-
|
|
98536
|
-
|
|
98537
|
-
|
|
98538
|
-
|
|
98539
|
-
|
|
99350
|
+
* For EACH ITEM in the collection: Gets the content control that contains the inline image. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
99351
|
+
*
|
|
99352
|
+
* @remarks
|
|
99353
|
+
* [Api set: WordApi 1.3]
|
|
99354
|
+
*/
|
|
98540
99355
|
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
|
|
98541
99356
|
/**
|
|
98542
|
-
|
|
98543
|
-
|
|
98544
|
-
|
|
98545
|
-
|
|
98546
|
-
|
|
99357
|
+
* For EACH ITEM in the collection: Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table.
|
|
99358
|
+
*
|
|
99359
|
+
* @remarks
|
|
99360
|
+
* [Api set: WordApi 1.3]
|
|
99361
|
+
*/
|
|
98547
99362
|
parentTable?: Word.Interfaces.TableLoadOptions;
|
|
98548
99363
|
/**
|
|
98549
|
-
|
|
98550
|
-
|
|
98551
|
-
|
|
98552
|
-
|
|
98553
|
-
|
|
99364
|
+
* For EACH ITEM in the collection: Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table cell.
|
|
99365
|
+
*
|
|
99366
|
+
* @remarks
|
|
99367
|
+
* [Api set: WordApi 1.3]
|
|
99368
|
+
*/
|
|
98554
99369
|
parentTableCell?: Word.Interfaces.TableCellLoadOptions;
|
|
98555
99370
|
/**
|
|
98556
|
-
|
|
98557
|
-
|
|
98558
|
-
|
|
98559
|
-
|
|
98560
|
-
|
|
99371
|
+
* For EACH ITEM in the collection: Gets the table cell that contains the inline image. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
99372
|
+
*
|
|
99373
|
+
* @remarks
|
|
99374
|
+
* [Api set: WordApi 1.3]
|
|
99375
|
+
*/
|
|
98561
99376
|
parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
|
|
98562
99377
|
/**
|
|
98563
|
-
|
|
98564
|
-
|
|
98565
|
-
|
|
98566
|
-
|
|
98567
|
-
|
|
99378
|
+
* For EACH ITEM in the collection: Gets the table that contains the inline image. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
99379
|
+
*
|
|
99380
|
+
* @remarks
|
|
99381
|
+
* [Api set: WordApi 1.3]
|
|
99382
|
+
*/
|
|
98568
99383
|
parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
|
|
98569
99384
|
/**
|
|
98570
99385
|
* For EACH ITEM in the collection: Specifies a string that represents the alternative text associated with the inline image.
|
|
@@ -98786,88 +99601,88 @@ declare namespace Word {
|
|
|
98786
99601
|
*/
|
|
98787
99602
|
$all?: boolean;
|
|
98788
99603
|
/**
|
|
98789
|
-
|
|
98790
|
-
|
|
98791
|
-
|
|
98792
|
-
|
|
98793
|
-
|
|
99604
|
+
* Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties.
|
|
99605
|
+
*
|
|
99606
|
+
* @remarks
|
|
99607
|
+
* [Api set: WordApi 1.1]
|
|
99608
|
+
*/
|
|
98794
99609
|
font?: Word.Interfaces.FontLoadOptions;
|
|
98795
99610
|
/**
|
|
98796
|
-
|
|
98797
|
-
|
|
98798
|
-
|
|
98799
|
-
|
|
98800
|
-
|
|
99611
|
+
* Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list.
|
|
99612
|
+
*
|
|
99613
|
+
* @remarks
|
|
99614
|
+
* [Api set: WordApi 1.3]
|
|
99615
|
+
*/
|
|
98801
99616
|
list?: Word.Interfaces.ListLoadOptions;
|
|
98802
99617
|
/**
|
|
98803
|
-
|
|
98804
|
-
|
|
98805
|
-
|
|
98806
|
-
|
|
98807
|
-
|
|
99618
|
+
* Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list.
|
|
99619
|
+
*
|
|
99620
|
+
* @remarks
|
|
99621
|
+
* [Api set: WordApi 1.3]
|
|
99622
|
+
*/
|
|
98808
99623
|
listItem?: Word.Interfaces.ListItemLoadOptions;
|
|
98809
99624
|
/**
|
|
98810
|
-
|
|
98811
|
-
|
|
98812
|
-
|
|
98813
|
-
|
|
98814
|
-
|
|
99625
|
+
* Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
99626
|
+
*
|
|
99627
|
+
* @remarks
|
|
99628
|
+
* [Api set: WordApi 1.3]
|
|
99629
|
+
*/
|
|
98815
99630
|
listItemOrNullObject?: Word.Interfaces.ListItemLoadOptions;
|
|
98816
99631
|
/**
|
|
98817
|
-
|
|
98818
|
-
|
|
98819
|
-
|
|
98820
|
-
|
|
98821
|
-
|
|
99632
|
+
* Gets the List to which this paragraph belongs. If the paragraph isn't in a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
99633
|
+
*
|
|
99634
|
+
* @remarks
|
|
99635
|
+
* [Api set: WordApi 1.3]
|
|
99636
|
+
*/
|
|
98822
99637
|
listOrNullObject?: Word.Interfaces.ListLoadOptions;
|
|
98823
99638
|
/**
|
|
98824
|
-
|
|
98825
|
-
|
|
98826
|
-
|
|
98827
|
-
|
|
98828
|
-
|
|
99639
|
+
* Gets the parent body of the paragraph.
|
|
99640
|
+
*
|
|
99641
|
+
* @remarks
|
|
99642
|
+
* [Api set: WordApi 1.3]
|
|
99643
|
+
*/
|
|
98829
99644
|
parentBody?: Word.Interfaces.BodyLoadOptions;
|
|
98830
99645
|
/**
|
|
98831
|
-
|
|
98832
|
-
|
|
98833
|
-
|
|
98834
|
-
|
|
98835
|
-
|
|
99646
|
+
* Gets the content control that contains the paragraph. Throws an `ItemNotFound` error if there isn't a parent content control.
|
|
99647
|
+
*
|
|
99648
|
+
* @remarks
|
|
99649
|
+
* [Api set: WordApi 1.1]
|
|
99650
|
+
*/
|
|
98836
99651
|
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
|
|
98837
99652
|
/**
|
|
98838
|
-
|
|
98839
|
-
|
|
98840
|
-
|
|
98841
|
-
|
|
98842
|
-
|
|
99653
|
+
* Gets the content control that contains the paragraph. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
99654
|
+
*
|
|
99655
|
+
* @remarks
|
|
99656
|
+
* [Api set: WordApi 1.3]
|
|
99657
|
+
*/
|
|
98843
99658
|
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
|
|
98844
99659
|
/**
|
|
98845
|
-
|
|
98846
|
-
|
|
98847
|
-
|
|
98848
|
-
|
|
98849
|
-
|
|
99660
|
+
* Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table.
|
|
99661
|
+
*
|
|
99662
|
+
* @remarks
|
|
99663
|
+
* [Api set: WordApi 1.3]
|
|
99664
|
+
*/
|
|
98850
99665
|
parentTable?: Word.Interfaces.TableLoadOptions;
|
|
98851
99666
|
/**
|
|
98852
|
-
|
|
98853
|
-
|
|
98854
|
-
|
|
98855
|
-
|
|
98856
|
-
|
|
99667
|
+
* Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell.
|
|
99668
|
+
*
|
|
99669
|
+
* @remarks
|
|
99670
|
+
* [Api set: WordApi 1.3]
|
|
99671
|
+
*/
|
|
98857
99672
|
parentTableCell?: Word.Interfaces.TableCellLoadOptions;
|
|
98858
99673
|
/**
|
|
98859
|
-
|
|
98860
|
-
|
|
98861
|
-
|
|
98862
|
-
|
|
98863
|
-
|
|
99674
|
+
* Gets the table cell that contains the paragraph. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
99675
|
+
*
|
|
99676
|
+
* @remarks
|
|
99677
|
+
* [Api set: WordApi 1.3]
|
|
99678
|
+
*/
|
|
98864
99679
|
parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
|
|
98865
99680
|
/**
|
|
98866
|
-
|
|
98867
|
-
|
|
98868
|
-
|
|
98869
|
-
|
|
98870
|
-
|
|
99681
|
+
* Gets the table that contains the paragraph. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
99682
|
+
*
|
|
99683
|
+
* @remarks
|
|
99684
|
+
* [Api set: WordApi 1.3]
|
|
99685
|
+
*/
|
|
98871
99686
|
parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
|
|
98872
99687
|
/**
|
|
98873
99688
|
* Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'.
|
|
@@ -98968,7 +99783,7 @@ declare namespace Word {
|
|
|
98968
99783
|
*/
|
|
98969
99784
|
styleBuiltIn?: boolean;
|
|
98970
99785
|
/**
|
|
98971
|
-
* Gets the level of the paragraph's table. It returns 0 if the paragraph
|
|
99786
|
+
* Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table.
|
|
98972
99787
|
*
|
|
98973
99788
|
* @remarks
|
|
98974
99789
|
* [Api set: WordApi 1.3]
|
|
@@ -98981,6 +99796,13 @@ declare namespace Word {
|
|
|
98981
99796
|
* [Api set: WordApi 1.1]
|
|
98982
99797
|
*/
|
|
98983
99798
|
text?: boolean;
|
|
99799
|
+
/**
|
|
99800
|
+
* Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors.
|
|
99801
|
+
*
|
|
99802
|
+
* @remarks
|
|
99803
|
+
* [Api set: WordApi 1.6]
|
|
99804
|
+
*/
|
|
99805
|
+
uniqueLocalId?: boolean;
|
|
98984
99806
|
}
|
|
98985
99807
|
/**
|
|
98986
99808
|
* Contains a collection of {@link Word.Paragraph} objects.
|
|
@@ -99001,14 +99823,14 @@ declare namespace Word {
|
|
|
99001
99823
|
*/
|
|
99002
99824
|
font?: Word.Interfaces.FontLoadOptions;
|
|
99003
99825
|
/**
|
|
99004
|
-
* For EACH ITEM in the collection: Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph
|
|
99826
|
+
* For EACH ITEM in the collection: Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list.
|
|
99005
99827
|
*
|
|
99006
99828
|
* @remarks
|
|
99007
99829
|
* [Api set: WordApi 1.3]
|
|
99008
99830
|
*/
|
|
99009
99831
|
list?: Word.Interfaces.ListLoadOptions;
|
|
99010
99832
|
/**
|
|
99011
|
-
* For EACH ITEM in the collection: Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph
|
|
99833
|
+
* For EACH ITEM in the collection: Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list.
|
|
99012
99834
|
*
|
|
99013
99835
|
* @remarks
|
|
99014
99836
|
* [Api set: WordApi 1.3]
|
|
@@ -99050,14 +99872,14 @@ declare namespace Word {
|
|
|
99050
99872
|
*/
|
|
99051
99873
|
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
|
|
99052
99874
|
/**
|
|
99053
|
-
* For EACH ITEM in the collection: Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it
|
|
99875
|
+
* For EACH ITEM in the collection: Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table.
|
|
99054
99876
|
*
|
|
99055
99877
|
* @remarks
|
|
99056
99878
|
* [Api set: WordApi 1.3]
|
|
99057
99879
|
*/
|
|
99058
99880
|
parentTable?: Word.Interfaces.TableLoadOptions;
|
|
99059
99881
|
/**
|
|
99060
|
-
* For EACH ITEM in the collection: Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it
|
|
99882
|
+
* For EACH ITEM in the collection: Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell.
|
|
99061
99883
|
*
|
|
99062
99884
|
* @remarks
|
|
99063
99885
|
* [Api set: WordApi 1.3]
|
|
@@ -99176,7 +99998,7 @@ declare namespace Word {
|
|
|
99176
99998
|
*/
|
|
99177
99999
|
styleBuiltIn?: boolean;
|
|
99178
100000
|
/**
|
|
99179
|
-
* For EACH ITEM in the collection: Gets the level of the paragraph's table. It returns 0 if the paragraph
|
|
100001
|
+
* For EACH ITEM in the collection: Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table.
|
|
99180
100002
|
*
|
|
99181
100003
|
* @remarks
|
|
99182
100004
|
* [Api set: WordApi 1.3]
|
|
@@ -99189,6 +100011,13 @@ declare namespace Word {
|
|
|
99189
100011
|
* [Api set: WordApi 1.1]
|
|
99190
100012
|
*/
|
|
99191
100013
|
text?: boolean;
|
|
100014
|
+
/**
|
|
100015
|
+
* For EACH ITEM in the collection: Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors.
|
|
100016
|
+
*
|
|
100017
|
+
* @remarks
|
|
100018
|
+
* [Api set: WordApi 1.6]
|
|
100019
|
+
*/
|
|
100020
|
+
uniqueLocalId?: boolean;
|
|
99192
100021
|
}
|
|
99193
100022
|
/**
|
|
99194
100023
|
* Represents a style of paragraph in a document.
|
|
@@ -99340,14 +100169,14 @@ declare namespace Word {
|
|
|
99340
100169
|
*/
|
|
99341
100170
|
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
|
|
99342
100171
|
/**
|
|
99343
|
-
* Gets the table that contains the range. Throws an `ItemNotFound` error if it
|
|
100172
|
+
* Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table.
|
|
99344
100173
|
*
|
|
99345
100174
|
* @remarks
|
|
99346
100175
|
* [Api set: WordApi 1.3]
|
|
99347
100176
|
*/
|
|
99348
100177
|
parentTable?: Word.Interfaces.TableLoadOptions;
|
|
99349
100178
|
/**
|
|
99350
|
-
* Gets the table cell that contains the range. Throws an `ItemNotFound` error if it
|
|
100179
|
+
* Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell.
|
|
99351
100180
|
*
|
|
99352
100181
|
* @remarks
|
|
99353
100182
|
* [Api set: WordApi 1.3]
|
|
@@ -99443,14 +100272,14 @@ declare namespace Word {
|
|
|
99443
100272
|
*/
|
|
99444
100273
|
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
|
|
99445
100274
|
/**
|
|
99446
|
-
* For EACH ITEM in the collection: Gets the table that contains the range. Throws an `ItemNotFound` error if it
|
|
100275
|
+
* For EACH ITEM in the collection: Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table.
|
|
99447
100276
|
*
|
|
99448
100277
|
* @remarks
|
|
99449
100278
|
* [Api set: WordApi 1.3]
|
|
99450
100279
|
*/
|
|
99451
100280
|
parentTable?: Word.Interfaces.TableLoadOptions;
|
|
99452
100281
|
/**
|
|
99453
|
-
* For EACH ITEM in the collection: Gets the table cell that contains the range. Throws an `ItemNotFound` error if it
|
|
100282
|
+
* For EACH ITEM in the collection: Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell.
|
|
99454
100283
|
*
|
|
99455
100284
|
* @remarks
|
|
99456
100285
|
* [Api set: WordApi 1.3]
|
|
@@ -99580,7 +100409,7 @@ declare namespace Word {
|
|
|
99580
100409
|
*/
|
|
99581
100410
|
$all?: boolean;
|
|
99582
100411
|
/**
|
|
99583
|
-
* Gets the body object of the section. This
|
|
100412
|
+
* Gets the body object of the section. This doesn't include the header/footer and other section metadata.
|
|
99584
100413
|
*
|
|
99585
100414
|
* @remarks
|
|
99586
100415
|
* [Api set: WordApi 1.1]
|
|
@@ -99599,7 +100428,7 @@ declare namespace Word {
|
|
|
99599
100428
|
*/
|
|
99600
100429
|
$all?: boolean;
|
|
99601
100430
|
/**
|
|
99602
|
-
* For EACH ITEM in the collection: Gets the body object of the section. This
|
|
100431
|
+
* For EACH ITEM in the collection: Gets the body object of the section. This doesn't include the header/footer and other section metadata.
|
|
99603
100432
|
*
|
|
99604
100433
|
* @remarks
|
|
99605
100434
|
* [Api set: WordApi 1.1]
|
|
@@ -99684,10 +100513,26 @@ declare namespace Word {
|
|
|
99684
100513
|
*/
|
|
99685
100514
|
paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions;
|
|
99686
100515
|
/**
|
|
99687
|
-
|
|
100516
|
+
* For EACH ITEM in the collection: Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
|
|
100517
|
+
*
|
|
100518
|
+
* @remarks
|
|
100519
|
+
* [Api set: WordApi 1.6]
|
|
100520
|
+
*/
|
|
100521
|
+
shading?: Word.Interfaces.ShadingLoadOptions;
|
|
100522
|
+
/**
|
|
100523
|
+
* For EACH ITEM in the collection: Gets a TableStyle object representing Style properties that can be applied to a table.
|
|
100524
|
+
*
|
|
100525
|
+
* @remarks
|
|
100526
|
+
* [Api set: WordApi 1.6]
|
|
100527
|
+
*/
|
|
100528
|
+
tableStyle?: Word.Interfaces.TableStyleLoadOptions;
|
|
100529
|
+
/**
|
|
100530
|
+
* For EACH ITEM in the collection: Specifies the name of an existing style to use as the base formatting of another style.
|
|
99688
100531
|
*
|
|
99689
100532
|
* @remarks
|
|
99690
100533
|
* [Api set: WordApi 1.5]
|
|
100534
|
+
*
|
|
100535
|
+
* Note: The ability to set `baseStyle` was introduced in WordApi 1.6.
|
|
99691
100536
|
*/
|
|
99692
100537
|
baseStyle?: boolean;
|
|
99693
100538
|
/**
|
|
@@ -99719,10 +100564,12 @@ declare namespace Word {
|
|
|
99719
100564
|
*/
|
|
99720
100565
|
nameLocal?: boolean;
|
|
99721
100566
|
/**
|
|
99722
|
-
* For EACH ITEM in the collection:
|
|
100567
|
+
* For EACH ITEM in the collection: Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style.
|
|
99723
100568
|
*
|
|
99724
100569
|
* @remarks
|
|
99725
100570
|
* [Api set: WordApi 1.5]
|
|
100571
|
+
*
|
|
100572
|
+
* Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6.
|
|
99726
100573
|
*/
|
|
99727
100574
|
nextParagraphStyle?: boolean;
|
|
99728
100575
|
/**
|
|
@@ -99773,24 +100620,40 @@ declare namespace Word {
|
|
|
99773
100620
|
*/
|
|
99774
100621
|
$all?: boolean;
|
|
99775
100622
|
/**
|
|
99776
|
-
|
|
99777
|
-
|
|
99778
|
-
|
|
99779
|
-
|
|
99780
|
-
|
|
100623
|
+
* Gets a font object that represents the character formatting of the specified style.
|
|
100624
|
+
*
|
|
100625
|
+
* @remarks
|
|
100626
|
+
* [Api set: WordApi 1.5]
|
|
100627
|
+
*/
|
|
99781
100628
|
font?: Word.Interfaces.FontLoadOptions;
|
|
99782
100629
|
/**
|
|
99783
|
-
|
|
99784
|
-
|
|
99785
|
-
|
|
99786
|
-
|
|
99787
|
-
|
|
100630
|
+
* Gets a ParagraphFormat object that represents the paragraph settings for the specified style.
|
|
100631
|
+
*
|
|
100632
|
+
* @remarks
|
|
100633
|
+
* [Api set: WordApi 1.5]
|
|
100634
|
+
*/
|
|
99788
100635
|
paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions;
|
|
99789
100636
|
/**
|
|
99790
|
-
* Gets
|
|
100637
|
+
* Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
|
|
100638
|
+
*
|
|
100639
|
+
* @remarks
|
|
100640
|
+
* [Api set: WordApi 1.6]
|
|
100641
|
+
*/
|
|
100642
|
+
shading?: Word.Interfaces.ShadingLoadOptions;
|
|
100643
|
+
/**
|
|
100644
|
+
* Gets a TableStyle object representing Style properties that can be applied to a table.
|
|
100645
|
+
*
|
|
100646
|
+
* @remarks
|
|
100647
|
+
* [Api set: WordApi 1.6]
|
|
100648
|
+
*/
|
|
100649
|
+
tableStyle?: Word.Interfaces.TableStyleLoadOptions;
|
|
100650
|
+
/**
|
|
100651
|
+
* Specifies the name of an existing style to use as the base formatting of another style.
|
|
99791
100652
|
*
|
|
99792
100653
|
* @remarks
|
|
99793
100654
|
* [Api set: WordApi 1.5]
|
|
100655
|
+
*
|
|
100656
|
+
* Note: The ability to set `baseStyle` was introduced in WordApi 1.6.
|
|
99794
100657
|
*/
|
|
99795
100658
|
baseStyle?: boolean;
|
|
99796
100659
|
/**
|
|
@@ -99822,10 +100685,12 @@ declare namespace Word {
|
|
|
99822
100685
|
*/
|
|
99823
100686
|
nameLocal?: boolean;
|
|
99824
100687
|
/**
|
|
99825
|
-
*
|
|
100688
|
+
* Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style.
|
|
99826
100689
|
*
|
|
99827
100690
|
* @remarks
|
|
99828
100691
|
* [Api set: WordApi 1.5]
|
|
100692
|
+
*
|
|
100693
|
+
* Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6.
|
|
99829
100694
|
*/
|
|
99830
100695
|
nextParagraphStyle?: boolean;
|
|
99831
100696
|
/**
|
|
@@ -99864,6 +100729,25 @@ declare namespace Word {
|
|
|
99864
100729
|
*/
|
|
99865
100730
|
visibility?: boolean;
|
|
99866
100731
|
}
|
|
100732
|
+
/**
|
|
100733
|
+
* Represents the shading object.
|
|
100734
|
+
*
|
|
100735
|
+
* @remarks
|
|
100736
|
+
* [Api set: WordApi 1.6]
|
|
100737
|
+
*/
|
|
100738
|
+
interface ShadingLoadOptions {
|
|
100739
|
+
/**
|
|
100740
|
+
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`).
|
|
100741
|
+
*/
|
|
100742
|
+
$all?: boolean;
|
|
100743
|
+
/**
|
|
100744
|
+
* Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name.
|
|
100745
|
+
*
|
|
100746
|
+
* @remarks
|
|
100747
|
+
* [Api set: WordApi 1.6]
|
|
100748
|
+
*/
|
|
100749
|
+
backgroundPatternColor?: boolean;
|
|
100750
|
+
}
|
|
99867
100751
|
/**
|
|
99868
100752
|
* Represents a table in a Word document.
|
|
99869
100753
|
*
|
|
@@ -99876,60 +100760,60 @@ declare namespace Word {
|
|
|
99876
100760
|
*/
|
|
99877
100761
|
$all?: boolean;
|
|
99878
100762
|
/**
|
|
99879
|
-
|
|
99880
|
-
|
|
99881
|
-
|
|
99882
|
-
|
|
99883
|
-
|
|
100763
|
+
* Gets the font. Use this to get and set font name, size, color, and other properties.
|
|
100764
|
+
*
|
|
100765
|
+
* @remarks
|
|
100766
|
+
* [Api set: WordApi 1.3]
|
|
100767
|
+
*/
|
|
99884
100768
|
font?: Word.Interfaces.FontLoadOptions;
|
|
99885
100769
|
/**
|
|
99886
|
-
|
|
99887
|
-
|
|
99888
|
-
|
|
99889
|
-
|
|
99890
|
-
|
|
100770
|
+
* Gets the parent body of the table.
|
|
100771
|
+
*
|
|
100772
|
+
* @remarks
|
|
100773
|
+
* [Api set: WordApi 1.3]
|
|
100774
|
+
*/
|
|
99891
100775
|
parentBody?: Word.Interfaces.BodyLoadOptions;
|
|
99892
100776
|
/**
|
|
99893
|
-
|
|
99894
|
-
|
|
99895
|
-
|
|
99896
|
-
|
|
99897
|
-
|
|
100777
|
+
* Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control.
|
|
100778
|
+
*
|
|
100779
|
+
* @remarks
|
|
100780
|
+
* [Api set: WordApi 1.3]
|
|
100781
|
+
*/
|
|
99898
100782
|
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
|
|
99899
100783
|
/**
|
|
99900
|
-
|
|
99901
|
-
|
|
99902
|
-
|
|
99903
|
-
|
|
99904
|
-
|
|
100784
|
+
* Gets the content control that contains the table. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
100785
|
+
*
|
|
100786
|
+
* @remarks
|
|
100787
|
+
* [Api set: WordApi 1.3]
|
|
100788
|
+
*/
|
|
99905
100789
|
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
|
|
99906
100790
|
/**
|
|
99907
|
-
|
|
99908
|
-
|
|
99909
|
-
|
|
99910
|
-
|
|
99911
|
-
|
|
100791
|
+
* Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table.
|
|
100792
|
+
*
|
|
100793
|
+
* @remarks
|
|
100794
|
+
* [Api set: WordApi 1.3]
|
|
100795
|
+
*/
|
|
99912
100796
|
parentTable?: Word.Interfaces.TableLoadOptions;
|
|
99913
100797
|
/**
|
|
99914
|
-
|
|
99915
|
-
|
|
99916
|
-
|
|
99917
|
-
|
|
99918
|
-
|
|
100798
|
+
* Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell.
|
|
100799
|
+
*
|
|
100800
|
+
* @remarks
|
|
100801
|
+
* [Api set: WordApi 1.3]
|
|
100802
|
+
*/
|
|
99919
100803
|
parentTableCell?: Word.Interfaces.TableCellLoadOptions;
|
|
99920
100804
|
/**
|
|
99921
|
-
|
|
99922
|
-
|
|
99923
|
-
|
|
99924
|
-
|
|
99925
|
-
|
|
100805
|
+
* Gets the table cell that contains this table. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
100806
|
+
*
|
|
100807
|
+
* @remarks
|
|
100808
|
+
* [Api set: WordApi 1.3]
|
|
100809
|
+
*/
|
|
99926
100810
|
parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
|
|
99927
100811
|
/**
|
|
99928
|
-
|
|
99929
|
-
|
|
99930
|
-
|
|
99931
|
-
|
|
99932
|
-
|
|
100812
|
+
* Gets the table that contains this table. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
100813
|
+
*
|
|
100814
|
+
* @remarks
|
|
100815
|
+
* [Api set: WordApi 1.3]
|
|
100816
|
+
*/
|
|
99933
100817
|
parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
|
|
99934
100818
|
/**
|
|
99935
100819
|
* Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'.
|
|
@@ -100051,6 +100935,53 @@ declare namespace Word {
|
|
|
100051
100935
|
*/
|
|
100052
100936
|
width?: boolean;
|
|
100053
100937
|
}
|
|
100938
|
+
/**
|
|
100939
|
+
* Represents the TableStyle object.
|
|
100940
|
+
*
|
|
100941
|
+
* @remarks
|
|
100942
|
+
* [Api set: WordApi 1.6]
|
|
100943
|
+
*/
|
|
100944
|
+
interface TableStyleLoadOptions {
|
|
100945
|
+
/**
|
|
100946
|
+
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`).
|
|
100947
|
+
*/
|
|
100948
|
+
$all?: boolean;
|
|
100949
|
+
/**
|
|
100950
|
+
* Specifies the amount of space to add between the contents and the bottom borders of the cells.
|
|
100951
|
+
*
|
|
100952
|
+
* @remarks
|
|
100953
|
+
* [Api set: WordApi 1.6]
|
|
100954
|
+
*/
|
|
100955
|
+
bottomCellMargin?: boolean;
|
|
100956
|
+
/**
|
|
100957
|
+
* Specifies the spacing (in points) between the cells in a table style.
|
|
100958
|
+
*
|
|
100959
|
+
* @remarks
|
|
100960
|
+
* [Api set: WordApi 1.6]
|
|
100961
|
+
*/
|
|
100962
|
+
cellSpacing?: boolean;
|
|
100963
|
+
/**
|
|
100964
|
+
* Specifies the amount of space to add between the contents and the left borders of the cells.
|
|
100965
|
+
*
|
|
100966
|
+
* @remarks
|
|
100967
|
+
* [Api set: WordApi 1.6]
|
|
100968
|
+
*/
|
|
100969
|
+
leftCellMargin?: boolean;
|
|
100970
|
+
/**
|
|
100971
|
+
* Specifies the amount of space to add between the contents and the right borders of the cells.
|
|
100972
|
+
*
|
|
100973
|
+
* @remarks
|
|
100974
|
+
* [Api set: WordApi 1.6]
|
|
100975
|
+
*/
|
|
100976
|
+
rightCellMargin?: boolean;
|
|
100977
|
+
/**
|
|
100978
|
+
* Specifies the amount of space to add between the contents and the top borders of the cells.
|
|
100979
|
+
*
|
|
100980
|
+
* @remarks
|
|
100981
|
+
* [Api set: WordApi 1.6]
|
|
100982
|
+
*/
|
|
100983
|
+
topCellMargin?: boolean;
|
|
100984
|
+
}
|
|
100054
100985
|
/**
|
|
100055
100986
|
* Contains the collection of the document's Table objects.
|
|
100056
100987
|
*
|
|
@@ -100063,60 +100994,60 @@ declare namespace Word {
|
|
|
100063
100994
|
*/
|
|
100064
100995
|
$all?: boolean;
|
|
100065
100996
|
/**
|
|
100066
|
-
|
|
100067
|
-
|
|
100068
|
-
|
|
100069
|
-
|
|
100070
|
-
|
|
100997
|
+
* For EACH ITEM in the collection: Gets the font. Use this to get and set font name, size, color, and other properties.
|
|
100998
|
+
*
|
|
100999
|
+
* @remarks
|
|
101000
|
+
* [Api set: WordApi 1.3]
|
|
101001
|
+
*/
|
|
100071
101002
|
font?: Word.Interfaces.FontLoadOptions;
|
|
100072
101003
|
/**
|
|
100073
|
-
|
|
100074
|
-
|
|
100075
|
-
|
|
100076
|
-
|
|
100077
|
-
|
|
101004
|
+
* For EACH ITEM in the collection: Gets the parent body of the table.
|
|
101005
|
+
*
|
|
101006
|
+
* @remarks
|
|
101007
|
+
* [Api set: WordApi 1.3]
|
|
101008
|
+
*/
|
|
100078
101009
|
parentBody?: Word.Interfaces.BodyLoadOptions;
|
|
100079
101010
|
/**
|
|
100080
|
-
|
|
100081
|
-
|
|
100082
|
-
|
|
100083
|
-
|
|
100084
|
-
|
|
101011
|
+
* For EACH ITEM in the collection: Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control.
|
|
101012
|
+
*
|
|
101013
|
+
* @remarks
|
|
101014
|
+
* [Api set: WordApi 1.3]
|
|
101015
|
+
*/
|
|
100085
101016
|
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
|
|
100086
101017
|
/**
|
|
100087
|
-
|
|
100088
|
-
|
|
100089
|
-
|
|
100090
|
-
|
|
100091
|
-
|
|
101018
|
+
* For EACH ITEM in the collection: Gets the content control that contains the table. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
101019
|
+
*
|
|
101020
|
+
* @remarks
|
|
101021
|
+
* [Api set: WordApi 1.3]
|
|
101022
|
+
*/
|
|
100092
101023
|
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
|
|
100093
101024
|
/**
|
|
100094
|
-
|
|
100095
|
-
|
|
100096
|
-
|
|
100097
|
-
|
|
100098
|
-
|
|
101025
|
+
* For EACH ITEM in the collection: Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table.
|
|
101026
|
+
*
|
|
101027
|
+
* @remarks
|
|
101028
|
+
* [Api set: WordApi 1.3]
|
|
101029
|
+
*/
|
|
100099
101030
|
parentTable?: Word.Interfaces.TableLoadOptions;
|
|
100100
101031
|
/**
|
|
100101
|
-
|
|
100102
|
-
|
|
100103
|
-
|
|
100104
|
-
|
|
100105
|
-
|
|
101032
|
+
* For EACH ITEM in the collection: Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell.
|
|
101033
|
+
*
|
|
101034
|
+
* @remarks
|
|
101035
|
+
* [Api set: WordApi 1.3]
|
|
101036
|
+
*/
|
|
100106
101037
|
parentTableCell?: Word.Interfaces.TableCellLoadOptions;
|
|
100107
101038
|
/**
|
|
100108
|
-
|
|
100109
|
-
|
|
100110
|
-
|
|
100111
|
-
|
|
100112
|
-
|
|
101039
|
+
* For EACH ITEM in the collection: Gets the table cell that contains this table. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
101040
|
+
*
|
|
101041
|
+
* @remarks
|
|
101042
|
+
* [Api set: WordApi 1.3]
|
|
101043
|
+
*/
|
|
100113
101044
|
parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
|
|
100114
101045
|
/**
|
|
100115
|
-
|
|
100116
|
-
|
|
100117
|
-
|
|
100118
|
-
|
|
100119
|
-
|
|
101046
|
+
* For EACH ITEM in the collection: Gets the table that contains this table. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
101047
|
+
*
|
|
101048
|
+
* @remarks
|
|
101049
|
+
* [Api set: WordApi 1.3]
|
|
101050
|
+
*/
|
|
100120
101051
|
parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
|
|
100121
101052
|
/**
|
|
100122
101053
|
* For EACH ITEM in the collection: Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'.
|
|
@@ -100613,6 +101544,86 @@ declare namespace Word {
|
|
|
100613
101544
|
*/
|
|
100614
101545
|
width?: boolean;
|
|
100615
101546
|
}
|
|
101547
|
+
/**
|
|
101548
|
+
* Represents a tracked change in a Word document.
|
|
101549
|
+
*
|
|
101550
|
+
* @remarks
|
|
101551
|
+
* [Api set: WordApi 1.6]
|
|
101552
|
+
*/
|
|
101553
|
+
interface TrackedChangeLoadOptions {
|
|
101554
|
+
/**
|
|
101555
|
+
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`).
|
|
101556
|
+
*/
|
|
101557
|
+
$all?: boolean;
|
|
101558
|
+
/**
|
|
101559
|
+
* Gets the author of the tracked change.
|
|
101560
|
+
*
|
|
101561
|
+
* @remarks
|
|
101562
|
+
* [Api set: WordApi 1.6]
|
|
101563
|
+
*/
|
|
101564
|
+
author?: boolean;
|
|
101565
|
+
/**
|
|
101566
|
+
* Gets the date of the tracked change.
|
|
101567
|
+
*
|
|
101568
|
+
* @remarks
|
|
101569
|
+
* [Api set: WordApi 1.6]
|
|
101570
|
+
*/
|
|
101571
|
+
date?: boolean;
|
|
101572
|
+
/**
|
|
101573
|
+
* Gets the text of the tracked change.
|
|
101574
|
+
*
|
|
101575
|
+
* @remarks
|
|
101576
|
+
* [Api set: WordApi 1.6]
|
|
101577
|
+
*/
|
|
101578
|
+
text?: boolean;
|
|
101579
|
+
/**
|
|
101580
|
+
* Gets the type of the tracked change.
|
|
101581
|
+
*
|
|
101582
|
+
* @remarks
|
|
101583
|
+
* [Api set: WordApi 1.6]
|
|
101584
|
+
*/
|
|
101585
|
+
type?: boolean;
|
|
101586
|
+
}
|
|
101587
|
+
/**
|
|
101588
|
+
* Contains a collection of {@link Word.TrackedChange} objects.
|
|
101589
|
+
*
|
|
101590
|
+
* @remarks
|
|
101591
|
+
* [Api set: WordApi 1.6]
|
|
101592
|
+
*/
|
|
101593
|
+
interface TrackedChangeCollectionLoadOptions {
|
|
101594
|
+
/**
|
|
101595
|
+
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`).
|
|
101596
|
+
*/
|
|
101597
|
+
$all?: boolean;
|
|
101598
|
+
/**
|
|
101599
|
+
* For EACH ITEM in the collection: Gets the author of the tracked change.
|
|
101600
|
+
*
|
|
101601
|
+
* @remarks
|
|
101602
|
+
* [Api set: WordApi 1.6]
|
|
101603
|
+
*/
|
|
101604
|
+
author?: boolean;
|
|
101605
|
+
/**
|
|
101606
|
+
* For EACH ITEM in the collection: Gets the date of the tracked change.
|
|
101607
|
+
*
|
|
101608
|
+
* @remarks
|
|
101609
|
+
* [Api set: WordApi 1.6]
|
|
101610
|
+
*/
|
|
101611
|
+
date?: boolean;
|
|
101612
|
+
/**
|
|
101613
|
+
* For EACH ITEM in the collection: Gets the text of the tracked change.
|
|
101614
|
+
*
|
|
101615
|
+
* @remarks
|
|
101616
|
+
* [Api set: WordApi 1.6]
|
|
101617
|
+
*/
|
|
101618
|
+
text?: boolean;
|
|
101619
|
+
/**
|
|
101620
|
+
* For EACH ITEM in the collection: Gets the type of the tracked change.
|
|
101621
|
+
*
|
|
101622
|
+
* @remarks
|
|
101623
|
+
* [Api set: WordApi 1.6]
|
|
101624
|
+
*/
|
|
101625
|
+
type?: boolean;
|
|
101626
|
+
}
|
|
100616
101627
|
}
|
|
100617
101628
|
}
|
|
100618
101629
|
declare namespace Word {
|