@types/office-js-preview 1.0.431 → 1.0.433
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- office-js-preview/README.md +1 -1
- office-js-preview/index.d.ts +827 -1015
- office-js-preview/package.json +2 -2
office-js-preview/index.d.ts
CHANGED
|
@@ -19804,7 +19804,7 @@ declare namespace Office {
|
|
|
19804
19804
|
*/
|
|
19805
19805
|
owner: string;
|
|
19806
19806
|
/**
|
|
19807
|
-
* The REST API's base URL (currently https://outlook.office.com/api).
|
|
19807
|
+
* The REST API's base URL (currently `https://outlook.office.com/api`).
|
|
19808
19808
|
*
|
|
19809
19809
|
* Use with `targetMailbox` to construct the REST operation's URL.
|
|
19810
19810
|
*
|
|
@@ -19905,12 +19905,17 @@ declare namespace Office {
|
|
|
19905
19905
|
*
|
|
19906
19906
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19907
19907
|
*
|
|
19908
|
-
* **Important**:
|
|
19908
|
+
* **Important**:
|
|
19909
|
+
*
|
|
19910
|
+
* - If you specify the `contextData` option in your `event.completed` call, you must also assign a task pane ID to the `commandId` option.
|
|
19909
19911
|
* Otherwise, the JSON data assigned to `contextData` is ignored.
|
|
19910
19912
|
*
|
|
19913
|
+
* - To retrieve the value of the `contextData` property, you must call `Office.context.mailbox.item.getInitializationContextAsync` in the JavaScript implementation
|
|
19914
|
+
* of your task pane.
|
|
19915
|
+
*
|
|
19911
19916
|
* @beta
|
|
19912
19917
|
*/
|
|
19913
|
-
contextData?:
|
|
19918
|
+
contextData?: any;
|
|
19914
19919
|
/**
|
|
19915
19920
|
* When you use the {@link Office.MailboxEvent.completed | completed method} to signal completion of an event handler and set its `allowEvent` property
|
|
19916
19921
|
* to `false`, this property sets the error message displayed to the user. For an example, see the
|
|
@@ -89057,23 +89062,20 @@ declare namespace Word {
|
|
|
89057
89062
|
createDocument(base64File?: string): Word.DocumentCreated;
|
|
89058
89063
|
/**
|
|
89059
89064
|
* Opens a document and displays it in a new tab or window.
|
|
89065
|
+
The following are examples for the various supported clients and platforms.
|
|
89066
|
+
|
|
89067
|
+
- Remote or cloud location example: `https://microsoft.sharepoint.com/some/path/Document.docx`
|
|
89068
|
+
|
|
89069
|
+
- Local location examples for Windows: `C:\\Users\\Someone\\Documents\\Document.docx` (includes required escaped backslashes), `file://mycomputer/myfolder/Document.docx`
|
|
89070
|
+
|
|
89071
|
+
- Local location example for Mac and iOS: `/User/someone/document.docx`
|
|
89060
89072
|
*
|
|
89061
89073
|
* @remarks
|
|
89062
|
-
* [Api set: WordApi
|
|
89063
|
-
*
|
|
89064
|
-
* The following are examples for the various supported clients and platforms.
|
|
89074
|
+
* [Api set: WordApi 1.6]
|
|
89065
89075
|
*
|
|
89066
|
-
*
|
|
89067
|
-
*
|
|
89068
|
-
* - Local location examples for Windows: `C:\\Users\\Someone\\Documents\\Document.docx` (includes required escaped backslashes), `file://mycomputer/myfolder/Document.docx`
|
|
89069
|
-
*
|
|
89070
|
-
* - Local location example for Mac and iOS: `/User/someone/document.docx`
|
|
89071
|
-
*
|
|
89072
|
-
* @beta
|
|
89073
|
-
*
|
|
89074
|
-
* @param fileLocation Required. The absolute location of the .docx file. Word on the web only supports remote (cloud) locations, while Word on Windows, Mac, and iOS support local and remote locations.
|
|
89076
|
+
* @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.
|
|
89075
89077
|
*/
|
|
89076
|
-
openDocument(
|
|
89078
|
+
openDocument(filePath: string): void;
|
|
89077
89079
|
/**
|
|
89078
89080
|
* Parse styles from template Base64 file and return JSON format of retrieved styles as a string.
|
|
89079
89081
|
*
|
|
@@ -89140,7 +89142,7 @@ declare namespace Word {
|
|
|
89140
89142
|
*/
|
|
89141
89143
|
readonly footnotes: Word.NoteItemCollection;
|
|
89142
89144
|
/**
|
|
89143
|
-
* Gets the collection of InlinePicture objects in the body. The collection
|
|
89145
|
+
* Gets the collection of InlinePicture objects in the body. The collection doesn't include floating images.
|
|
89144
89146
|
*
|
|
89145
89147
|
* @remarks
|
|
89146
89148
|
* [Api set: WordApi 1.1]
|
|
@@ -89154,10 +89156,12 @@ declare namespace Word {
|
|
|
89154
89156
|
*/
|
|
89155
89157
|
readonly lists: Word.ListCollection;
|
|
89156
89158
|
/**
|
|
89157
|
-
* Gets the collection of paragraph objects in the body.
|
|
89159
|
+
* Gets the collection of paragraph objects in the body.
|
|
89158
89160
|
*
|
|
89159
89161
|
* @remarks
|
|
89160
89162
|
* [Api set: WordApi 1.1]
|
|
89163
|
+
*
|
|
89164
|
+
* 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.
|
|
89161
89165
|
*/
|
|
89162
89166
|
readonly paragraphs: Word.ParagraphCollection;
|
|
89163
89167
|
/**
|
|
@@ -89260,18 +89264,20 @@ declare namespace Word {
|
|
|
89260
89264
|
*/
|
|
89261
89265
|
getComments(): Word.CommentCollection;
|
|
89262
89266
|
/**
|
|
89263
|
-
* Gets the currently supported content controls in the body.
|
|
89264
|
-
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.
|
|
89265
|
-
With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
|
|
89267
|
+
* Gets the currently supported content controls in the body.
|
|
89266
89268
|
*
|
|
89267
89269
|
* @remarks
|
|
89268
89270
|
* [Api set: WordApi 1.5]
|
|
89269
89271
|
*
|
|
89272
|
+
* Important: If specific types are provided in the options parameter, only content controls of supported types are returned.
|
|
89273
|
+
* 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.
|
|
89274
|
+
* With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
|
|
89275
|
+
*
|
|
89270
89276
|
* @param options Optional. Options that define which content controls are returned.
|
|
89271
89277
|
*/
|
|
89272
89278
|
getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;
|
|
89273
89279
|
/**
|
|
89274
|
-
* 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
|
|
89280
|
+
* 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.
|
|
89275
89281
|
*
|
|
89276
89282
|
* @remarks
|
|
89277
89283
|
* [Api set: WordApi 1.1]
|
|
@@ -89315,8 +89321,7 @@ declare namespace Word {
|
|
|
89315
89321
|
* Gets the collection of the TrackedChange objects in the body.
|
|
89316
89322
|
*
|
|
89317
89323
|
* @remarks
|
|
89318
|
-
* [Api set: WordApi
|
|
89319
|
-
* @beta
|
|
89324
|
+
* [Api set: WordApi 1.6]
|
|
89320
89325
|
*/
|
|
89321
89326
|
getTrackedChanges(): Word.TrackedChangeCollection;
|
|
89322
89327
|
/**
|
|
@@ -89546,45 +89551,45 @@ declare namespace Word {
|
|
|
89546
89551
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
89547
89552
|
context: RequestContext;
|
|
89548
89553
|
/**
|
|
89549
|
-
* Specifies the
|
|
89554
|
+
* Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name.
|
|
89550
89555
|
*
|
|
89551
89556
|
* @remarks
|
|
89552
89557
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
89553
89558
|
* @beta
|
|
89554
89559
|
*/
|
|
89555
|
-
|
|
89560
|
+
color: string;
|
|
89556
89561
|
/**
|
|
89557
|
-
*
|
|
89562
|
+
* Gets the location of the border.
|
|
89558
89563
|
*
|
|
89559
89564
|
* @remarks
|
|
89560
89565
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
89561
89566
|
* @beta
|
|
89562
89567
|
*/
|
|
89563
|
-
|
|
89568
|
+
readonly location: Word.BorderLocation | "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All";
|
|
89564
89569
|
/**
|
|
89565
|
-
* Specifies the
|
|
89570
|
+
* Specifies the border type for the border.
|
|
89566
89571
|
*
|
|
89567
89572
|
* @remarks
|
|
89568
89573
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
89569
89574
|
* @beta
|
|
89570
89575
|
*/
|
|
89571
|
-
|
|
89576
|
+
type: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave";
|
|
89572
89577
|
/**
|
|
89573
|
-
*
|
|
89578
|
+
* Specifies whether the border is visible.
|
|
89574
89579
|
*
|
|
89575
89580
|
* @remarks
|
|
89576
89581
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
89577
89582
|
* @beta
|
|
89578
89583
|
*/
|
|
89579
|
-
|
|
89584
|
+
visible: boolean;
|
|
89580
89585
|
/**
|
|
89581
|
-
* Specifies
|
|
89586
|
+
* Specifies the width for the border.
|
|
89582
89587
|
*
|
|
89583
89588
|
* @remarks
|
|
89584
89589
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
89585
89590
|
* @beta
|
|
89586
89591
|
*/
|
|
89587
|
-
|
|
89592
|
+
width: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
|
|
89588
89593
|
/**
|
|
89589
89594
|
* 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.
|
|
89590
89595
|
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
@@ -89641,69 +89646,61 @@ declare namespace Word {
|
|
|
89641
89646
|
/** Gets the loaded child items in this collection. */
|
|
89642
89647
|
readonly items: Word.Border[];
|
|
89643
89648
|
/**
|
|
89644
|
-
* Specifies the 24-bit color of the inside borders.
|
|
89645
|
-
*
|
|
89646
|
-
* @remarks
|
|
89647
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
89648
|
-
* @beta
|
|
89649
|
-
*/
|
|
89650
|
-
insideLineColor: string;
|
|
89651
|
-
/**
|
|
89652
|
-
* Specifies the line style of the inside borders.
|
|
89649
|
+
* Specifies the 24-bit color of the inside borders. Color is specified in ‘#RRGGBB’ format or by using the color name.
|
|
89653
89650
|
*
|
|
89654
89651
|
* @remarks
|
|
89655
89652
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
89656
89653
|
* @beta
|
|
89657
89654
|
*/
|
|
89658
|
-
|
|
89655
|
+
insideBorderColor: string;
|
|
89659
89656
|
/**
|
|
89660
|
-
* Specifies the
|
|
89657
|
+
* Specifies the border type of the inside borders.
|
|
89661
89658
|
*
|
|
89662
89659
|
* @remarks
|
|
89663
89660
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
89664
89661
|
* @beta
|
|
89665
89662
|
*/
|
|
89666
|
-
|
|
89663
|
+
insideBorderType: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave";
|
|
89667
89664
|
/**
|
|
89668
|
-
* Specifies the
|
|
89665
|
+
* Specifies the width of the inside borders.
|
|
89669
89666
|
*
|
|
89670
89667
|
* @remarks
|
|
89671
89668
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
89672
89669
|
* @beta
|
|
89673
89670
|
*/
|
|
89674
|
-
|
|
89671
|
+
insideBorderWidth: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
|
|
89675
89672
|
/**
|
|
89676
|
-
* Specifies the
|
|
89673
|
+
* Specifies the 24-bit color of the outside borders. Color is specified in ‘#RRGGBB’ format or by using the color name.
|
|
89677
89674
|
*
|
|
89678
89675
|
* @remarks
|
|
89679
89676
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
89680
89677
|
* @beta
|
|
89681
89678
|
*/
|
|
89682
|
-
|
|
89679
|
+
outsideBorderColor: string;
|
|
89683
89680
|
/**
|
|
89684
|
-
* Specifies the
|
|
89681
|
+
* Specifies the border type of the outside borders.
|
|
89685
89682
|
*
|
|
89686
89683
|
* @remarks
|
|
89687
89684
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
89688
89685
|
* @beta
|
|
89689
89686
|
*/
|
|
89690
|
-
|
|
89687
|
+
outsideBorderType: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave";
|
|
89691
89688
|
/**
|
|
89692
|
-
*
|
|
89689
|
+
* Specifies the width of the outside borders.
|
|
89693
89690
|
*
|
|
89694
89691
|
* @remarks
|
|
89695
89692
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
89696
89693
|
* @beta
|
|
89697
89694
|
*/
|
|
89698
|
-
|
|
89695
|
+
outsideBorderWidth: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
|
|
89699
89696
|
/**
|
|
89700
|
-
* Gets the border that has the specified
|
|
89697
|
+
* Gets the border that has the specified location.
|
|
89701
89698
|
*
|
|
89702
89699
|
* @remarks
|
|
89703
89700
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
89704
89701
|
* @beta
|
|
89705
89702
|
*/
|
|
89706
|
-
|
|
89703
|
+
getByLocation(borderLocation: Word.BorderLocation.top | Word.BorderLocation.left | Word.BorderLocation.bottom | Word.BorderLocation.right | Word.BorderLocation.insideHorizontal | Word.BorderLocation.insideVertical | "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical"): Word.Border;
|
|
89707
89704
|
/**
|
|
89708
89705
|
* Gets the first border in this collection. Throws an `ItemNotFound` error if this collection is empty.
|
|
89709
89706
|
*
|
|
@@ -89769,7 +89766,9 @@ declare namespace Word {
|
|
|
89769
89766
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
89770
89767
|
* @beta
|
|
89771
89768
|
*/
|
|
89772
|
-
|
|
89769
|
+
class CheckboxContentControl extends OfficeExtension.ClientObject {
|
|
89770
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
89771
|
+
context: RequestContext;
|
|
89773
89772
|
/**
|
|
89774
89773
|
* Specifies the current state of the checkbox.
|
|
89775
89774
|
*
|
|
@@ -89778,6 +89777,40 @@ declare namespace Word {
|
|
|
89778
89777
|
* @beta
|
|
89779
89778
|
*/
|
|
89780
89779
|
isChecked: boolean;
|
|
89780
|
+
/**
|
|
89781
|
+
* 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.
|
|
89782
|
+
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
89783
|
+
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
89784
|
+
*/
|
|
89785
|
+
set(properties: Interfaces.CheckboxContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
89786
|
+
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
89787
|
+
set(properties: Word.CheckboxContentControl): void;
|
|
89788
|
+
/**
|
|
89789
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
89790
|
+
*
|
|
89791
|
+
* @param options Provides options for which properties of the object to load.
|
|
89792
|
+
*/
|
|
89793
|
+
load(options?: Word.Interfaces.CheckboxContentControlLoadOptions): Word.CheckboxContentControl;
|
|
89794
|
+
/**
|
|
89795
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
89796
|
+
*
|
|
89797
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
89798
|
+
*/
|
|
89799
|
+
load(propertyNames?: string | string[]): Word.CheckboxContentControl;
|
|
89800
|
+
/**
|
|
89801
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
89802
|
+
*
|
|
89803
|
+
* @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.
|
|
89804
|
+
*/
|
|
89805
|
+
load(propertyNamesAndPaths?: {
|
|
89806
|
+
select?: string;
|
|
89807
|
+
expand?: string;
|
|
89808
|
+
}): Word.CheckboxContentControl;
|
|
89809
|
+
/**
|
|
89810
|
+
* 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.)
|
|
89811
|
+
* Whereas the original Word.CheckboxContentControl object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CheckboxContentControlData`) that contains shallow copies of any loaded child properties from the original object.
|
|
89812
|
+
*/
|
|
89813
|
+
toJSON(): Word.Interfaces.CheckboxContentControlData;
|
|
89781
89814
|
}
|
|
89782
89815
|
/**
|
|
89783
89816
|
* Represents a comment in the document.
|
|
@@ -90017,7 +90050,7 @@ declare namespace Word {
|
|
|
90017
90050
|
*/
|
|
90018
90051
|
readonly text: string;
|
|
90019
90052
|
/**
|
|
90020
|
-
* Specifies a value that indicates the comment text's underline type. 'None' if the comment text
|
|
90053
|
+
* Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined.
|
|
90021
90054
|
*
|
|
90022
90055
|
* @remarks
|
|
90023
90056
|
* [Api set: WordApi 1.4]
|
|
@@ -90250,6 +90283,14 @@ declare namespace Word {
|
|
|
90250
90283
|
class ContentControl extends OfficeExtension.ClientObject {
|
|
90251
90284
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
90252
90285
|
context: RequestContext;
|
|
90286
|
+
/**
|
|
90287
|
+
* Specifies the checkbox-related data if the content control's type is 'CheckBox'. It's null otherwise.
|
|
90288
|
+
*
|
|
90289
|
+
* @remarks
|
|
90290
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
90291
|
+
* @beta
|
|
90292
|
+
*/
|
|
90293
|
+
readonly checkboxContentControl: Word.CheckboxContentControl;
|
|
90253
90294
|
/**
|
|
90254
90295
|
* Gets the collection of content control objects in the content control.
|
|
90255
90296
|
*
|
|
@@ -90286,7 +90327,7 @@ declare namespace Word {
|
|
|
90286
90327
|
*/
|
|
90287
90328
|
readonly footnotes: Word.NoteItemCollection;
|
|
90288
90329
|
/**
|
|
90289
|
-
* Gets the collection of InlinePicture objects in the content control. The collection
|
|
90330
|
+
* Gets the collection of InlinePicture objects in the content control. The collection doesn't include floating images.
|
|
90290
90331
|
*
|
|
90291
90332
|
* @remarks
|
|
90292
90333
|
* [Api set: WordApi 1.1]
|
|
@@ -90300,10 +90341,12 @@ declare namespace Word {
|
|
|
90300
90341
|
*/
|
|
90301
90342
|
readonly lists: Word.ListCollection;
|
|
90302
90343
|
/**
|
|
90303
|
-
* Gets the collection of paragraph objects in the content control.
|
|
90344
|
+
* Gets the collection of paragraph objects in the content control.
|
|
90304
90345
|
*
|
|
90305
90346
|
* @remarks
|
|
90306
90347
|
* [Api set: WordApi 1.1]
|
|
90348
|
+
*
|
|
90349
|
+
* 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.
|
|
90307
90350
|
*/
|
|
90308
90351
|
readonly paragraphs: Word.ParagraphCollection;
|
|
90309
90352
|
/**
|
|
@@ -90328,14 +90371,14 @@ declare namespace Word {
|
|
|
90328
90371
|
*/
|
|
90329
90372
|
readonly parentContentControlOrNullObject: Word.ContentControl;
|
|
90330
90373
|
/**
|
|
90331
|
-
* Gets the table that contains the content control. Throws an `ItemNotFound` error if it
|
|
90374
|
+
* Gets the table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table.
|
|
90332
90375
|
*
|
|
90333
90376
|
* @remarks
|
|
90334
90377
|
* [Api set: WordApi 1.3]
|
|
90335
90378
|
*/
|
|
90336
90379
|
readonly parentTable: Word.Table;
|
|
90337
90380
|
/**
|
|
90338
|
-
* Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it
|
|
90381
|
+
* Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell.
|
|
90339
90382
|
*
|
|
90340
90383
|
* @remarks
|
|
90341
90384
|
* [Api set: WordApi 1.3]
|
|
@@ -90383,14 +90426,6 @@ declare namespace Word {
|
|
|
90383
90426
|
* [Api set: WordApi 1.1]
|
|
90384
90427
|
*/
|
|
90385
90428
|
cannotEdit: boolean;
|
|
90386
|
-
/**
|
|
90387
|
-
* Gets the checkbox-related data if the content control's type is 'CheckBox'. Returns null otherwise.
|
|
90388
|
-
*
|
|
90389
|
-
* @remarks
|
|
90390
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
90391
|
-
* @beta
|
|
90392
|
-
*/
|
|
90393
|
-
readonly checkboxContentControl: Word.CheckboxContentControl;
|
|
90394
90429
|
/**
|
|
90395
90430
|
* Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name.
|
|
90396
90431
|
*
|
|
@@ -90406,7 +90441,9 @@ declare namespace Word {
|
|
|
90406
90441
|
*/
|
|
90407
90442
|
readonly id: number;
|
|
90408
90443
|
/**
|
|
90409
|
-
* Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty.
|
|
90444
|
+
* Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty.
|
|
90445
|
+
|
|
90446
|
+
Note: The set operation for this property isn't supported in Word on the web.
|
|
90410
90447
|
*
|
|
90411
90448
|
* @remarks
|
|
90412
90449
|
* [Api set: WordApi 1.1]
|
|
@@ -90484,12 +90521,12 @@ declare namespace Word {
|
|
|
90484
90521
|
*/
|
|
90485
90522
|
clear(): void;
|
|
90486
90523
|
/**
|
|
90487
|
-
* Deletes the content control and its content. If keepContent is set to true, the content
|
|
90524
|
+
* Deletes the content control and its content. If `keepContent` is set to true, the content isn't deleted.
|
|
90488
90525
|
*
|
|
90489
90526
|
* @remarks
|
|
90490
90527
|
* [Api set: WordApi 1.1]
|
|
90491
90528
|
*
|
|
90492
|
-
* @param keepContent Required. Indicates whether the content should be deleted with the content control. If keepContent is set to true, the content
|
|
90529
|
+
* @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.
|
|
90493
90530
|
*/
|
|
90494
90531
|
delete(keepContent: boolean): void;
|
|
90495
90532
|
/**
|
|
@@ -90500,18 +90537,20 @@ declare namespace Word {
|
|
|
90500
90537
|
*/
|
|
90501
90538
|
getComments(): Word.CommentCollection;
|
|
90502
90539
|
/**
|
|
90503
|
-
* Gets the currently supported child content controls in this content control.
|
|
90504
|
-
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.
|
|
90505
|
-
With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
|
|
90540
|
+
* Gets the currently supported child content controls in this content control.
|
|
90506
90541
|
*
|
|
90507
90542
|
* @remarks
|
|
90508
90543
|
* [Api set: WordApi 1.5]
|
|
90509
90544
|
*
|
|
90545
|
+
* Important: If specific types are provided in the options parameter, only content controls of supported types are returned.
|
|
90546
|
+
* 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.
|
|
90547
|
+
* With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
|
|
90548
|
+
*
|
|
90510
90549
|
* @param options Optional. Options that define which content controls are returned.
|
|
90511
90550
|
*/
|
|
90512
90551
|
getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;
|
|
90513
90552
|
/**
|
|
90514
|
-
* 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
|
|
90553
|
+
* 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.
|
|
90515
90554
|
*
|
|
90516
90555
|
* @remarks
|
|
90517
90556
|
* [Api set: WordApi 1.1]
|
|
@@ -90565,8 +90604,7 @@ declare namespace Word {
|
|
|
90565
90604
|
* Gets the collection of the TrackedChange objects in the content control.
|
|
90566
90605
|
*
|
|
90567
90606
|
* @remarks
|
|
90568
|
-
* [Api set: WordApi
|
|
90569
|
-
* @beta
|
|
90607
|
+
* [Api set: WordApi 1.6]
|
|
90570
90608
|
*/
|
|
90571
90609
|
getTrackedChanges(): Word.TrackedChangeCollection;
|
|
90572
90610
|
/**
|
|
@@ -91073,7 +91111,7 @@ declare namespace Word {
|
|
|
91073
91111
|
*/
|
|
91074
91112
|
getCount(): OfficeExtension.ClientResult<number>;
|
|
91075
91113
|
/**
|
|
91076
|
-
* Gets a custom property object by its key, which is case-insensitive. Throws an `ItemNotFound` error if the custom property
|
|
91114
|
+
* Gets a custom property object by its key, which is case-insensitive. Throws an `ItemNotFound` error if the custom property doesn't exist.
|
|
91077
91115
|
*
|
|
91078
91116
|
* @remarks
|
|
91079
91117
|
* [Api set: WordApi 1.3]
|
|
@@ -91174,7 +91212,7 @@ declare namespace Word {
|
|
|
91174
91212
|
* "http:\/\/calendartypes.org\/xsds\/GregorianCalendar" in the namespaceMappings parameter.
|
|
91175
91213
|
*
|
|
91176
91214
|
* @param xpath Required. Absolute path to the single element in XPath notation.
|
|
91177
|
-
* @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
|
|
91215
|
+
* @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 "/".
|
|
91178
91216
|
* @param name Required. Name of the attribute.
|
|
91179
91217
|
*/
|
|
91180
91218
|
deleteAttribute(xpath: string, namespaceMappings: {
|
|
@@ -91202,7 +91240,7 @@ declare namespace Word {
|
|
|
91202
91240
|
* "http:\/\/calendartypes.org\/xsds\/GregorianCalendar" in the namespaceMappings parameter.
|
|
91203
91241
|
*
|
|
91204
91242
|
* @param xpath Required. Absolute path to the single element in XPath notation.
|
|
91205
|
-
* @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
|
|
91243
|
+
* @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 "/".
|
|
91206
91244
|
*/
|
|
91207
91245
|
deleteElement(xpath: string, namespaceMappings: {
|
|
91208
91246
|
[key: string]: string;
|
|
@@ -91236,7 +91274,7 @@ declare namespace Word {
|
|
|
91236
91274
|
* "http:\/\/calendartypes.org\/xsds\/GregorianCalendar" in the namespaceMappings parameter.
|
|
91237
91275
|
*
|
|
91238
91276
|
* @param xpath Required. Absolute path to the single element in XPath notation.
|
|
91239
|
-
* @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
|
|
91277
|
+
* @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 "/".
|
|
91240
91278
|
* @param name Required. Name of the attribute.
|
|
91241
91279
|
* @param value Required. Value of the attribute.
|
|
91242
91280
|
*/
|
|
@@ -91266,7 +91304,7 @@ declare namespace Word {
|
|
|
91266
91304
|
*
|
|
91267
91305
|
* @param xpath Required. Absolute path to the single parent element in XPath notation.
|
|
91268
91306
|
* @param xml Required. XML content to be inserted.
|
|
91269
|
-
* @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
|
|
91307
|
+
* @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 "/".
|
|
91270
91308
|
* @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.
|
|
91271
91309
|
*/
|
|
91272
91310
|
insertElement(xpath: string, xml: string, namespaceMappings: {
|
|
@@ -91294,7 +91332,7 @@ declare namespace Word {
|
|
|
91294
91332
|
* "http:\/\/calendartypes.org\/xsds\/GregorianCalendar" in the namespaceMappings parameter.
|
|
91295
91333
|
*
|
|
91296
91334
|
* @param xpath Required. An XPath query.
|
|
91297
|
-
* @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
|
|
91335
|
+
* @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 "/".
|
|
91298
91336
|
* @returns An array where each item represents an entry matched by the XPath query.
|
|
91299
91337
|
*/
|
|
91300
91338
|
query(xpath: string, namespaceMappings: {
|
|
@@ -91331,7 +91369,7 @@ declare namespace Word {
|
|
|
91331
91369
|
* "http:\/\/calendartypes.org\/xsds\/GregorianCalendar" in the namespaceMappings parameter.
|
|
91332
91370
|
*
|
|
91333
91371
|
* @param xpath Required. Absolute path to the single element in XPath notation.
|
|
91334
|
-
* @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
|
|
91372
|
+
* @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 "/".
|
|
91335
91373
|
* @param name Required. Name of the attribute.
|
|
91336
91374
|
* @param value Required. New value of the attribute.
|
|
91337
91375
|
*/
|
|
@@ -91361,7 +91399,7 @@ declare namespace Word {
|
|
|
91361
91399
|
*
|
|
91362
91400
|
* @param xpath Required. Absolute path to the single element in XPath notation.
|
|
91363
91401
|
* @param xml Required. New XML content to be stored.
|
|
91364
|
-
* @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
|
|
91402
|
+
* @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 "/".
|
|
91365
91403
|
*/
|
|
91366
91404
|
updateElement(xpath: string, xml: string, namespaceMappings: {
|
|
91367
91405
|
[key: string]: string;
|
|
@@ -91663,7 +91701,7 @@ declare namespace Word {
|
|
|
91663
91701
|
*/
|
|
91664
91702
|
addStyle(name: string, type: "Character" | "List" | "Paragraph" | "Table"): Word.Style;
|
|
91665
91703
|
/**
|
|
91666
|
-
*
|
|
91704
|
+
* Closes the current document.
|
|
91667
91705
|
*
|
|
91668
91706
|
* @remarks
|
|
91669
91707
|
* [Api set: WordApi 1.5]
|
|
@@ -91672,7 +91710,7 @@ declare namespace Word {
|
|
|
91672
91710
|
*/
|
|
91673
91711
|
close(closeBehavior?: Word.CloseBehavior): void;
|
|
91674
91712
|
/**
|
|
91675
|
-
*
|
|
91713
|
+
* Closes the current document.
|
|
91676
91714
|
*
|
|
91677
91715
|
* @remarks
|
|
91678
91716
|
* [Api set: WordApi 1.5]
|
|
@@ -91697,7 +91735,7 @@ declare namespace Word {
|
|
|
91697
91735
|
* @remarks
|
|
91698
91736
|
* [Api set: WordApi 1.4]
|
|
91699
91737
|
*
|
|
91700
|
-
* @param name Required. The bookmark name
|
|
91738
|
+
* @param name Required. The case-insensitive bookmark name.
|
|
91701
91739
|
*/
|
|
91702
91740
|
deleteBookmark(name: string): void;
|
|
91703
91741
|
/**
|
|
@@ -91711,12 +91749,12 @@ declare namespace Word {
|
|
|
91711
91749
|
*/
|
|
91712
91750
|
getAnnotationById(id: string): Word.Annotation;
|
|
91713
91751
|
/**
|
|
91714
|
-
* Gets a bookmark's range. Throws an `ItemNotFound` error if the bookmark
|
|
91752
|
+
* Gets a bookmark's range. Throws an `ItemNotFound` error if the bookmark doesn't exist.
|
|
91715
91753
|
*
|
|
91716
91754
|
* @remarks
|
|
91717
91755
|
* [Api set: WordApi 1.4]
|
|
91718
91756
|
*
|
|
91719
|
-
* @param name Required. The bookmark name
|
|
91757
|
+
* @param name Required. The case-insensitive bookmark name.
|
|
91720
91758
|
*/
|
|
91721
91759
|
getBookmarkRange(name: string): Word.Range;
|
|
91722
91760
|
/**
|
|
@@ -91725,17 +91763,19 @@ declare namespace Word {
|
|
|
91725
91763
|
* @remarks
|
|
91726
91764
|
* [Api set: WordApi 1.4]
|
|
91727
91765
|
*
|
|
91728
|
-
* @param name Required. The bookmark name
|
|
91766
|
+
* @param name Required. The case-insensitive bookmark name.
|
|
91729
91767
|
*/
|
|
91730
91768
|
getBookmarkRangeOrNullObject(name: string): Word.Range;
|
|
91731
91769
|
/**
|
|
91732
|
-
* Gets the currently supported content controls in the document.
|
|
91733
|
-
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.
|
|
91734
|
-
With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
|
|
91770
|
+
* Gets the currently supported content controls in the document.
|
|
91735
91771
|
*
|
|
91736
91772
|
* @remarks
|
|
91737
91773
|
* [Api set: WordApi 1.5]
|
|
91738
91774
|
*
|
|
91775
|
+
* Important: If specific types are provided in the options parameter, only content controls of supported types are returned.
|
|
91776
|
+
* 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.
|
|
91777
|
+
* With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
|
|
91778
|
+
*
|
|
91739
91779
|
* @param options Optional. Options that define which content controls are returned.
|
|
91740
91780
|
*/
|
|
91741
91781
|
getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;
|
|
@@ -91759,14 +91799,13 @@ declare namespace Word {
|
|
|
91759
91799
|
* Gets the paragraph by its unique local ID. Throws an `ItemNotFound` error if the collection is empty.
|
|
91760
91800
|
*
|
|
91761
91801
|
* @remarks
|
|
91762
|
-
* [Api set: WordApi
|
|
91763
|
-
* @beta
|
|
91802
|
+
* [Api set: WordApi 1.6]
|
|
91764
91803
|
*
|
|
91765
91804
|
* @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.
|
|
91766
91805
|
*/
|
|
91767
91806
|
getParagraphByUniqueLocalId(id: string): Word.Paragraph;
|
|
91768
91807
|
/**
|
|
91769
|
-
* Gets the current selection of the document. Multiple selections
|
|
91808
|
+
* Gets the current selection of the document. Multiple selections aren't supported.
|
|
91770
91809
|
*
|
|
91771
91810
|
* @remarks
|
|
91772
91811
|
* [Api set: WordApi 1.1]
|
|
@@ -91783,8 +91822,7 @@ declare namespace Word {
|
|
|
91783
91822
|
* Import styles from a JSON-formatted string.
|
|
91784
91823
|
*
|
|
91785
91824
|
* @remarks
|
|
91786
|
-
* [Api set: WordApi
|
|
91787
|
-
* @beta
|
|
91825
|
+
* [Api set: WordApi 1.6]
|
|
91788
91826
|
*
|
|
91789
91827
|
* @param stylesJson Required. A JSON-formatted string representing the styles.
|
|
91790
91828
|
*/
|
|
@@ -91916,30 +91954,27 @@ declare namespace Word {
|
|
|
91916
91954
|
* Occurs when the user adds new paragraphs.
|
|
91917
91955
|
*
|
|
91918
91956
|
* @remarks
|
|
91919
|
-
* [Api set: WordApi
|
|
91957
|
+
* [Api set: WordApi 1.6]
|
|
91920
91958
|
*
|
|
91921
91959
|
* @eventproperty
|
|
91922
|
-
* @beta
|
|
91923
91960
|
*/
|
|
91924
91961
|
readonly onParagraphAdded: OfficeExtension.EventHandlers<Word.ParagraphAddedEventArgs>;
|
|
91925
91962
|
/**
|
|
91926
91963
|
* Occurs when the user changes paragraphs.
|
|
91927
91964
|
*
|
|
91928
91965
|
* @remarks
|
|
91929
|
-
* [Api set: WordApi
|
|
91966
|
+
* [Api set: WordApi 1.6]
|
|
91930
91967
|
*
|
|
91931
91968
|
* @eventproperty
|
|
91932
|
-
* @beta
|
|
91933
91969
|
*/
|
|
91934
91970
|
readonly onParagraphChanged: OfficeExtension.EventHandlers<Word.ParagraphChangedEventArgs>;
|
|
91935
91971
|
/**
|
|
91936
91972
|
* Occurs when the user deletes paragraphs.
|
|
91937
91973
|
*
|
|
91938
91974
|
* @remarks
|
|
91939
|
-
* [Api set: WordApi
|
|
91975
|
+
* [Api set: WordApi 1.6]
|
|
91940
91976
|
*
|
|
91941
91977
|
* @eventproperty
|
|
91942
|
-
* @beta
|
|
91943
91978
|
*/
|
|
91944
91979
|
readonly onParagraphDeleted: OfficeExtension.EventHandlers<Word.ParagraphDeletedEventArgs>;
|
|
91945
91980
|
/**
|
|
@@ -92048,16 +92083,16 @@ declare namespace Word {
|
|
|
92048
92083
|
* @remarks
|
|
92049
92084
|
* [Api set: WordApiHiddenDocument 1.4]
|
|
92050
92085
|
*
|
|
92051
|
-
* @param name Required. The bookmark name
|
|
92086
|
+
* @param name Required. The case-insensitive bookmark name.
|
|
92052
92087
|
*/
|
|
92053
92088
|
deleteBookmark(name: string): void;
|
|
92054
92089
|
/**
|
|
92055
|
-
* Gets a bookmark's range. Throws an `ItemNotFound` error if the bookmark
|
|
92090
|
+
* Gets a bookmark's range. Throws an `ItemNotFound` error if the bookmark doesn't exist.
|
|
92056
92091
|
*
|
|
92057
92092
|
* @remarks
|
|
92058
92093
|
* [Api set: WordApiHiddenDocument 1.4]
|
|
92059
92094
|
*
|
|
92060
|
-
* @param name Required. The bookmark name
|
|
92095
|
+
* @param name Required. The case-insensitive bookmark name.
|
|
92061
92096
|
*/
|
|
92062
92097
|
getBookmarkRange(name: string): Word.Range;
|
|
92063
92098
|
/**
|
|
@@ -92066,17 +92101,19 @@ declare namespace Word {
|
|
|
92066
92101
|
* @remarks
|
|
92067
92102
|
* [Api set: WordApiHiddenDocument 1.4]
|
|
92068
92103
|
*
|
|
92069
|
-
* @param name Required. The bookmark name,
|
|
92104
|
+
* @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.
|
|
92070
92105
|
*/
|
|
92071
92106
|
getBookmarkRangeOrNullObject(name: string): Word.Range;
|
|
92072
92107
|
/**
|
|
92073
|
-
* Gets the currently supported content controls in the document.
|
|
92074
|
-
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.
|
|
92075
|
-
With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
|
|
92108
|
+
* Gets the currently supported content controls in the document.
|
|
92076
92109
|
*
|
|
92077
92110
|
* @remarks
|
|
92078
92111
|
* [Api set: WordApiHiddenDocument 1.5]
|
|
92079
92112
|
*
|
|
92113
|
+
* Important: If specific types are provided in the options parameter, only content controls of supported types are returned.
|
|
92114
|
+
* 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.
|
|
92115
|
+
* With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
|
|
92116
|
+
*
|
|
92080
92117
|
* @param options Optional. Options that define which content controls are returned.
|
|
92081
92118
|
*/
|
|
92082
92119
|
getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;
|
|
@@ -92378,14 +92415,14 @@ declare namespace Word {
|
|
|
92378
92415
|
*/
|
|
92379
92416
|
readonly parentContentControlOrNullObject: Word.ContentControl;
|
|
92380
92417
|
/**
|
|
92381
|
-
* Gets the table that contains the field. Throws an `ItemNotFound` error if it
|
|
92418
|
+
* Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table.
|
|
92382
92419
|
*
|
|
92383
92420
|
* @remarks
|
|
92384
92421
|
* [Api set: WordApi 1.4]
|
|
92385
92422
|
*/
|
|
92386
92423
|
readonly parentTable: Word.Table;
|
|
92387
92424
|
/**
|
|
92388
|
-
* Gets the table cell that contains the field. Throws an `ItemNotFound` error if it
|
|
92425
|
+
* Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell.
|
|
92389
92426
|
*
|
|
92390
92427
|
* @remarks
|
|
92391
92428
|
* [Api set: WordApi 1.4]
|
|
@@ -92702,7 +92739,7 @@ declare namespace Word {
|
|
|
92702
92739
|
*/
|
|
92703
92740
|
superscript: boolean;
|
|
92704
92741
|
/**
|
|
92705
|
-
* Specifies a value that indicates the font's underline type. 'None' if the font
|
|
92742
|
+
* Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined.
|
|
92706
92743
|
*
|
|
92707
92744
|
* @remarks
|
|
92708
92745
|
* [Api set: WordApi 1.1]
|
|
@@ -92782,14 +92819,14 @@ declare namespace Word {
|
|
|
92782
92819
|
*/
|
|
92783
92820
|
readonly parentContentControlOrNullObject: Word.ContentControl;
|
|
92784
92821
|
/**
|
|
92785
|
-
* Gets the table that contains the inline image. Throws an `ItemNotFound` error if it
|
|
92822
|
+
* Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table.
|
|
92786
92823
|
*
|
|
92787
92824
|
* @remarks
|
|
92788
92825
|
* [Api set: WordApi 1.3]
|
|
92789
92826
|
*/
|
|
92790
92827
|
readonly parentTable: Word.Table;
|
|
92791
92828
|
/**
|
|
92792
|
-
* Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it
|
|
92829
|
+
* Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table cell.
|
|
92793
92830
|
*
|
|
92794
92831
|
* @remarks
|
|
92795
92832
|
* [Api set: WordApi 1.3]
|
|
@@ -93445,7 +93482,7 @@ declare namespace Word {
|
|
|
93445
93482
|
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
93446
93483
|
set(properties: Word.ListItem): void;
|
|
93447
93484
|
/**
|
|
93448
|
-
* Gets the list item parent, or the closest ancestor if the parent
|
|
93485
|
+
* 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.
|
|
93449
93486
|
*
|
|
93450
93487
|
* @remarks
|
|
93451
93488
|
* [Api set: WordApi 1.3]
|
|
@@ -93972,21 +94009,21 @@ declare namespace Word {
|
|
|
93972
94009
|
*/
|
|
93973
94010
|
readonly footnotes: Word.NoteItemCollection;
|
|
93974
94011
|
/**
|
|
93975
|
-
* Gets the collection of InlinePicture objects in the paragraph. The collection
|
|
94012
|
+
* Gets the collection of InlinePicture objects in the paragraph. The collection doesn't include floating images.
|
|
93976
94013
|
*
|
|
93977
94014
|
* @remarks
|
|
93978
94015
|
* [Api set: WordApi 1.1]
|
|
93979
94016
|
*/
|
|
93980
94017
|
readonly inlinePictures: Word.InlinePictureCollection;
|
|
93981
94018
|
/**
|
|
93982
|
-
* Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph
|
|
94019
|
+
* Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list.
|
|
93983
94020
|
*
|
|
93984
94021
|
* @remarks
|
|
93985
94022
|
* [Api set: WordApi 1.3]
|
|
93986
94023
|
*/
|
|
93987
94024
|
readonly list: Word.List;
|
|
93988
94025
|
/**
|
|
93989
|
-
* Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph
|
|
94026
|
+
* Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list.
|
|
93990
94027
|
*
|
|
93991
94028
|
* @remarks
|
|
93992
94029
|
* [Api set: WordApi 1.3]
|
|
@@ -94028,14 +94065,14 @@ declare namespace Word {
|
|
|
94028
94065
|
*/
|
|
94029
94066
|
readonly parentContentControlOrNullObject: Word.ContentControl;
|
|
94030
94067
|
/**
|
|
94031
|
-
* Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it
|
|
94068
|
+
* Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table.
|
|
94032
94069
|
*
|
|
94033
94070
|
* @remarks
|
|
94034
94071
|
* [Api set: WordApi 1.3]
|
|
94035
94072
|
*/
|
|
94036
94073
|
readonly parentTable: Word.Table;
|
|
94037
94074
|
/**
|
|
94038
|
-
* Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it
|
|
94075
|
+
* Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell.
|
|
94039
94076
|
*
|
|
94040
94077
|
* @remarks
|
|
94041
94078
|
* [Api set: WordApi 1.3]
|
|
@@ -94154,7 +94191,7 @@ declare namespace Word {
|
|
|
94154
94191
|
*/
|
|
94155
94192
|
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";
|
|
94156
94193
|
/**
|
|
94157
|
-
* Gets the level of the paragraph's table. It returns 0 if the paragraph
|
|
94194
|
+
* Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table.
|
|
94158
94195
|
*
|
|
94159
94196
|
* @remarks
|
|
94160
94197
|
* [Api set: WordApi 1.3]
|
|
@@ -94171,8 +94208,7 @@ declare namespace Word {
|
|
|
94171
94208
|
* 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.
|
|
94172
94209
|
*
|
|
94173
94210
|
* @remarks
|
|
94174
|
-
* [Api set: WordApi
|
|
94175
|
-
* @beta
|
|
94211
|
+
* [Api set: WordApi 1.6]
|
|
94176
94212
|
*/
|
|
94177
94213
|
readonly uniqueLocalId: string;
|
|
94178
94214
|
/**
|
|
@@ -94230,18 +94266,20 @@ declare namespace Word {
|
|
|
94230
94266
|
*/
|
|
94231
94267
|
getComments(): Word.CommentCollection;
|
|
94232
94268
|
/**
|
|
94233
|
-
* Gets the currently supported content controls in the paragraph.
|
|
94234
|
-
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.
|
|
94235
|
-
With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
|
|
94269
|
+
* Gets the currently supported content controls in the paragraph.
|
|
94236
94270
|
*
|
|
94237
94271
|
* @remarks
|
|
94238
94272
|
* [Api set: WordApi 1.5]
|
|
94239
94273
|
*
|
|
94274
|
+
* Important: If specific types are provided in the options parameter, only content controls of supported types are returned.
|
|
94275
|
+
* 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.
|
|
94276
|
+
* With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
|
|
94277
|
+
*
|
|
94240
94278
|
* @param options Optional. Options that define which content controls are returned.
|
|
94241
94279
|
*/
|
|
94242
94280
|
getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;
|
|
94243
94281
|
/**
|
|
94244
|
-
* 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
|
|
94282
|
+
* 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.
|
|
94245
94283
|
*
|
|
94246
94284
|
* @remarks
|
|
94247
94285
|
* [Api set: WordApi 1.1]
|
|
@@ -94309,6 +94347,20 @@ declare namespace Word {
|
|
|
94309
94347
|
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
94310
94348
|
*/
|
|
94311
94349
|
getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
|
|
94350
|
+
/**
|
|
94351
|
+
* Returns the text of the paragraph. This excludes equations, graphics (e.g., images, videos, drawings), and special characters that mark various content (e.g., for content controls, fields, comments, footnotes, endnotes).
|
|
94352
|
+
By default, hidden text and text marked as deleted are excluded.
|
|
94353
|
+
*
|
|
94354
|
+
* @remarks
|
|
94355
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
94356
|
+
* @beta
|
|
94357
|
+
*
|
|
94358
|
+
* @param options Optional. Options that define whether the final result should include hidden text and text marked as deleted.
|
|
94359
|
+
*/
|
|
94360
|
+
getText(options?: Word.GetTextOptions | {
|
|
94361
|
+
IncludeHiddenText?: boolean;
|
|
94362
|
+
IncludeTextMarkedAsDeleted?: boolean;
|
|
94363
|
+
}): OfficeExtension.ClientResult<string>;
|
|
94312
94364
|
/**
|
|
94313
94365
|
* Gets the text ranges in the paragraph by using punctuation marks and/or other ending marks.
|
|
94314
94366
|
*
|
|
@@ -94323,8 +94375,7 @@ declare namespace Word {
|
|
|
94323
94375
|
* Gets the collection of the TrackedChange objects in the paragraph.
|
|
94324
94376
|
*
|
|
94325
94377
|
* @remarks
|
|
94326
|
-
* [Api set: WordApi
|
|
94327
|
-
* @beta
|
|
94378
|
+
* [Api set: WordApi 1.6]
|
|
94328
94379
|
*/
|
|
94329
94380
|
getTrackedChanges(): Word.TrackedChangeCollection;
|
|
94330
94381
|
/**
|
|
@@ -94852,10 +94903,12 @@ declare namespace Word {
|
|
|
94852
94903
|
*/
|
|
94853
94904
|
readonly lists: Word.ListCollection;
|
|
94854
94905
|
/**
|
|
94855
|
-
* Gets the collection of paragraph objects in the range.
|
|
94906
|
+
* Gets the collection of paragraph objects in the range.
|
|
94856
94907
|
*
|
|
94857
94908
|
* @remarks
|
|
94858
94909
|
* [Api set: WordApi 1.1]
|
|
94910
|
+
*
|
|
94911
|
+
* 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.
|
|
94859
94912
|
*/
|
|
94860
94913
|
readonly paragraphs: Word.ParagraphCollection;
|
|
94861
94914
|
/**
|
|
@@ -94880,14 +94933,14 @@ declare namespace Word {
|
|
|
94880
94933
|
*/
|
|
94881
94934
|
readonly parentContentControlOrNullObject: Word.ContentControl;
|
|
94882
94935
|
/**
|
|
94883
|
-
* Gets the table that contains the range. Throws an `ItemNotFound` error if it
|
|
94936
|
+
* Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table.
|
|
94884
94937
|
*
|
|
94885
94938
|
* @remarks
|
|
94886
94939
|
* [Api set: WordApi 1.3]
|
|
94887
94940
|
*/
|
|
94888
94941
|
readonly parentTable: Word.Table;
|
|
94889
94942
|
/**
|
|
94890
|
-
* Gets the table cell that contains the range. Throws an `ItemNotFound` error if it
|
|
94943
|
+
* Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell.
|
|
94891
94944
|
*
|
|
94892
94945
|
* @remarks
|
|
94893
94946
|
* [Api set: WordApi 1.3]
|
|
@@ -94981,7 +95034,7 @@ declare namespace Word {
|
|
|
94981
95034
|
*/
|
|
94982
95035
|
delete(): void;
|
|
94983
95036
|
/**
|
|
94984
|
-
* Returns a new range that extends from this range in either direction to cover another range. This range
|
|
95037
|
+
* 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.
|
|
94985
95038
|
*
|
|
94986
95039
|
* @remarks
|
|
94987
95040
|
* [Api set: WordApi 1.3]
|
|
@@ -95017,18 +95070,20 @@ declare namespace Word {
|
|
|
95017
95070
|
*/
|
|
95018
95071
|
getComments(): Word.CommentCollection;
|
|
95019
95072
|
/**
|
|
95020
|
-
* Gets the currently supported content controls in the range.
|
|
95021
|
-
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.
|
|
95022
|
-
With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
|
|
95073
|
+
* Gets the currently supported content controls in the range.
|
|
95023
95074
|
*
|
|
95024
95075
|
* @remarks
|
|
95025
95076
|
* [Api set: WordApi 1.5]
|
|
95026
95077
|
*
|
|
95078
|
+
* **Important**: If specific types are provided in the options parameter, only content controls of supported types are returned.
|
|
95079
|
+
* 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.
|
|
95080
|
+
* With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
|
|
95081
|
+
*
|
|
95027
95082
|
* @param options Optional. Options that define which content controls are returned.
|
|
95028
95083
|
*/
|
|
95029
95084
|
getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;
|
|
95030
95085
|
/**
|
|
95031
|
-
* 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
|
|
95086
|
+
* 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.
|
|
95032
95087
|
*
|
|
95033
95088
|
* @remarks
|
|
95034
95089
|
* [Api set: WordApi 1.1]
|
|
@@ -95109,8 +95164,7 @@ declare namespace Word {
|
|
|
95109
95164
|
* Gets the collection of the TrackedChange objects in the range.
|
|
95110
95165
|
*
|
|
95111
95166
|
* @remarks
|
|
95112
|
-
* [Api set: WordApi
|
|
95113
|
-
* @beta
|
|
95167
|
+
* [Api set: WordApi 1.6]
|
|
95114
95168
|
*/
|
|
95115
95169
|
getTrackedChanges(): Word.TrackedChangeCollection;
|
|
95116
95170
|
/**
|
|
@@ -95300,7 +95354,7 @@ declare namespace Word {
|
|
|
95300
95354
|
*/
|
|
95301
95355
|
insertText(text: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;
|
|
95302
95356
|
/**
|
|
95303
|
-
* Returns a new range as the intersection of this range with another range. This range
|
|
95357
|
+
* 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.
|
|
95304
95358
|
*
|
|
95305
95359
|
* @remarks
|
|
95306
95360
|
* [Api set: WordApi 1.3]
|
|
@@ -95515,16 +95569,14 @@ declare namespace Word {
|
|
|
95515
95569
|
* Represents whether the custom properties from the source document should be imported. Overwrites existing properties with the same name.
|
|
95516
95570
|
*
|
|
95517
95571
|
* @remarks
|
|
95518
|
-
* [Api set: WordApi
|
|
95519
|
-
* @beta
|
|
95572
|
+
* [Api set: WordApi 1.6]
|
|
95520
95573
|
*/
|
|
95521
95574
|
importCustomProperties?: boolean;
|
|
95522
95575
|
/**
|
|
95523
95576
|
* Represents whether the custom XML parts from the source document should be imported.
|
|
95524
95577
|
*
|
|
95525
95578
|
* @remarks
|
|
95526
|
-
* [Api set: WordApi
|
|
95527
|
-
* @beta
|
|
95579
|
+
* [Api set: WordApi 1.6]
|
|
95528
95580
|
*/
|
|
95529
95581
|
importCustomXmlParts?: boolean;
|
|
95530
95582
|
/**
|
|
@@ -95654,6 +95706,31 @@ declare namespace Word {
|
|
|
95654
95706
|
*/
|
|
95655
95707
|
toJSON(): Word.Interfaces.SearchOptionsData;
|
|
95656
95708
|
}
|
|
95709
|
+
/**
|
|
95710
|
+
* Specifies the options to be included in a getText operation.
|
|
95711
|
+
*
|
|
95712
|
+
* @remarks
|
|
95713
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
95714
|
+
* @beta
|
|
95715
|
+
*/
|
|
95716
|
+
interface GetTextOptions {
|
|
95717
|
+
/**
|
|
95718
|
+
* Specifies a value that indicates whether to include hidden text in the result of the GetText method. The default value is False.
|
|
95719
|
+
*
|
|
95720
|
+
* @remarks
|
|
95721
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
95722
|
+
* @beta
|
|
95723
|
+
*/
|
|
95724
|
+
includeHiddenText?: boolean;
|
|
95725
|
+
/**
|
|
95726
|
+
* Specifies a value that indicates whether to include text marked as deleted in the result of the GetText method. The default value is False.
|
|
95727
|
+
*
|
|
95728
|
+
* @remarks
|
|
95729
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
95730
|
+
* @beta
|
|
95731
|
+
*/
|
|
95732
|
+
includeTextMarkedAsDeleted?: boolean;
|
|
95733
|
+
}
|
|
95657
95734
|
/**
|
|
95658
95735
|
* Specifies the options to be included in a compare document operation.
|
|
95659
95736
|
*
|
|
@@ -95730,7 +95807,7 @@ declare namespace Word {
|
|
|
95730
95807
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
95731
95808
|
context: RequestContext;
|
|
95732
95809
|
/**
|
|
95733
|
-
* Gets the body object of the section. This
|
|
95810
|
+
* Gets the body object of the section. This doesn't include the header/footer and other section metadata.
|
|
95734
95811
|
*
|
|
95735
95812
|
* @remarks
|
|
95736
95813
|
* [Api set: WordApi 1.1]
|
|
@@ -95995,7 +96072,7 @@ declare namespace Word {
|
|
|
95995
96072
|
*/
|
|
95996
96073
|
getCount(): OfficeExtension.ClientResult<number>;
|
|
95997
96074
|
/**
|
|
95998
|
-
* Gets a setting object by its key, which is case-sensitive. Throws an `ItemNotFound` error if the setting
|
|
96075
|
+
* Gets a setting object by its key, which is case-sensitive. Throws an `ItemNotFound` error if the setting doesn't exist.
|
|
95999
96076
|
*
|
|
96000
96077
|
* @remarks
|
|
96001
96078
|
* [Api set: WordApi 1.4]
|
|
@@ -96164,25 +96241,25 @@ declare namespace Word {
|
|
|
96164
96241
|
* Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
|
|
96165
96242
|
*
|
|
96166
96243
|
* @remarks
|
|
96167
|
-
* [Api set: WordApi
|
|
96168
|
-
* @beta
|
|
96244
|
+
* [Api set: WordApi 1.6]
|
|
96169
96245
|
*/
|
|
96170
96246
|
readonly shading: Word.Shading;
|
|
96171
96247
|
/**
|
|
96172
96248
|
* Gets a TableStyle object representing Style properties that can be applied to a table.
|
|
96173
96249
|
*
|
|
96174
96250
|
* @remarks
|
|
96175
|
-
* [Api set: WordApi
|
|
96176
|
-
* @beta
|
|
96251
|
+
* [Api set: WordApi 1.6]
|
|
96177
96252
|
*/
|
|
96178
96253
|
readonly tableStyle: Word.TableStyle;
|
|
96179
96254
|
/**
|
|
96180
|
-
*
|
|
96255
|
+
* Specifies the name of an existing style to use as the base formatting of another style.
|
|
96181
96256
|
*
|
|
96182
96257
|
* @remarks
|
|
96183
96258
|
* [Api set: WordApi 1.5]
|
|
96259
|
+
*
|
|
96260
|
+
* Note: The ability to set `baseStyle` was introduced in WordApi 1.6.
|
|
96184
96261
|
*/
|
|
96185
|
-
|
|
96262
|
+
baseStyle: string;
|
|
96186
96263
|
/**
|
|
96187
96264
|
* Gets whether the specified style is a built-in style.
|
|
96188
96265
|
*
|
|
@@ -96220,12 +96297,14 @@ declare namespace Word {
|
|
|
96220
96297
|
*/
|
|
96221
96298
|
readonly nameLocal: string;
|
|
96222
96299
|
/**
|
|
96223
|
-
*
|
|
96300
|
+
* 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.
|
|
96224
96301
|
*
|
|
96225
96302
|
* @remarks
|
|
96226
96303
|
* [Api set: WordApi 1.5]
|
|
96304
|
+
*
|
|
96305
|
+
* Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6.
|
|
96227
96306
|
*/
|
|
96228
|
-
|
|
96307
|
+
nextParagraphStyle: string;
|
|
96229
96308
|
/**
|
|
96230
96309
|
* Specifies the priority.
|
|
96231
96310
|
*
|
|
@@ -96315,8 +96394,7 @@ declare namespace Word {
|
|
|
96315
96394
|
* Represents the shading object.
|
|
96316
96395
|
*
|
|
96317
96396
|
* @remarks
|
|
96318
|
-
* [Api set: WordApi
|
|
96319
|
-
* @beta
|
|
96397
|
+
* [Api set: WordApi 1.6]
|
|
96320
96398
|
*/
|
|
96321
96399
|
class Shading extends OfficeExtension.ClientObject {
|
|
96322
96400
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -96325,8 +96403,7 @@ declare namespace Word {
|
|
|
96325
96403
|
* Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name.
|
|
96326
96404
|
*
|
|
96327
96405
|
* @remarks
|
|
96328
|
-
* [Api set: WordApi
|
|
96329
|
-
* @beta
|
|
96406
|
+
* [Api set: WordApi 1.6]
|
|
96330
96407
|
*/
|
|
96331
96408
|
backgroundPatternColor: string;
|
|
96332
96409
|
/**
|
|
@@ -96447,14 +96524,14 @@ declare namespace Word {
|
|
|
96447
96524
|
*/
|
|
96448
96525
|
readonly parentContentControlOrNullObject: Word.ContentControl;
|
|
96449
96526
|
/**
|
|
96450
|
-
* Gets the table that contains this table. Throws an `ItemNotFound` error if it
|
|
96527
|
+
* Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table.
|
|
96451
96528
|
*
|
|
96452
96529
|
* @remarks
|
|
96453
96530
|
* [Api set: WordApi 1.3]
|
|
96454
96531
|
*/
|
|
96455
96532
|
readonly parentTable: Word.Table;
|
|
96456
96533
|
/**
|
|
96457
|
-
* Gets the table cell that contains this table. Throws an `ItemNotFound` error if it
|
|
96534
|
+
* Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell.
|
|
96458
96535
|
*
|
|
96459
96536
|
* @remarks
|
|
96460
96537
|
* [Api set: WordApi 1.3]
|
|
@@ -96704,7 +96781,7 @@ declare namespace Word {
|
|
|
96704
96781
|
*/
|
|
96705
96782
|
getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder;
|
|
96706
96783
|
/**
|
|
96707
|
-
* Gets the table cell at a specified row and column. Throws an `ItemNotFound` error if the specified table cell
|
|
96784
|
+
* Gets the table cell at a specified row and column. Throws an `ItemNotFound` error if the specified table cell doesn't exist.
|
|
96708
96785
|
*
|
|
96709
96786
|
* @remarks
|
|
96710
96787
|
* [Api set: WordApi 1.3]
|
|
@@ -96928,8 +97005,7 @@ declare namespace Word {
|
|
|
96928
97005
|
* Represents the TableStyle object.
|
|
96929
97006
|
*
|
|
96930
97007
|
* @remarks
|
|
96931
|
-
* [Api set: WordApi
|
|
96932
|
-
* @beta
|
|
97008
|
+
* [Api set: WordApi 1.6]
|
|
96933
97009
|
*/
|
|
96934
97010
|
class TableStyle extends OfficeExtension.ClientObject {
|
|
96935
97011
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -96954,40 +97030,35 @@ declare namespace Word {
|
|
|
96954
97030
|
* Specifies the amount of space to add between the contents and the bottom borders of the cells.
|
|
96955
97031
|
*
|
|
96956
97032
|
* @remarks
|
|
96957
|
-
* [Api set: WordApi
|
|
96958
|
-
* @beta
|
|
97033
|
+
* [Api set: WordApi 1.6]
|
|
96959
97034
|
*/
|
|
96960
97035
|
bottomCellMargin: number;
|
|
96961
97036
|
/**
|
|
96962
97037
|
* Specifies the spacing (in points) between the cells in a table style.
|
|
96963
97038
|
*
|
|
96964
97039
|
* @remarks
|
|
96965
|
-
* [Api set: WordApi
|
|
96966
|
-
* @beta
|
|
97040
|
+
* [Api set: WordApi 1.6]
|
|
96967
97041
|
*/
|
|
96968
97042
|
cellSpacing: number;
|
|
96969
97043
|
/**
|
|
96970
97044
|
* Specifies the amount of space to add between the contents and the left borders of the cells.
|
|
96971
97045
|
*
|
|
96972
97046
|
* @remarks
|
|
96973
|
-
* [Api set: WordApi
|
|
96974
|
-
* @beta
|
|
97047
|
+
* [Api set: WordApi 1.6]
|
|
96975
97048
|
*/
|
|
96976
97049
|
leftCellMargin: number;
|
|
96977
97050
|
/**
|
|
96978
97051
|
* Specifies the amount of space to add between the contents and the right borders of the cells.
|
|
96979
97052
|
*
|
|
96980
97053
|
* @remarks
|
|
96981
|
-
* [Api set: WordApi
|
|
96982
|
-
* @beta
|
|
97054
|
+
* [Api set: WordApi 1.6]
|
|
96983
97055
|
*/
|
|
96984
97056
|
rightCellMargin: number;
|
|
96985
97057
|
/**
|
|
96986
97058
|
* Specifies the amount of space to add between the contents and the top borders of the cells.
|
|
96987
97059
|
*
|
|
96988
97060
|
* @remarks
|
|
96989
|
-
* [Api set: WordApi
|
|
96990
|
-
* @beta
|
|
97061
|
+
* [Api set: WordApi 1.6]
|
|
96991
97062
|
*/
|
|
96992
97063
|
topCellMargin: number;
|
|
96993
97064
|
/**
|
|
@@ -97822,82 +97893,72 @@ declare namespace Word {
|
|
|
97822
97893
|
* Represents a tracked change in a Word document.
|
|
97823
97894
|
*
|
|
97824
97895
|
* @remarks
|
|
97825
|
-
* [Api set: WordApi
|
|
97826
|
-
* @beta
|
|
97896
|
+
* [Api set: WordApi 1.6]
|
|
97827
97897
|
*/
|
|
97828
97898
|
class TrackedChange extends OfficeExtension.ClientObject {
|
|
97829
97899
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
97830
97900
|
context: RequestContext;
|
|
97831
97901
|
/**
|
|
97832
|
-
*
|
|
97902
|
+
* Gets the author of the tracked change.
|
|
97833
97903
|
*
|
|
97834
97904
|
* @remarks
|
|
97835
|
-
* [Api set: WordApi
|
|
97836
|
-
* @beta
|
|
97905
|
+
* [Api set: WordApi 1.6]
|
|
97837
97906
|
*/
|
|
97838
97907
|
readonly author: string;
|
|
97839
97908
|
/**
|
|
97840
|
-
*
|
|
97909
|
+
* Gets the date of the tracked change.
|
|
97841
97910
|
*
|
|
97842
97911
|
* @remarks
|
|
97843
|
-
* [Api set: WordApi
|
|
97844
|
-
* @beta
|
|
97912
|
+
* [Api set: WordApi 1.6]
|
|
97845
97913
|
*/
|
|
97846
97914
|
readonly date: Date;
|
|
97847
97915
|
/**
|
|
97848
|
-
*
|
|
97916
|
+
* Gets the text of the tracked change.
|
|
97849
97917
|
*
|
|
97850
97918
|
* @remarks
|
|
97851
|
-
* [Api set: WordApi
|
|
97852
|
-
* @beta
|
|
97919
|
+
* [Api set: WordApi 1.6]
|
|
97853
97920
|
*/
|
|
97854
97921
|
readonly text: string;
|
|
97855
97922
|
/**
|
|
97856
|
-
*
|
|
97923
|
+
* Gets the type of the tracked change.
|
|
97857
97924
|
*
|
|
97858
97925
|
* @remarks
|
|
97859
|
-
* [Api set: WordApi
|
|
97860
|
-
* @beta
|
|
97926
|
+
* [Api set: WordApi 1.6]
|
|
97861
97927
|
*/
|
|
97862
97928
|
readonly type: Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted";
|
|
97863
97929
|
/**
|
|
97864
97930
|
* Accepts the tracked change.
|
|
97865
97931
|
*
|
|
97866
97932
|
* @remarks
|
|
97867
|
-
* [Api set: WordApi
|
|
97868
|
-
* @beta
|
|
97933
|
+
* [Api set: WordApi 1.6]
|
|
97869
97934
|
*/
|
|
97870
97935
|
accept(): void;
|
|
97871
97936
|
/**
|
|
97872
97937
|
* Gets the next tracked change. Throws an `ItemNotFound` error if this tracked change is the last one.
|
|
97873
97938
|
*
|
|
97874
97939
|
* @remarks
|
|
97875
|
-
* [Api set: WordApi
|
|
97876
|
-
* @beta
|
|
97940
|
+
* [Api set: WordApi 1.6]
|
|
97877
97941
|
*/
|
|
97878
97942
|
getNext(): Word.TrackedChange;
|
|
97879
97943
|
/**
|
|
97880
97944
|
* 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}.
|
|
97881
97945
|
*
|
|
97882
97946
|
* @remarks
|
|
97883
|
-
* [Api set: WordApi
|
|
97884
|
-
* @beta
|
|
97947
|
+
* [Api set: WordApi 1.6]
|
|
97885
97948
|
*/
|
|
97886
97949
|
getNextOrNullObject(): Word.TrackedChange;
|
|
97887
97950
|
/**
|
|
97888
97951
|
* Gets the range of the tracked change.
|
|
97889
97952
|
*
|
|
97890
97953
|
* @remarks
|
|
97891
|
-
* [Api set: WordApi
|
|
97892
|
-
* @beta
|
|
97954
|
+
* [Api set: WordApi 1.6]
|
|
97893
97955
|
*/
|
|
97894
97956
|
getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range;
|
|
97895
97957
|
/**
|
|
97896
97958
|
* Rejects the tracked change.
|
|
97897
97959
|
*
|
|
97898
97960
|
* @remarks
|
|
97899
|
-
* [Api set: WordApi
|
|
97900
|
-
* @beta
|
|
97961
|
+
* [Api set: WordApi 1.6]
|
|
97901
97962
|
*/
|
|
97902
97963
|
reject(): void;
|
|
97903
97964
|
/**
|
|
@@ -97939,8 +98000,7 @@ declare namespace Word {
|
|
|
97939
98000
|
* Contains a collection of {@link Word.TrackedChange} objects.
|
|
97940
98001
|
*
|
|
97941
98002
|
* @remarks
|
|
97942
|
-
* [Api set: WordApi
|
|
97943
|
-
* @beta
|
|
98003
|
+
* [Api set: WordApi 1.6]
|
|
97944
98004
|
*/
|
|
97945
98005
|
class TrackedChangeCollection extends OfficeExtension.ClientObject {
|
|
97946
98006
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -97951,50 +98011,28 @@ declare namespace Word {
|
|
|
97951
98011
|
* Accepts all the tracked changes in the collection.
|
|
97952
98012
|
*
|
|
97953
98013
|
* @remarks
|
|
97954
|
-
* [Api set: WordApi
|
|
97955
|
-
* @beta
|
|
98014
|
+
* [Api set: WordApi 1.6]
|
|
97956
98015
|
*/
|
|
97957
98016
|
acceptAll(): void;
|
|
97958
|
-
/**
|
|
97959
|
-
* Gets the number of TrackedChange objects in the collection.
|
|
97960
|
-
*
|
|
97961
|
-
* @remarks
|
|
97962
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97963
|
-
* @beta
|
|
97964
|
-
*/
|
|
97965
|
-
getCount(): OfficeExtension.ClientResult<number>;
|
|
97966
98017
|
/**
|
|
97967
98018
|
* Gets the first TrackedChange in this collection. Throws an `ItemNotFound` error if this collection is empty.
|
|
97968
98019
|
*
|
|
97969
98020
|
* @remarks
|
|
97970
|
-
* [Api set: WordApi
|
|
97971
|
-
* @beta
|
|
98021
|
+
* [Api set: WordApi 1.6]
|
|
97972
98022
|
*/
|
|
97973
98023
|
getFirst(): Word.TrackedChange;
|
|
97974
98024
|
/**
|
|
97975
98025
|
* 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}.
|
|
97976
98026
|
*
|
|
97977
98027
|
* @remarks
|
|
97978
|
-
* [Api set: WordApi
|
|
97979
|
-
* @beta
|
|
98028
|
+
* [Api set: WordApi 1.6]
|
|
97980
98029
|
*/
|
|
97981
98030
|
getFirstOrNullObject(): Word.TrackedChange;
|
|
97982
|
-
/**
|
|
97983
|
-
* Gets a TrackedChange object by its index in the collection.
|
|
97984
|
-
*
|
|
97985
|
-
* @remarks
|
|
97986
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97987
|
-
* @beta
|
|
97988
|
-
*
|
|
97989
|
-
* @param index A number that identifies the index location of a TrackedChange object.
|
|
97990
|
-
*/
|
|
97991
|
-
getItem(index: number): Word.TrackedChange;
|
|
97992
98031
|
/**
|
|
97993
98032
|
* Rejects all the tracked changes in the collection.
|
|
97994
98033
|
*
|
|
97995
98034
|
* @remarks
|
|
97996
|
-
* [Api set: WordApi
|
|
97997
|
-
* @beta
|
|
98035
|
+
* [Api set: WordApi 1.6]
|
|
97998
98036
|
*/
|
|
97999
98037
|
rejectAll(): void;
|
|
98000
98038
|
/**
|
|
@@ -98105,36 +98143,31 @@ declare namespace Word {
|
|
|
98105
98143
|
* TrackedChange type.
|
|
98106
98144
|
*
|
|
98107
98145
|
* @remarks
|
|
98108
|
-
* [Api set: WordApi
|
|
98109
|
-
* @beta
|
|
98146
|
+
* [Api set: WordApi 1.6]
|
|
98110
98147
|
*/
|
|
98111
98148
|
enum TrackedChangeType {
|
|
98112
98149
|
/**
|
|
98113
98150
|
* No revision.
|
|
98114
98151
|
* @remarks
|
|
98115
|
-
* [Api set: WordApi
|
|
98116
|
-
* @beta
|
|
98152
|
+
* [Api set: WordApi 1.6]
|
|
98117
98153
|
*/
|
|
98118
98154
|
none = "None",
|
|
98119
98155
|
/**
|
|
98120
98156
|
* Add change.
|
|
98121
98157
|
* @remarks
|
|
98122
|
-
* [Api set: WordApi
|
|
98123
|
-
* @beta
|
|
98158
|
+
* [Api set: WordApi 1.6]
|
|
98124
98159
|
*/
|
|
98125
98160
|
added = "Added",
|
|
98126
98161
|
/**
|
|
98127
98162
|
* Delete change.
|
|
98128
98163
|
* @remarks
|
|
98129
|
-
* [Api set: WordApi
|
|
98130
|
-
* @beta
|
|
98164
|
+
* [Api set: WordApi 1.6]
|
|
98131
98165
|
*/
|
|
98132
98166
|
deleted = "Deleted",
|
|
98133
98167
|
/**
|
|
98134
98168
|
* Format change.
|
|
98135
98169
|
* @remarks
|
|
98136
|
-
* [Api set: WordApi
|
|
98137
|
-
* @beta
|
|
98170
|
+
* [Api set: WordApi 1.6]
|
|
98138
98171
|
*/
|
|
98139
98172
|
formatted = "Formatted",
|
|
98140
98173
|
}
|
|
@@ -98237,22 +98270,19 @@ declare namespace Word {
|
|
|
98237
98270
|
/**
|
|
98238
98271
|
* Represents that one or more new paragraphs were added.
|
|
98239
98272
|
* @remarks
|
|
98240
|
-
* [Api set: WordApi
|
|
98241
|
-
* @beta
|
|
98273
|
+
* [Api set: WordApi 1.6]
|
|
98242
98274
|
*/
|
|
98243
98275
|
paragraphAdded = "ParagraphAdded",
|
|
98244
98276
|
/**
|
|
98245
98277
|
* Represents that one or more paragraphs were changed.
|
|
98246
98278
|
* @remarks
|
|
98247
|
-
* [Api set: WordApi
|
|
98248
|
-
* @beta
|
|
98279
|
+
* [Api set: WordApi 1.6]
|
|
98249
98280
|
*/
|
|
98250
98281
|
paragraphChanged = "ParagraphChanged",
|
|
98251
98282
|
/**
|
|
98252
98283
|
* Represents that one or more paragraphs were deleted.
|
|
98253
98284
|
* @remarks
|
|
98254
|
-
* [Api set: WordApi
|
|
98255
|
-
* @beta
|
|
98285
|
+
* [Api set: WordApi 1.6]
|
|
98256
98286
|
*/
|
|
98257
98287
|
paragraphDeleted = "ParagraphDeleted",
|
|
98258
98288
|
/**
|
|
@@ -98521,32 +98551,28 @@ declare namespace Word {
|
|
|
98521
98551
|
* Provides information about the paragraphs that raised the paragraphAdded event.
|
|
98522
98552
|
*
|
|
98523
98553
|
* @remarks
|
|
98524
|
-
* [Api set: WordApi
|
|
98525
|
-
* @beta
|
|
98554
|
+
* [Api set: WordApi 1.6]
|
|
98526
98555
|
*/
|
|
98527
98556
|
interface ParagraphAddedEventArgs {
|
|
98528
98557
|
/**
|
|
98529
98558
|
* The source of the event. It can be local or remote (through coauthoring).
|
|
98530
98559
|
*
|
|
98531
98560
|
* @remarks
|
|
98532
|
-
* [Api set: WordApi
|
|
98533
|
-
* @beta
|
|
98561
|
+
* [Api set: WordApi 1.6]
|
|
98534
98562
|
*/
|
|
98535
98563
|
source: Word.EventSource | "Local" | "Remote";
|
|
98536
98564
|
/**
|
|
98537
98565
|
* The event type. See Word.EventType for details.
|
|
98538
98566
|
*
|
|
98539
98567
|
* @remarks
|
|
98540
|
-
* [Api set: WordApi
|
|
98541
|
-
* @beta
|
|
98568
|
+
* [Api set: WordApi 1.6]
|
|
98542
98569
|
*/
|
|
98543
98570
|
type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved";
|
|
98544
98571
|
/**
|
|
98545
98572
|
* 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.
|
|
98546
98573
|
*
|
|
98547
98574
|
* @remarks
|
|
98548
|
-
* [Api set: WordApi
|
|
98549
|
-
* @beta
|
|
98575
|
+
* [Api set: WordApi 1.6]
|
|
98550
98576
|
*/
|
|
98551
98577
|
uniqueLocalIds: string[];
|
|
98552
98578
|
}
|
|
@@ -98554,32 +98580,28 @@ declare namespace Word {
|
|
|
98554
98580
|
* Provides information about the paragraphs that raised the paragraphChanged event.
|
|
98555
98581
|
*
|
|
98556
98582
|
* @remarks
|
|
98557
|
-
* [Api set: WordApi
|
|
98558
|
-
* @beta
|
|
98583
|
+
* [Api set: WordApi 1.6]
|
|
98559
98584
|
*/
|
|
98560
98585
|
interface ParagraphChangedEventArgs {
|
|
98561
98586
|
/**
|
|
98562
98587
|
* The source of the event. It can be local or remote (through coauthoring).
|
|
98563
98588
|
*
|
|
98564
98589
|
* @remarks
|
|
98565
|
-
* [Api set: WordApi
|
|
98566
|
-
* @beta
|
|
98590
|
+
* [Api set: WordApi 1.6]
|
|
98567
98591
|
*/
|
|
98568
98592
|
source: Word.EventSource | "Local" | "Remote";
|
|
98569
98593
|
/**
|
|
98570
98594
|
* The event type. See Word.EventType for details.
|
|
98571
98595
|
*
|
|
98572
98596
|
* @remarks
|
|
98573
|
-
* [Api set: WordApi
|
|
98574
|
-
* @beta
|
|
98597
|
+
* [Api set: WordApi 1.6]
|
|
98575
98598
|
*/
|
|
98576
98599
|
type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved";
|
|
98577
98600
|
/**
|
|
98578
98601
|
* 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.
|
|
98579
98602
|
*
|
|
98580
98603
|
* @remarks
|
|
98581
|
-
* [Api set: WordApi
|
|
98582
|
-
* @beta
|
|
98604
|
+
* [Api set: WordApi 1.6]
|
|
98583
98605
|
*/
|
|
98584
98606
|
uniqueLocalIds: string[];
|
|
98585
98607
|
}
|
|
@@ -98587,32 +98609,28 @@ declare namespace Word {
|
|
|
98587
98609
|
* Provides information about the paragraphs that raised the paragraphDeleted event.
|
|
98588
98610
|
*
|
|
98589
98611
|
* @remarks
|
|
98590
|
-
* [Api set: WordApi
|
|
98591
|
-
* @beta
|
|
98612
|
+
* [Api set: WordApi 1.6]
|
|
98592
98613
|
*/
|
|
98593
98614
|
interface ParagraphDeletedEventArgs {
|
|
98594
98615
|
/**
|
|
98595
98616
|
* The source of the event. It can be local or remote (through coauthoring).
|
|
98596
98617
|
*
|
|
98597
98618
|
* @remarks
|
|
98598
|
-
* [Api set: WordApi
|
|
98599
|
-
* @beta
|
|
98619
|
+
* [Api set: WordApi 1.6]
|
|
98600
98620
|
*/
|
|
98601
98621
|
source: Word.EventSource | "Local" | "Remote";
|
|
98602
98622
|
/**
|
|
98603
98623
|
* The event type. See Word.EventType for details.
|
|
98604
98624
|
*
|
|
98605
98625
|
* @remarks
|
|
98606
|
-
* [Api set: WordApi
|
|
98607
|
-
* @beta
|
|
98626
|
+
* [Api set: WordApi 1.6]
|
|
98608
98627
|
*/
|
|
98609
98628
|
type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved";
|
|
98610
98629
|
/**
|
|
98611
98630
|
* 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.
|
|
98612
98631
|
*
|
|
98613
98632
|
* @remarks
|
|
98614
|
-
* [Api set: WordApi
|
|
98615
|
-
* @beta
|
|
98633
|
+
* [Api set: WordApi 1.6]
|
|
98616
98634
|
*/
|
|
98617
98635
|
uniqueLocalIds: string[];
|
|
98618
98636
|
}
|
|
@@ -98859,7 +98877,7 @@ declare namespace Word {
|
|
|
98859
98877
|
*/
|
|
98860
98878
|
tags = "Tags",
|
|
98861
98879
|
/**
|
|
98862
|
-
* Represents a content control that
|
|
98880
|
+
* Represents a content control that isn't shown.
|
|
98863
98881
|
* @remarks
|
|
98864
98882
|
* [Api set: WordApi 1.1]
|
|
98865
98883
|
*/
|
|
@@ -99364,13 +99382,13 @@ declare namespace Word {
|
|
|
99364
99382
|
*/
|
|
99365
99383
|
equal = "Equal",
|
|
99366
99384
|
/**
|
|
99367
|
-
* Indicates that this instance contains the range and that it shares the same start character. The range
|
|
99385
|
+
* 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.
|
|
99368
99386
|
* @remarks
|
|
99369
99387
|
* [Api set: WordApi 1.3]
|
|
99370
99388
|
*/
|
|
99371
99389
|
containsStart = "ContainsStart",
|
|
99372
99390
|
/**
|
|
99373
|
-
* Indicates that this instance contains the range and that it shares the same end character. The range
|
|
99391
|
+
* 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.
|
|
99374
99392
|
* @remarks
|
|
99375
99393
|
* [Api set: WordApi 1.3]
|
|
99376
99394
|
*/
|
|
@@ -99382,19 +99400,19 @@ declare namespace Word {
|
|
|
99382
99400
|
*/
|
|
99383
99401
|
contains = "Contains",
|
|
99384
99402
|
/**
|
|
99385
|
-
* Indicates that this instance is inside the range and that it shares the same start character. The range
|
|
99403
|
+
* 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.
|
|
99386
99404
|
* @remarks
|
|
99387
99405
|
* [Api set: WordApi 1.3]
|
|
99388
99406
|
*/
|
|
99389
99407
|
insideStart = "InsideStart",
|
|
99390
99408
|
/**
|
|
99391
|
-
* Indicates that this instance is inside the range and that it shares the same end character. The range
|
|
99409
|
+
* 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.
|
|
99392
99410
|
* @remarks
|
|
99393
99411
|
* [Api set: WordApi 1.3]
|
|
99394
99412
|
*/
|
|
99395
99413
|
insideEnd = "InsideEnd",
|
|
99396
99414
|
/**
|
|
99397
|
-
* Indicates that this instance is inside the range. The range
|
|
99415
|
+
* Indicates that this instance is inside the range. The range doesn't share the same start and end characters as this instance.
|
|
99398
99416
|
* @remarks
|
|
99399
99417
|
* [Api set: WordApi 1.3]
|
|
99400
99418
|
*/
|
|
@@ -99406,7 +99424,7 @@ declare namespace Word {
|
|
|
99406
99424
|
*/
|
|
99407
99425
|
adjacentBefore = "AdjacentBefore",
|
|
99408
99426
|
/**
|
|
99409
|
-
* Indicates that this instance starts before the range and overlaps the range
|
|
99427
|
+
* Indicates that this instance starts before the range and overlaps the range's first character.
|
|
99410
99428
|
* @remarks
|
|
99411
99429
|
* [Api set: WordApi 1.3]
|
|
99412
99430
|
*/
|
|
@@ -99513,197 +99531,6 @@ declare namespace Word {
|
|
|
99513
99531
|
*/
|
|
99514
99532
|
right = "Right",
|
|
99515
99533
|
}
|
|
99516
|
-
/**
|
|
99517
|
-
* Represents the line style for the specified border.
|
|
99518
|
-
*
|
|
99519
|
-
* @remarks
|
|
99520
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99521
|
-
* @beta
|
|
99522
|
-
*/
|
|
99523
|
-
enum LineStyle {
|
|
99524
|
-
/**
|
|
99525
|
-
* Represents the dash-dot line style.
|
|
99526
|
-
* @remarks
|
|
99527
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99528
|
-
* @beta
|
|
99529
|
-
*/
|
|
99530
|
-
dashDot = "DashDot",
|
|
99531
|
-
/**
|
|
99532
|
-
* Represents the dash-dot-dot line style.
|
|
99533
|
-
* @remarks
|
|
99534
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99535
|
-
* @beta
|
|
99536
|
-
*/
|
|
99537
|
-
dashDotDot = "DashDotDot",
|
|
99538
|
-
/**
|
|
99539
|
-
* Represents the dash-dot-stroked line style.
|
|
99540
|
-
* @remarks
|
|
99541
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99542
|
-
* @beta
|
|
99543
|
-
*/
|
|
99544
|
-
dashDotStroked = "DashDotStroked",
|
|
99545
|
-
/**
|
|
99546
|
-
* Represents the line style of dashes with large gaps.
|
|
99547
|
-
* @remarks
|
|
99548
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99549
|
-
* @beta
|
|
99550
|
-
*/
|
|
99551
|
-
dashLargeGap = "DashLargeGap",
|
|
99552
|
-
/**
|
|
99553
|
-
* Represents the line style of dashes with small gaps.
|
|
99554
|
-
* @remarks
|
|
99555
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99556
|
-
* @beta
|
|
99557
|
-
*/
|
|
99558
|
-
dashSmallGap = "DashSmallGap",
|
|
99559
|
-
/**
|
|
99560
|
-
* Represents the dot line style.
|
|
99561
|
-
* @remarks
|
|
99562
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99563
|
-
* @beta
|
|
99564
|
-
*/
|
|
99565
|
-
dot = "Dot",
|
|
99566
|
-
/**
|
|
99567
|
-
* Represents the double line style.
|
|
99568
|
-
* @remarks
|
|
99569
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99570
|
-
* @beta
|
|
99571
|
-
*/
|
|
99572
|
-
double = "Double",
|
|
99573
|
-
/**
|
|
99574
|
-
* Represents the double-wavy line style.
|
|
99575
|
-
* @remarks
|
|
99576
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99577
|
-
* @beta
|
|
99578
|
-
*/
|
|
99579
|
-
doubleWavy = "DoubleWavy",
|
|
99580
|
-
/**
|
|
99581
|
-
* Represents the emboss-3D line style.
|
|
99582
|
-
* @remarks
|
|
99583
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99584
|
-
* @beta
|
|
99585
|
-
*/
|
|
99586
|
-
emboss3D = "Emboss3D",
|
|
99587
|
-
/**
|
|
99588
|
-
* Represents the engrave-3D line style.
|
|
99589
|
-
* @remarks
|
|
99590
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99591
|
-
* @beta
|
|
99592
|
-
*/
|
|
99593
|
-
engrave3D = "Engrave3D",
|
|
99594
|
-
/**
|
|
99595
|
-
* Represents the inset line style.
|
|
99596
|
-
* @remarks
|
|
99597
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99598
|
-
* @beta
|
|
99599
|
-
*/
|
|
99600
|
-
inset = "Inset",
|
|
99601
|
-
/**
|
|
99602
|
-
* Mixed line style.
|
|
99603
|
-
* @remarks
|
|
99604
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99605
|
-
* @beta
|
|
99606
|
-
*/
|
|
99607
|
-
mixed = "Mixed",
|
|
99608
|
-
/**
|
|
99609
|
-
* Represents that there's no line style.
|
|
99610
|
-
* @remarks
|
|
99611
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99612
|
-
* @beta
|
|
99613
|
-
*/
|
|
99614
|
-
none = "None",
|
|
99615
|
-
/**
|
|
99616
|
-
* Represents the outset line style.
|
|
99617
|
-
* @remarks
|
|
99618
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99619
|
-
* @beta
|
|
99620
|
-
*/
|
|
99621
|
-
outset = "Outset",
|
|
99622
|
-
/**
|
|
99623
|
-
* Represents the single line style.
|
|
99624
|
-
* @remarks
|
|
99625
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99626
|
-
* @beta
|
|
99627
|
-
*/
|
|
99628
|
-
single = "Single",
|
|
99629
|
-
/**
|
|
99630
|
-
* Represents the single-wavy line style.
|
|
99631
|
-
* @remarks
|
|
99632
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99633
|
-
* @beta
|
|
99634
|
-
*/
|
|
99635
|
-
singleWavy = "SingleWavy",
|
|
99636
|
-
/**
|
|
99637
|
-
* Represents the internal single thick solid line surrounded by a single thin solid line with a large gap between them.
|
|
99638
|
-
* @remarks
|
|
99639
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99640
|
-
* @beta
|
|
99641
|
-
*/
|
|
99642
|
-
thickThinLargeGap = "ThickThinLargeGap",
|
|
99643
|
-
/**
|
|
99644
|
-
* Represents the internal single thick solid line surrounded by a single thin solid line with a medium gap between them.
|
|
99645
|
-
* @remarks
|
|
99646
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99647
|
-
* @beta
|
|
99648
|
-
*/
|
|
99649
|
-
thickThinMedGap = "ThickThinMedGap",
|
|
99650
|
-
/**
|
|
99651
|
-
* Represents the internal single thick solid line surrounded by a single thin solid line with a small gap between them.
|
|
99652
|
-
* @remarks
|
|
99653
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99654
|
-
* @beta
|
|
99655
|
-
*/
|
|
99656
|
-
thickThinSmallGap = "ThickThinSmallGap",
|
|
99657
|
-
/**
|
|
99658
|
-
* Represents the internal single thin solid line surrounded by a single thick solid line with a large gap between them.
|
|
99659
|
-
* @remarks
|
|
99660
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99661
|
-
* @beta
|
|
99662
|
-
*/
|
|
99663
|
-
thinThickLargeGap = "ThinThickLargeGap",
|
|
99664
|
-
/**
|
|
99665
|
-
* Represents the internal single thin solid line surrounded by a single thick solid line with a medium gap between them.
|
|
99666
|
-
* @remarks
|
|
99667
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99668
|
-
* @beta
|
|
99669
|
-
*/
|
|
99670
|
-
thinThickMedGap = "ThinThickMedGap",
|
|
99671
|
-
/**
|
|
99672
|
-
* Represents the internal single thin solid line surrounded by a single thick solid line with a small gap between them.
|
|
99673
|
-
* @remarks
|
|
99674
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99675
|
-
* @beta
|
|
99676
|
-
*/
|
|
99677
|
-
thinThickSmallGap = "ThinThickSmallGap",
|
|
99678
|
-
/**
|
|
99679
|
-
* Represents the internal single thin solid line surrounded by a single thick solid line surrounded by a single thin solid line with a large gap between all lines.
|
|
99680
|
-
* @remarks
|
|
99681
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99682
|
-
* @beta
|
|
99683
|
-
*/
|
|
99684
|
-
thinThickThinLargeGap = "ThinThickThinLargeGap",
|
|
99685
|
-
/**
|
|
99686
|
-
* Represents the internal single thin solid line surrounded by a single thick solid line surrounded by a single thin solid line with a medium gap between all lines.
|
|
99687
|
-
* @remarks
|
|
99688
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99689
|
-
* @beta
|
|
99690
|
-
*/
|
|
99691
|
-
thinThickThinMedGap = "ThinThickThinMedGap",
|
|
99692
|
-
/**
|
|
99693
|
-
* Represents the internal single thin solid line surrounded by a single thick solid line surrounded by a single thin solid line with a small gap between all lines.
|
|
99694
|
-
* @remarks
|
|
99695
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99696
|
-
* @beta
|
|
99697
|
-
*/
|
|
99698
|
-
thinThickThinSmallGap = "ThinThickThinSmallGap",
|
|
99699
|
-
/**
|
|
99700
|
-
* Represents the triple line style.
|
|
99701
|
-
* @remarks
|
|
99702
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99703
|
-
* @beta
|
|
99704
|
-
*/
|
|
99705
|
-
triple = "Triple",
|
|
99706
|
-
}
|
|
99707
99534
|
/**
|
|
99708
99535
|
* Represents the width of a style's border.
|
|
99709
99536
|
*
|
|
@@ -99711,7 +99538,7 @@ declare namespace Word {
|
|
|
99711
99538
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99712
99539
|
* @beta
|
|
99713
99540
|
*/
|
|
99714
|
-
enum
|
|
99541
|
+
enum BorderWidth {
|
|
99715
99542
|
/**
|
|
99716
99543
|
* None width.
|
|
99717
99544
|
* @remarks
|
|
@@ -99790,71 +99617,6 @@ declare namespace Word {
|
|
|
99790
99617
|
*/
|
|
99791
99618
|
mixed = "Mixed",
|
|
99792
99619
|
}
|
|
99793
|
-
/**
|
|
99794
|
-
* Represents the position of a style's border.
|
|
99795
|
-
*
|
|
99796
|
-
* @remarks
|
|
99797
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99798
|
-
* @beta
|
|
99799
|
-
*/
|
|
99800
|
-
enum BorderPositionType {
|
|
99801
|
-
/**
|
|
99802
|
-
* Represents the top border.
|
|
99803
|
-
* @remarks
|
|
99804
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99805
|
-
* @beta
|
|
99806
|
-
*/
|
|
99807
|
-
top = "Top",
|
|
99808
|
-
/**
|
|
99809
|
-
* Represents the left border.
|
|
99810
|
-
* @remarks
|
|
99811
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99812
|
-
* @beta
|
|
99813
|
-
*/
|
|
99814
|
-
left = "Left",
|
|
99815
|
-
/**
|
|
99816
|
-
* Represents the bottom border.
|
|
99817
|
-
* @remarks
|
|
99818
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99819
|
-
* @beta
|
|
99820
|
-
*/
|
|
99821
|
-
bottom = "Bottom",
|
|
99822
|
-
/**
|
|
99823
|
-
* Represents the right border.
|
|
99824
|
-
* @remarks
|
|
99825
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99826
|
-
* @beta
|
|
99827
|
-
*/
|
|
99828
|
-
right = "Right",
|
|
99829
|
-
/**
|
|
99830
|
-
* Represents the horizontal borders.
|
|
99831
|
-
* @remarks
|
|
99832
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99833
|
-
* @beta
|
|
99834
|
-
*/
|
|
99835
|
-
horizontal = "Horizontal",
|
|
99836
|
-
/**
|
|
99837
|
-
* Represents the vertical borders.
|
|
99838
|
-
* @remarks
|
|
99839
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99840
|
-
* @beta
|
|
99841
|
-
*/
|
|
99842
|
-
vertical = "Vertical",
|
|
99843
|
-
/**
|
|
99844
|
-
* Represents the diagonal borders starting in the upper-left corner.
|
|
99845
|
-
* @remarks
|
|
99846
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99847
|
-
* @beta
|
|
99848
|
-
*/
|
|
99849
|
-
diagonalDown = "DiagonalDown",
|
|
99850
|
-
/**
|
|
99851
|
-
* Represents the diagonal borders starting in the lower-left corner.
|
|
99852
|
-
* @remarks
|
|
99853
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99854
|
-
* @beta
|
|
99855
|
-
*/
|
|
99856
|
-
diagonalUp = "DiagonalUp",
|
|
99857
|
-
}
|
|
99858
99620
|
/**
|
|
99859
99621
|
* @remarks
|
|
99860
99622
|
* [Api set: WordApi 1.3]
|
|
@@ -100108,10 +99870,10 @@ declare namespace Word {
|
|
|
100108
99870
|
/**
|
|
100109
99871
|
* Represents the built-in style in a Word document.
|
|
100110
99872
|
*
|
|
100111
|
-
* Important: This enum was renamed from `Style` to `BuiltInStyleName` in WordApi 1.5.
|
|
100112
|
-
*
|
|
100113
99873
|
* @remarks
|
|
100114
99874
|
* [Api set: WordApi 1.3]
|
|
99875
|
+
*
|
|
99876
|
+
* Important: This enum was renamed from `Style` to `BuiltInStyleName` in WordApi 1.5.
|
|
100115
99877
|
*/
|
|
100116
99878
|
enum BuiltInStyleName {
|
|
100117
99879
|
/**
|
|
@@ -101001,7 +100763,7 @@ declare namespace Word {
|
|
|
101001
100763
|
*/
|
|
101002
100764
|
enum CloseBehavior {
|
|
101003
100765
|
/**
|
|
101004
|
-
*
|
|
100766
|
+
* Saves the changes before closing the document.
|
|
101005
100767
|
* @remarks
|
|
101006
100768
|
* [Api set: WordApi 1.5]
|
|
101007
100769
|
*/
|
|
@@ -102344,90 +102106,101 @@ declare namespace Word {
|
|
|
102344
102106
|
/** An interface for updating data on the Border object, for use in `border.set({ ... })`. */
|
|
102345
102107
|
interface BorderUpdateData {
|
|
102346
102108
|
/**
|
|
102347
|
-
* Specifies the
|
|
102109
|
+
* Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name.
|
|
102348
102110
|
*
|
|
102349
102111
|
* @remarks
|
|
102350
102112
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
102351
102113
|
* @beta
|
|
102352
102114
|
*/
|
|
102353
|
-
|
|
102115
|
+
color?: string;
|
|
102354
102116
|
/**
|
|
102355
|
-
* Specifies the
|
|
102117
|
+
* Specifies the border type for the border.
|
|
102356
102118
|
*
|
|
102357
102119
|
* @remarks
|
|
102358
102120
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
102359
102121
|
* @beta
|
|
102360
102122
|
*/
|
|
102361
|
-
|
|
102123
|
+
type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave";
|
|
102362
102124
|
/**
|
|
102363
|
-
* Specifies the
|
|
102125
|
+
* Specifies whether the border is visible.
|
|
102364
102126
|
*
|
|
102365
102127
|
* @remarks
|
|
102366
102128
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
102367
102129
|
* @beta
|
|
102368
102130
|
*/
|
|
102369
|
-
|
|
102131
|
+
visible?: boolean;
|
|
102370
102132
|
/**
|
|
102371
|
-
* Specifies
|
|
102133
|
+
* Specifies the width for the border.
|
|
102372
102134
|
*
|
|
102373
102135
|
* @remarks
|
|
102374
102136
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
102375
102137
|
* @beta
|
|
102376
102138
|
*/
|
|
102377
|
-
|
|
102139
|
+
width?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
|
|
102378
102140
|
}
|
|
102379
102141
|
/** An interface for updating data on the BorderCollection object, for use in `borderCollection.set({ ... })`. */
|
|
102380
102142
|
interface BorderCollectionUpdateData {
|
|
102381
102143
|
/**
|
|
102382
|
-
* Specifies the 24-bit color of the inside borders.
|
|
102144
|
+
* Specifies the 24-bit color of the inside borders. Color is specified in ‘#RRGGBB’ format or by using the color name.
|
|
102383
102145
|
*
|
|
102384
102146
|
* @remarks
|
|
102385
102147
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
102386
102148
|
* @beta
|
|
102387
102149
|
*/
|
|
102388
|
-
|
|
102150
|
+
insideBorderColor?: string;
|
|
102389
102151
|
/**
|
|
102390
|
-
* Specifies the
|
|
102152
|
+
* Specifies the border type of the inside borders.
|
|
102391
102153
|
*
|
|
102392
102154
|
* @remarks
|
|
102393
102155
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
102394
102156
|
* @beta
|
|
102395
102157
|
*/
|
|
102396
|
-
|
|
102158
|
+
insideBorderType?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave";
|
|
102397
102159
|
/**
|
|
102398
|
-
* Specifies the
|
|
102160
|
+
* Specifies the width of the inside borders.
|
|
102399
102161
|
*
|
|
102400
102162
|
* @remarks
|
|
102401
102163
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
102402
102164
|
* @beta
|
|
102403
102165
|
*/
|
|
102404
|
-
|
|
102166
|
+
insideBorderWidth?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
|
|
102405
102167
|
/**
|
|
102406
|
-
* Specifies the 24-bit color of the outside borders.
|
|
102168
|
+
* Specifies the 24-bit color of the outside borders. Color is specified in ‘#RRGGBB’ format or by using the color name.
|
|
102407
102169
|
*
|
|
102408
102170
|
* @remarks
|
|
102409
102171
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
102410
102172
|
* @beta
|
|
102411
102173
|
*/
|
|
102412
|
-
|
|
102174
|
+
outsideBorderColor?: string;
|
|
102413
102175
|
/**
|
|
102414
|
-
* Specifies the
|
|
102176
|
+
* Specifies the border type of the outside borders.
|
|
102415
102177
|
*
|
|
102416
102178
|
* @remarks
|
|
102417
102179
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
102418
102180
|
* @beta
|
|
102419
102181
|
*/
|
|
102420
|
-
|
|
102182
|
+
outsideBorderType?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave";
|
|
102421
102183
|
/**
|
|
102422
|
-
* Specifies the
|
|
102184
|
+
* Specifies the width of the outside borders.
|
|
102423
102185
|
*
|
|
102424
102186
|
* @remarks
|
|
102425
102187
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
102426
102188
|
* @beta
|
|
102427
102189
|
*/
|
|
102428
|
-
|
|
102190
|
+
outsideBorderWidth?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
|
|
102429
102191
|
items?: Word.Interfaces.BorderData[];
|
|
102430
102192
|
}
|
|
102193
|
+
/** An interface for updating data on the CheckboxContentControl object, for use in `checkboxContentControl.set({ ... })`. */
|
|
102194
|
+
interface CheckboxContentControlUpdateData {
|
|
102195
|
+
/**
|
|
102196
|
+
* Specifies the current state of the checkbox.
|
|
102197
|
+
*
|
|
102198
|
+
* @remarks
|
|
102199
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
102200
|
+
* @beta
|
|
102201
|
+
*/
|
|
102202
|
+
isChecked?: boolean;
|
|
102203
|
+
}
|
|
102431
102204
|
/** An interface for updating data on the Comment object, for use in `comment.set({ ... })`. */
|
|
102432
102205
|
interface CommentUpdateData {
|
|
102433
102206
|
/**
|
|
@@ -102487,7 +102260,7 @@ declare namespace Word {
|
|
|
102487
102260
|
*/
|
|
102488
102261
|
strikeThrough?: boolean;
|
|
102489
102262
|
/**
|
|
102490
|
-
* Specifies a value that indicates the comment text's underline type. 'None' if the comment text
|
|
102263
|
+
* Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined.
|
|
102491
102264
|
*
|
|
102492
102265
|
* @remarks
|
|
102493
102266
|
* [Api set: WordApi 1.4]
|
|
@@ -102525,11 +102298,19 @@ declare namespace Word {
|
|
|
102525
102298
|
/** An interface for updating data on the ContentControl object, for use in `contentControl.set({ ... })`. */
|
|
102526
102299
|
interface ContentControlUpdateData {
|
|
102527
102300
|
/**
|
|
102528
|
-
|
|
102529
|
-
|
|
102530
|
-
|
|
102531
|
-
|
|
102532
|
-
|
|
102301
|
+
* Specifies the checkbox-related data if the content control's type is 'CheckBox'. It's null otherwise.
|
|
102302
|
+
*
|
|
102303
|
+
* @remarks
|
|
102304
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
102305
|
+
* @beta
|
|
102306
|
+
*/
|
|
102307
|
+
checkboxContentControl?: Word.Interfaces.CheckboxContentControlUpdateData;
|
|
102308
|
+
/**
|
|
102309
|
+
* Gets the text format of the content control. Use this to get and set font name, size, color, and other properties.
|
|
102310
|
+
*
|
|
102311
|
+
* @remarks
|
|
102312
|
+
* [Api set: WordApi 1.1]
|
|
102313
|
+
*/
|
|
102533
102314
|
font?: Word.Interfaces.FontUpdateData;
|
|
102534
102315
|
/**
|
|
102535
102316
|
* Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'.
|
|
@@ -102560,7 +102341,9 @@ declare namespace Word {
|
|
|
102560
102341
|
*/
|
|
102561
102342
|
color?: string;
|
|
102562
102343
|
/**
|
|
102563
|
-
* Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty.
|
|
102344
|
+
* Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty.
|
|
102345
|
+
|
|
102346
|
+
Note: The set operation for this property isn't supported in Word on the web.
|
|
102564
102347
|
*
|
|
102565
102348
|
* @remarks
|
|
102566
102349
|
* [Api set: WordApi 1.1]
|
|
@@ -102749,6 +102532,8 @@ declare namespace Word {
|
|
|
102749
102532
|
*
|
|
102750
102533
|
* @remarks
|
|
102751
102534
|
* [Api set: WordApi 1.4]
|
|
102535
|
+
*
|
|
102536
|
+
* Note: The ability to set the code was introduced in WordApi 1.5.
|
|
102752
102537
|
*/
|
|
102753
102538
|
code?: string;
|
|
102754
102539
|
/**
|
|
@@ -102859,7 +102644,7 @@ declare namespace Word {
|
|
|
102859
102644
|
*/
|
|
102860
102645
|
superscript?: boolean;
|
|
102861
102646
|
/**
|
|
102862
|
-
* Specifies a value that indicates the font's underline type. 'None' if the font
|
|
102647
|
+
* Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined.
|
|
102863
102648
|
*
|
|
102864
102649
|
* @remarks
|
|
102865
102650
|
* [Api set: WordApi 1.1]
|
|
@@ -103066,7 +102851,7 @@ declare namespace Word {
|
|
|
103066
102851
|
*/
|
|
103067
102852
|
font?: Word.Interfaces.FontUpdateData;
|
|
103068
102853
|
/**
|
|
103069
|
-
* Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph
|
|
102854
|
+
* Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list.
|
|
103070
102855
|
*
|
|
103071
102856
|
* @remarks
|
|
103072
102857
|
* [Api set: WordApi 1.3]
|
|
@@ -103359,7 +103144,7 @@ declare namespace Word {
|
|
|
103359
103144
|
/** An interface for updating data on the Section object, for use in `section.set({ ... })`. */
|
|
103360
103145
|
interface SectionUpdateData {
|
|
103361
103146
|
/**
|
|
103362
|
-
* Gets the body object of the section. This
|
|
103147
|
+
* Gets the body object of the section. This doesn't include the header/footer and other section metadata.
|
|
103363
103148
|
*
|
|
103364
103149
|
* @remarks
|
|
103365
103150
|
* [Api set: WordApi 1.1]
|
|
@@ -103424,18 +103209,34 @@ declare namespace Word {
|
|
|
103424
103209
|
* Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
|
|
103425
103210
|
*
|
|
103426
103211
|
* @remarks
|
|
103427
|
-
* [Api set: WordApi
|
|
103428
|
-
* @beta
|
|
103212
|
+
* [Api set: WordApi 1.6]
|
|
103429
103213
|
*/
|
|
103430
103214
|
shading?: Word.Interfaces.ShadingUpdateData;
|
|
103431
103215
|
/**
|
|
103432
103216
|
* Gets a TableStyle object representing Style properties that can be applied to a table.
|
|
103433
103217
|
*
|
|
103434
103218
|
* @remarks
|
|
103435
|
-
* [Api set: WordApi
|
|
103436
|
-
* @beta
|
|
103219
|
+
* [Api set: WordApi 1.6]
|
|
103437
103220
|
*/
|
|
103438
103221
|
tableStyle?: Word.Interfaces.TableStyleUpdateData;
|
|
103222
|
+
/**
|
|
103223
|
+
* Specifies the name of an existing style to use as the base formatting of another style.
|
|
103224
|
+
*
|
|
103225
|
+
* @remarks
|
|
103226
|
+
* [Api set: WordApi 1.5]
|
|
103227
|
+
*
|
|
103228
|
+
* Note: The ability to set `baseStyle` was introduced in WordApi 1.6.
|
|
103229
|
+
*/
|
|
103230
|
+
baseStyle?: string;
|
|
103231
|
+
/**
|
|
103232
|
+
* 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.
|
|
103233
|
+
*
|
|
103234
|
+
* @remarks
|
|
103235
|
+
* [Api set: WordApi 1.5]
|
|
103236
|
+
*
|
|
103237
|
+
* Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6.
|
|
103238
|
+
*/
|
|
103239
|
+
nextParagraphStyle?: string;
|
|
103439
103240
|
/**
|
|
103440
103241
|
* Specifies the priority.
|
|
103441
103242
|
*
|
|
@@ -103471,8 +103272,7 @@ declare namespace Word {
|
|
|
103471
103272
|
* Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name.
|
|
103472
103273
|
*
|
|
103473
103274
|
* @remarks
|
|
103474
|
-
* [Api set: WordApi
|
|
103475
|
-
* @beta
|
|
103275
|
+
* [Api set: WordApi 1.6]
|
|
103476
103276
|
*/
|
|
103477
103277
|
backgroundPatternColor?: string;
|
|
103478
103278
|
/**
|
|
@@ -103622,40 +103422,35 @@ declare namespace Word {
|
|
|
103622
103422
|
* Specifies the amount of space to add between the contents and the bottom borders of the cells.
|
|
103623
103423
|
*
|
|
103624
103424
|
* @remarks
|
|
103625
|
-
* [Api set: WordApi
|
|
103626
|
-
* @beta
|
|
103425
|
+
* [Api set: WordApi 1.6]
|
|
103627
103426
|
*/
|
|
103628
103427
|
bottomCellMargin?: number;
|
|
103629
103428
|
/**
|
|
103630
103429
|
* Specifies the spacing (in points) between the cells in a table style.
|
|
103631
103430
|
*
|
|
103632
103431
|
* @remarks
|
|
103633
|
-
* [Api set: WordApi
|
|
103634
|
-
* @beta
|
|
103432
|
+
* [Api set: WordApi 1.6]
|
|
103635
103433
|
*/
|
|
103636
103434
|
cellSpacing?: number;
|
|
103637
103435
|
/**
|
|
103638
103436
|
* Specifies the amount of space to add between the contents and the left borders of the cells.
|
|
103639
103437
|
*
|
|
103640
103438
|
* @remarks
|
|
103641
|
-
* [Api set: WordApi
|
|
103642
|
-
* @beta
|
|
103439
|
+
* [Api set: WordApi 1.6]
|
|
103643
103440
|
*/
|
|
103644
103441
|
leftCellMargin?: number;
|
|
103645
103442
|
/**
|
|
103646
103443
|
* Specifies the amount of space to add between the contents and the right borders of the cells.
|
|
103647
103444
|
*
|
|
103648
103445
|
* @remarks
|
|
103649
|
-
* [Api set: WordApi
|
|
103650
|
-
* @beta
|
|
103446
|
+
* [Api set: WordApi 1.6]
|
|
103651
103447
|
*/
|
|
103652
103448
|
rightCellMargin?: number;
|
|
103653
103449
|
/**
|
|
103654
103450
|
* Specifies the amount of space to add between the contents and the top borders of the cells.
|
|
103655
103451
|
*
|
|
103656
103452
|
* @remarks
|
|
103657
|
-
* [Api set: WordApi
|
|
103658
|
-
* @beta
|
|
103453
|
+
* [Api set: WordApi 1.6]
|
|
103659
103454
|
*/
|
|
103660
103455
|
topCellMargin?: number;
|
|
103661
103456
|
}
|
|
@@ -103826,53 +103621,55 @@ declare namespace Word {
|
|
|
103826
103621
|
/** An interface describing the data returned by calling `body.toJSON()`. */
|
|
103827
103622
|
interface BodyData {
|
|
103828
103623
|
/**
|
|
103829
|
-
|
|
103830
|
-
|
|
103831
|
-
|
|
103832
|
-
|
|
103833
|
-
|
|
103624
|
+
* Gets the collection of rich text content control objects in the body.
|
|
103625
|
+
*
|
|
103626
|
+
* @remarks
|
|
103627
|
+
* [Api set: WordApi 1.1]
|
|
103628
|
+
*/
|
|
103834
103629
|
contentControls?: Word.Interfaces.ContentControlData[];
|
|
103835
103630
|
/**
|
|
103836
|
-
|
|
103837
|
-
|
|
103838
|
-
|
|
103839
|
-
|
|
103840
|
-
|
|
103631
|
+
* Gets the collection of field objects in the body.
|
|
103632
|
+
*
|
|
103633
|
+
* @remarks
|
|
103634
|
+
* [Api set: WordApi 1.4]
|
|
103635
|
+
*/
|
|
103841
103636
|
fields?: Word.Interfaces.FieldData[];
|
|
103842
103637
|
/**
|
|
103843
|
-
|
|
103844
|
-
|
|
103845
|
-
|
|
103846
|
-
|
|
103847
|
-
|
|
103638
|
+
* Gets the text format of the body. Use this to get and set font name, size, color and other properties.
|
|
103639
|
+
*
|
|
103640
|
+
* @remarks
|
|
103641
|
+
* [Api set: WordApi 1.1]
|
|
103642
|
+
*/
|
|
103848
103643
|
font?: Word.Interfaces.FontData;
|
|
103849
103644
|
/**
|
|
103850
|
-
|
|
103851
|
-
|
|
103852
|
-
|
|
103853
|
-
|
|
103854
|
-
|
|
103645
|
+
* Gets the collection of InlinePicture objects in the body. The collection doesn't include floating images.
|
|
103646
|
+
*
|
|
103647
|
+
* @remarks
|
|
103648
|
+
* [Api set: WordApi 1.1]
|
|
103649
|
+
*/
|
|
103855
103650
|
inlinePictures?: Word.Interfaces.InlinePictureData[];
|
|
103856
103651
|
/**
|
|
103857
|
-
|
|
103858
|
-
|
|
103859
|
-
|
|
103860
|
-
|
|
103861
|
-
|
|
103652
|
+
* Gets the collection of list objects in the body.
|
|
103653
|
+
*
|
|
103654
|
+
* @remarks
|
|
103655
|
+
* [Api set: WordApi 1.3]
|
|
103656
|
+
*/
|
|
103862
103657
|
lists?: Word.Interfaces.ListData[];
|
|
103863
103658
|
/**
|
|
103864
|
-
|
|
103865
|
-
|
|
103866
|
-
|
|
103867
|
-
|
|
103868
|
-
|
|
103659
|
+
* Gets the collection of paragraph objects in the body.
|
|
103660
|
+
*
|
|
103661
|
+
* @remarks
|
|
103662
|
+
* [Api set: WordApi 1.1]
|
|
103663
|
+
*
|
|
103664
|
+
* 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.
|
|
103665
|
+
*/
|
|
103869
103666
|
paragraphs?: Word.Interfaces.ParagraphData[];
|
|
103870
103667
|
/**
|
|
103871
|
-
|
|
103872
|
-
|
|
103873
|
-
|
|
103874
|
-
|
|
103875
|
-
|
|
103668
|
+
* Gets the collection of table objects in the body.
|
|
103669
|
+
*
|
|
103670
|
+
* @remarks
|
|
103671
|
+
* [Api set: WordApi 1.3]
|
|
103672
|
+
*/
|
|
103876
103673
|
tables?: Word.Interfaces.TableData[];
|
|
103877
103674
|
/**
|
|
103878
103675
|
* Specifies the style name for the body. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property.
|
|
@@ -103906,50 +103703,61 @@ declare namespace Word {
|
|
|
103906
103703
|
/** An interface describing the data returned by calling `border.toJSON()`. */
|
|
103907
103704
|
interface BorderData {
|
|
103908
103705
|
/**
|
|
103909
|
-
* Specifies the
|
|
103706
|
+
* Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name.
|
|
103910
103707
|
*
|
|
103911
103708
|
* @remarks
|
|
103912
103709
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
103913
103710
|
* @beta
|
|
103914
103711
|
*/
|
|
103915
|
-
|
|
103712
|
+
color?: string;
|
|
103916
103713
|
/**
|
|
103917
|
-
*
|
|
103714
|
+
* Gets the location of the border.
|
|
103918
103715
|
*
|
|
103919
103716
|
* @remarks
|
|
103920
103717
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
103921
103718
|
* @beta
|
|
103922
103719
|
*/
|
|
103923
|
-
|
|
103720
|
+
location?: Word.BorderLocation | "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All";
|
|
103924
103721
|
/**
|
|
103925
|
-
* Specifies the
|
|
103722
|
+
* Specifies the border type for the border.
|
|
103926
103723
|
*
|
|
103927
103724
|
* @remarks
|
|
103928
103725
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
103929
103726
|
* @beta
|
|
103930
103727
|
*/
|
|
103931
|
-
|
|
103728
|
+
type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave";
|
|
103932
103729
|
/**
|
|
103933
|
-
*
|
|
103730
|
+
* Specifies whether the border is visible.
|
|
103934
103731
|
*
|
|
103935
103732
|
* @remarks
|
|
103936
103733
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
103937
103734
|
* @beta
|
|
103938
103735
|
*/
|
|
103939
|
-
|
|
103736
|
+
visible?: boolean;
|
|
103940
103737
|
/**
|
|
103941
|
-
* Specifies
|
|
103738
|
+
* Specifies the width for the border.
|
|
103942
103739
|
*
|
|
103943
103740
|
* @remarks
|
|
103944
103741
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
103945
103742
|
* @beta
|
|
103946
103743
|
*/
|
|
103947
|
-
|
|
103744
|
+
width?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
|
|
103948
103745
|
}
|
|
103949
103746
|
/** An interface describing the data returned by calling `borderCollection.toJSON()`. */
|
|
103950
103747
|
interface BorderCollectionData {
|
|
103951
103748
|
items?: Word.Interfaces.BorderData[];
|
|
103952
103749
|
}
|
|
103750
|
+
/** An interface describing the data returned by calling `checkboxContentControl.toJSON()`. */
|
|
103751
|
+
interface CheckboxContentControlData {
|
|
103752
|
+
/**
|
|
103753
|
+
* Specifies the current state of the checkbox.
|
|
103754
|
+
*
|
|
103755
|
+
* @remarks
|
|
103756
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
103757
|
+
* @beta
|
|
103758
|
+
*/
|
|
103759
|
+
isChecked?: boolean;
|
|
103760
|
+
}
|
|
103953
103761
|
/** An interface describing the data returned by calling `comment.toJSON()`. */
|
|
103954
103762
|
interface CommentData {
|
|
103955
103763
|
/**
|
|
@@ -104058,7 +103866,7 @@ declare namespace Word {
|
|
|
104058
103866
|
*/
|
|
104059
103867
|
text?: string;
|
|
104060
103868
|
/**
|
|
104061
|
-
* Specifies a value that indicates the comment text's underline type. 'None' if the comment text
|
|
103869
|
+
* Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined.
|
|
104062
103870
|
*
|
|
104063
103871
|
* @remarks
|
|
104064
103872
|
* [Api set: WordApi 1.4]
|
|
@@ -104124,53 +103932,63 @@ declare namespace Word {
|
|
|
104124
103932
|
/** An interface describing the data returned by calling `contentControl.toJSON()`. */
|
|
104125
103933
|
interface ContentControlData {
|
|
104126
103934
|
/**
|
|
104127
|
-
|
|
104128
|
-
|
|
104129
|
-
|
|
104130
|
-
|
|
104131
|
-
|
|
103935
|
+
* Specifies the checkbox-related data if the content control's type is 'CheckBox'. It's null otherwise.
|
|
103936
|
+
*
|
|
103937
|
+
* @remarks
|
|
103938
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
103939
|
+
* @beta
|
|
103940
|
+
*/
|
|
103941
|
+
checkboxContentControl?: Word.Interfaces.CheckboxContentControlData;
|
|
103942
|
+
/**
|
|
103943
|
+
* Gets the collection of content control objects in the content control.
|
|
103944
|
+
*
|
|
103945
|
+
* @remarks
|
|
103946
|
+
* [Api set: WordApi 1.1]
|
|
103947
|
+
*/
|
|
104132
103948
|
contentControls?: Word.Interfaces.ContentControlData[];
|
|
104133
103949
|
/**
|
|
104134
|
-
|
|
104135
|
-
|
|
104136
|
-
|
|
104137
|
-
|
|
104138
|
-
|
|
103950
|
+
* Gets the collection of field objects in the content control.
|
|
103951
|
+
*
|
|
103952
|
+
* @remarks
|
|
103953
|
+
* [Api set: WordApi 1.4]
|
|
103954
|
+
*/
|
|
104139
103955
|
fields?: Word.Interfaces.FieldData[];
|
|
104140
103956
|
/**
|
|
104141
|
-
|
|
104142
|
-
|
|
104143
|
-
|
|
104144
|
-
|
|
104145
|
-
|
|
103957
|
+
* Gets the text format of the content control. Use this to get and set font name, size, color, and other properties.
|
|
103958
|
+
*
|
|
103959
|
+
* @remarks
|
|
103960
|
+
* [Api set: WordApi 1.1]
|
|
103961
|
+
*/
|
|
104146
103962
|
font?: Word.Interfaces.FontData;
|
|
104147
103963
|
/**
|
|
104148
|
-
|
|
104149
|
-
|
|
104150
|
-
|
|
104151
|
-
|
|
104152
|
-
|
|
103964
|
+
* Gets the collection of InlinePicture objects in the content control. The collection doesn't include floating images.
|
|
103965
|
+
*
|
|
103966
|
+
* @remarks
|
|
103967
|
+
* [Api set: WordApi 1.1]
|
|
103968
|
+
*/
|
|
104153
103969
|
inlinePictures?: Word.Interfaces.InlinePictureData[];
|
|
104154
103970
|
/**
|
|
104155
|
-
|
|
104156
|
-
|
|
104157
|
-
|
|
104158
|
-
|
|
104159
|
-
|
|
103971
|
+
* Gets the collection of list objects in the content control.
|
|
103972
|
+
*
|
|
103973
|
+
* @remarks
|
|
103974
|
+
* [Api set: WordApi 1.3]
|
|
103975
|
+
*/
|
|
104160
103976
|
lists?: Word.Interfaces.ListData[];
|
|
104161
103977
|
/**
|
|
104162
|
-
|
|
104163
|
-
|
|
104164
|
-
|
|
104165
|
-
|
|
104166
|
-
|
|
103978
|
+
* Gets the collection of paragraph objects in the content control.
|
|
103979
|
+
*
|
|
103980
|
+
* @remarks
|
|
103981
|
+
* [Api set: WordApi 1.1]
|
|
103982
|
+
*
|
|
103983
|
+
* 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.
|
|
103984
|
+
*/
|
|
104167
103985
|
paragraphs?: Word.Interfaces.ParagraphData[];
|
|
104168
103986
|
/**
|
|
104169
|
-
|
|
104170
|
-
|
|
104171
|
-
|
|
104172
|
-
|
|
104173
|
-
|
|
103987
|
+
* Gets the collection of table objects in the content control.
|
|
103988
|
+
*
|
|
103989
|
+
* @remarks
|
|
103990
|
+
* [Api set: WordApi 1.3]
|
|
103991
|
+
*/
|
|
104174
103992
|
tables?: Word.Interfaces.TableData[];
|
|
104175
103993
|
/**
|
|
104176
103994
|
* Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'.
|
|
@@ -104193,14 +104011,6 @@ declare namespace Word {
|
|
|
104193
104011
|
* [Api set: WordApi 1.1]
|
|
104194
104012
|
*/
|
|
104195
104013
|
cannotEdit?: boolean;
|
|
104196
|
-
/**
|
|
104197
|
-
* Gets the checkbox-related data if the content control's type is 'CheckBox'. Returns null otherwise.
|
|
104198
|
-
*
|
|
104199
|
-
* @remarks
|
|
104200
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
104201
|
-
* @beta
|
|
104202
|
-
*/
|
|
104203
|
-
checkboxContentControl?: Word.CheckboxContentControl;
|
|
104204
104014
|
/**
|
|
104205
104015
|
* Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name.
|
|
104206
104016
|
*
|
|
@@ -104216,7 +104026,9 @@ declare namespace Word {
|
|
|
104216
104026
|
*/
|
|
104217
104027
|
id?: number;
|
|
104218
104028
|
/**
|
|
104219
|
-
* Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty.
|
|
104029
|
+
* Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty.
|
|
104030
|
+
|
|
104031
|
+
Note: The set operation for this property isn't supported in Word on the web.
|
|
104220
104032
|
*
|
|
104221
104033
|
* @remarks
|
|
104222
104034
|
* [Api set: WordApi 1.1]
|
|
@@ -104716,7 +104528,7 @@ declare namespace Word {
|
|
|
104716
104528
|
*/
|
|
104717
104529
|
superscript?: boolean;
|
|
104718
104530
|
/**
|
|
104719
|
-
* Specifies a value that indicates the font's underline type. 'None' if the font
|
|
104531
|
+
* Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined.
|
|
104720
104532
|
*
|
|
104721
104533
|
* @remarks
|
|
104722
104534
|
* [Api set: WordApi 1.1]
|
|
@@ -104998,14 +104810,14 @@ declare namespace Word {
|
|
|
104998
104810
|
*/
|
|
104999
104811
|
font?: Word.Interfaces.FontData;
|
|
105000
104812
|
/**
|
|
105001
|
-
* Gets the collection of InlinePicture objects in the paragraph. The collection
|
|
104813
|
+
* Gets the collection of InlinePicture objects in the paragraph. The collection doesn't include floating images.
|
|
105002
104814
|
*
|
|
105003
104815
|
* @remarks
|
|
105004
104816
|
* [Api set: WordApi 1.1]
|
|
105005
104817
|
*/
|
|
105006
104818
|
inlinePictures?: Word.Interfaces.InlinePictureData[];
|
|
105007
104819
|
/**
|
|
105008
|
-
* Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph
|
|
104820
|
+
* Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list.
|
|
105009
104821
|
*
|
|
105010
104822
|
* @remarks
|
|
105011
104823
|
* [Api set: WordApi 1.3]
|
|
@@ -105117,7 +104929,7 @@ declare namespace Word {
|
|
|
105117
104929
|
*/
|
|
105118
104930
|
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";
|
|
105119
104931
|
/**
|
|
105120
|
-
* Gets the level of the paragraph's table. It returns 0 if the paragraph
|
|
104932
|
+
* Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table.
|
|
105121
104933
|
*
|
|
105122
104934
|
* @remarks
|
|
105123
104935
|
* [Api set: WordApi 1.3]
|
|
@@ -105134,8 +104946,7 @@ declare namespace Word {
|
|
|
105134
104946
|
* 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.
|
|
105135
104947
|
*
|
|
105136
104948
|
* @remarks
|
|
105137
|
-
* [Api set: WordApi
|
|
105138
|
-
* @beta
|
|
104949
|
+
* [Api set: WordApi 1.6]
|
|
105139
104950
|
*/
|
|
105140
104951
|
uniqueLocalId?: string;
|
|
105141
104952
|
}
|
|
@@ -105362,7 +105173,7 @@ declare namespace Word {
|
|
|
105362
105173
|
/** An interface describing the data returned by calling `section.toJSON()`. */
|
|
105363
105174
|
interface SectionData {
|
|
105364
105175
|
/**
|
|
105365
|
-
* Gets the body object of the section. This
|
|
105176
|
+
* Gets the body object of the section. This doesn't include the header/footer and other section metadata.
|
|
105366
105177
|
*
|
|
105367
105178
|
* @remarks
|
|
105368
105179
|
* [Api set: WordApi 1.1]
|
|
@@ -105434,23 +105245,23 @@ declare namespace Word {
|
|
|
105434
105245
|
* Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
|
|
105435
105246
|
*
|
|
105436
105247
|
* @remarks
|
|
105437
|
-
* [Api set: WordApi
|
|
105438
|
-
* @beta
|
|
105248
|
+
* [Api set: WordApi 1.6]
|
|
105439
105249
|
*/
|
|
105440
105250
|
shading?: Word.Interfaces.ShadingData;
|
|
105441
105251
|
/**
|
|
105442
105252
|
* Gets a TableStyle object representing Style properties that can be applied to a table.
|
|
105443
105253
|
*
|
|
105444
105254
|
* @remarks
|
|
105445
|
-
* [Api set: WordApi
|
|
105446
|
-
* @beta
|
|
105255
|
+
* [Api set: WordApi 1.6]
|
|
105447
105256
|
*/
|
|
105448
105257
|
tableStyle?: Word.Interfaces.TableStyleData;
|
|
105449
105258
|
/**
|
|
105450
|
-
*
|
|
105259
|
+
* Specifies the name of an existing style to use as the base formatting of another style.
|
|
105451
105260
|
*
|
|
105452
105261
|
* @remarks
|
|
105453
105262
|
* [Api set: WordApi 1.5]
|
|
105263
|
+
*
|
|
105264
|
+
* Note: The ability to set `baseStyle` was introduced in WordApi 1.6.
|
|
105454
105265
|
*/
|
|
105455
105266
|
baseStyle?: string;
|
|
105456
105267
|
/**
|
|
@@ -105490,10 +105301,12 @@ declare namespace Word {
|
|
|
105490
105301
|
*/
|
|
105491
105302
|
nameLocal?: string;
|
|
105492
105303
|
/**
|
|
105493
|
-
*
|
|
105304
|
+
* 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.
|
|
105494
105305
|
*
|
|
105495
105306
|
* @remarks
|
|
105496
105307
|
* [Api set: WordApi 1.5]
|
|
105308
|
+
*
|
|
105309
|
+
* Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6.
|
|
105497
105310
|
*/
|
|
105498
105311
|
nextParagraphStyle?: string;
|
|
105499
105312
|
/**
|
|
@@ -105538,8 +105351,7 @@ declare namespace Word {
|
|
|
105538
105351
|
* Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name.
|
|
105539
105352
|
*
|
|
105540
105353
|
* @remarks
|
|
105541
|
-
* [Api set: WordApi
|
|
105542
|
-
* @beta
|
|
105354
|
+
* [Api set: WordApi 1.6]
|
|
105543
105355
|
*/
|
|
105544
105356
|
backgroundPatternColor?: string;
|
|
105545
105357
|
/**
|
|
@@ -105731,40 +105543,35 @@ declare namespace Word {
|
|
|
105731
105543
|
* Specifies the amount of space to add between the contents and the bottom borders of the cells.
|
|
105732
105544
|
*
|
|
105733
105545
|
* @remarks
|
|
105734
|
-
* [Api set: WordApi
|
|
105735
|
-
* @beta
|
|
105546
|
+
* [Api set: WordApi 1.6]
|
|
105736
105547
|
*/
|
|
105737
105548
|
bottomCellMargin?: number;
|
|
105738
105549
|
/**
|
|
105739
105550
|
* Specifies the spacing (in points) between the cells in a table style.
|
|
105740
105551
|
*
|
|
105741
105552
|
* @remarks
|
|
105742
|
-
* [Api set: WordApi
|
|
105743
|
-
* @beta
|
|
105553
|
+
* [Api set: WordApi 1.6]
|
|
105744
105554
|
*/
|
|
105745
105555
|
cellSpacing?: number;
|
|
105746
105556
|
/**
|
|
105747
105557
|
* Specifies the amount of space to add between the contents and the left borders of the cells.
|
|
105748
105558
|
*
|
|
105749
105559
|
* @remarks
|
|
105750
|
-
* [Api set: WordApi
|
|
105751
|
-
* @beta
|
|
105560
|
+
* [Api set: WordApi 1.6]
|
|
105752
105561
|
*/
|
|
105753
105562
|
leftCellMargin?: number;
|
|
105754
105563
|
/**
|
|
105755
105564
|
* Specifies the amount of space to add between the contents and the right borders of the cells.
|
|
105756
105565
|
*
|
|
105757
105566
|
* @remarks
|
|
105758
|
-
* [Api set: WordApi
|
|
105759
|
-
* @beta
|
|
105567
|
+
* [Api set: WordApi 1.6]
|
|
105760
105568
|
*/
|
|
105761
105569
|
rightCellMargin?: number;
|
|
105762
105570
|
/**
|
|
105763
105571
|
* Specifies the amount of space to add between the contents and the top borders of the cells.
|
|
105764
105572
|
*
|
|
105765
105573
|
* @remarks
|
|
105766
|
-
* [Api set: WordApi
|
|
105767
|
-
* @beta
|
|
105574
|
+
* [Api set: WordApi 1.6]
|
|
105768
105575
|
*/
|
|
105769
105576
|
topCellMargin?: number;
|
|
105770
105577
|
}
|
|
@@ -105953,35 +105760,31 @@ declare namespace Word {
|
|
|
105953
105760
|
/** An interface describing the data returned by calling `trackedChange.toJSON()`. */
|
|
105954
105761
|
interface TrackedChangeData {
|
|
105955
105762
|
/**
|
|
105956
|
-
*
|
|
105763
|
+
* Gets the author of the tracked change.
|
|
105957
105764
|
*
|
|
105958
105765
|
* @remarks
|
|
105959
|
-
* [Api set: WordApi
|
|
105960
|
-
* @beta
|
|
105766
|
+
* [Api set: WordApi 1.6]
|
|
105961
105767
|
*/
|
|
105962
105768
|
author?: string;
|
|
105963
105769
|
/**
|
|
105964
|
-
*
|
|
105770
|
+
* Gets the date of the tracked change.
|
|
105965
105771
|
*
|
|
105966
105772
|
* @remarks
|
|
105967
|
-
* [Api set: WordApi
|
|
105968
|
-
* @beta
|
|
105773
|
+
* [Api set: WordApi 1.6]
|
|
105969
105774
|
*/
|
|
105970
105775
|
date?: Date;
|
|
105971
105776
|
/**
|
|
105972
|
-
*
|
|
105777
|
+
* Gets the text of the tracked change.
|
|
105973
105778
|
*
|
|
105974
105779
|
* @remarks
|
|
105975
|
-
* [Api set: WordApi
|
|
105976
|
-
* @beta
|
|
105780
|
+
* [Api set: WordApi 1.6]
|
|
105977
105781
|
*/
|
|
105978
105782
|
text?: string;
|
|
105979
105783
|
/**
|
|
105980
|
-
*
|
|
105784
|
+
* Gets the type of the tracked change.
|
|
105981
105785
|
*
|
|
105982
105786
|
* @remarks
|
|
105983
|
-
* [Api set: WordApi
|
|
105984
|
-
* @beta
|
|
105787
|
+
* [Api set: WordApi 1.6]
|
|
105985
105788
|
*/
|
|
105986
105789
|
type?: Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted";
|
|
105987
105790
|
}
|
|
@@ -106194,45 +105997,45 @@ declare namespace Word {
|
|
|
106194
105997
|
*/
|
|
106195
105998
|
$all?: boolean;
|
|
106196
105999
|
/**
|
|
106197
|
-
* Specifies the
|
|
106000
|
+
* Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name.
|
|
106198
106001
|
*
|
|
106199
106002
|
* @remarks
|
|
106200
106003
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
106201
106004
|
* @beta
|
|
106202
106005
|
*/
|
|
106203
|
-
|
|
106006
|
+
color?: boolean;
|
|
106204
106007
|
/**
|
|
106205
|
-
*
|
|
106008
|
+
* Gets the location of the border.
|
|
106206
106009
|
*
|
|
106207
106010
|
* @remarks
|
|
106208
106011
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
106209
106012
|
* @beta
|
|
106210
106013
|
*/
|
|
106211
|
-
|
|
106014
|
+
location?: boolean;
|
|
106212
106015
|
/**
|
|
106213
|
-
* Specifies the
|
|
106016
|
+
* Specifies the border type for the border.
|
|
106214
106017
|
*
|
|
106215
106018
|
* @remarks
|
|
106216
106019
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
106217
106020
|
* @beta
|
|
106218
106021
|
*/
|
|
106219
|
-
|
|
106022
|
+
type?: boolean;
|
|
106220
106023
|
/**
|
|
106221
|
-
*
|
|
106024
|
+
* Specifies whether the border is visible.
|
|
106222
106025
|
*
|
|
106223
106026
|
* @remarks
|
|
106224
106027
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
106225
106028
|
* @beta
|
|
106226
106029
|
*/
|
|
106227
|
-
|
|
106030
|
+
visible?: boolean;
|
|
106228
106031
|
/**
|
|
106229
|
-
* Specifies
|
|
106032
|
+
* Specifies the width for the border.
|
|
106230
106033
|
*
|
|
106231
106034
|
* @remarks
|
|
106232
106035
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
106233
106036
|
* @beta
|
|
106234
106037
|
*/
|
|
106235
|
-
|
|
106038
|
+
width?: boolean;
|
|
106236
106039
|
}
|
|
106237
106040
|
/**
|
|
106238
106041
|
* Represents the collection of border styles.
|
|
@@ -106247,45 +106050,66 @@ declare namespace Word {
|
|
|
106247
106050
|
*/
|
|
106248
106051
|
$all?: boolean;
|
|
106249
106052
|
/**
|
|
106250
|
-
* For EACH ITEM in the collection: Specifies the
|
|
106053
|
+
* For EACH ITEM in the collection: Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name.
|
|
106251
106054
|
*
|
|
106252
106055
|
* @remarks
|
|
106253
106056
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
106254
106057
|
* @beta
|
|
106255
106058
|
*/
|
|
106256
|
-
|
|
106059
|
+
color?: boolean;
|
|
106257
106060
|
/**
|
|
106258
|
-
* For EACH ITEM in the collection:
|
|
106061
|
+
* For EACH ITEM in the collection: Gets the location of the border.
|
|
106259
106062
|
*
|
|
106260
106063
|
* @remarks
|
|
106261
106064
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
106262
106065
|
* @beta
|
|
106263
106066
|
*/
|
|
106264
|
-
|
|
106067
|
+
location?: boolean;
|
|
106265
106068
|
/**
|
|
106266
|
-
* For EACH ITEM in the collection: Specifies the
|
|
106069
|
+
* For EACH ITEM in the collection: Specifies the border type for the border.
|
|
106267
106070
|
*
|
|
106268
106071
|
* @remarks
|
|
106269
106072
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
106270
106073
|
* @beta
|
|
106271
106074
|
*/
|
|
106272
|
-
|
|
106075
|
+
type?: boolean;
|
|
106273
106076
|
/**
|
|
106274
|
-
* For EACH ITEM in the collection:
|
|
106077
|
+
* For EACH ITEM in the collection: Specifies whether the border is visible.
|
|
106275
106078
|
*
|
|
106276
106079
|
* @remarks
|
|
106277
106080
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
106278
106081
|
* @beta
|
|
106279
106082
|
*/
|
|
106280
|
-
|
|
106083
|
+
visible?: boolean;
|
|
106281
106084
|
/**
|
|
106282
|
-
* For EACH ITEM in the collection: Specifies
|
|
106085
|
+
* For EACH ITEM in the collection: Specifies the width for the border.
|
|
106283
106086
|
*
|
|
106284
106087
|
* @remarks
|
|
106285
106088
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
106286
106089
|
* @beta
|
|
106287
106090
|
*/
|
|
106288
|
-
|
|
106091
|
+
width?: boolean;
|
|
106092
|
+
}
|
|
106093
|
+
/**
|
|
106094
|
+
* The data specific to content controls of type CheckBox.
|
|
106095
|
+
*
|
|
106096
|
+
* @remarks
|
|
106097
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
106098
|
+
* @beta
|
|
106099
|
+
*/
|
|
106100
|
+
interface CheckboxContentControlLoadOptions {
|
|
106101
|
+
/**
|
|
106102
|
+
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`).
|
|
106103
|
+
*/
|
|
106104
|
+
$all?: boolean;
|
|
106105
|
+
/**
|
|
106106
|
+
* Specifies the current state of the checkbox.
|
|
106107
|
+
*
|
|
106108
|
+
* @remarks
|
|
106109
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
106110
|
+
* @beta
|
|
106111
|
+
*/
|
|
106112
|
+
isChecked?: boolean;
|
|
106289
106113
|
}
|
|
106290
106114
|
/**
|
|
106291
106115
|
* Represents a comment in the document.
|
|
@@ -106461,7 +106285,7 @@ declare namespace Word {
|
|
|
106461
106285
|
*/
|
|
106462
106286
|
text?: boolean;
|
|
106463
106287
|
/**
|
|
106464
|
-
* Specifies a value that indicates the comment text's underline type. 'None' if the comment text
|
|
106288
|
+
* Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined.
|
|
106465
106289
|
*
|
|
106466
106290
|
* @remarks
|
|
106467
106291
|
* [Api set: WordApi 1.4]
|
|
@@ -106602,60 +106426,68 @@ declare namespace Word {
|
|
|
106602
106426
|
*/
|
|
106603
106427
|
$all?: boolean;
|
|
106604
106428
|
/**
|
|
106605
|
-
|
|
106606
|
-
|
|
106607
|
-
|
|
106608
|
-
|
|
106609
|
-
|
|
106429
|
+
* Specifies the checkbox-related data if the content control's type is 'CheckBox'. It's null otherwise.
|
|
106430
|
+
*
|
|
106431
|
+
* @remarks
|
|
106432
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
106433
|
+
* @beta
|
|
106434
|
+
*/
|
|
106435
|
+
checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions;
|
|
106436
|
+
/**
|
|
106437
|
+
* Gets the text format of the content control. Use this to get and set font name, size, color, and other properties.
|
|
106438
|
+
*
|
|
106439
|
+
* @remarks
|
|
106440
|
+
* [Api set: WordApi 1.1]
|
|
106441
|
+
*/
|
|
106610
106442
|
font?: Word.Interfaces.FontLoadOptions;
|
|
106611
106443
|
/**
|
|
106612
|
-
|
|
106613
|
-
|
|
106614
|
-
|
|
106615
|
-
|
|
106616
|
-
|
|
106444
|
+
* Gets the parent body of the content control.
|
|
106445
|
+
*
|
|
106446
|
+
* @remarks
|
|
106447
|
+
* [Api set: WordApi 1.3]
|
|
106448
|
+
*/
|
|
106617
106449
|
parentBody?: Word.Interfaces.BodyLoadOptions;
|
|
106618
106450
|
/**
|
|
106619
|
-
|
|
106620
|
-
|
|
106621
|
-
|
|
106622
|
-
|
|
106623
|
-
|
|
106451
|
+
* Gets the content control that contains the content control. Throws an `ItemNotFound` error if there isn't a parent content control.
|
|
106452
|
+
*
|
|
106453
|
+
* @remarks
|
|
106454
|
+
* [Api set: WordApi 1.1]
|
|
106455
|
+
*/
|
|
106624
106456
|
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
|
|
106625
106457
|
/**
|
|
106626
|
-
|
|
106627
|
-
|
|
106628
|
-
|
|
106629
|
-
|
|
106630
|
-
|
|
106458
|
+
* Gets the content control that contains the content control. 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}.
|
|
106459
|
+
*
|
|
106460
|
+
* @remarks
|
|
106461
|
+
* [Api set: WordApi 1.3]
|
|
106462
|
+
*/
|
|
106631
106463
|
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
|
|
106632
106464
|
/**
|
|
106633
|
-
|
|
106634
|
-
|
|
106635
|
-
|
|
106636
|
-
|
|
106637
|
-
|
|
106465
|
+
* Gets the table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table.
|
|
106466
|
+
*
|
|
106467
|
+
* @remarks
|
|
106468
|
+
* [Api set: WordApi 1.3]
|
|
106469
|
+
*/
|
|
106638
106470
|
parentTable?: Word.Interfaces.TableLoadOptions;
|
|
106639
106471
|
/**
|
|
106640
|
-
|
|
106641
|
-
|
|
106642
|
-
|
|
106643
|
-
|
|
106644
|
-
|
|
106472
|
+
* Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell.
|
|
106473
|
+
*
|
|
106474
|
+
* @remarks
|
|
106475
|
+
* [Api set: WordApi 1.3]
|
|
106476
|
+
*/
|
|
106645
106477
|
parentTableCell?: Word.Interfaces.TableCellLoadOptions;
|
|
106646
106478
|
/**
|
|
106647
|
-
|
|
106648
|
-
|
|
106649
|
-
|
|
106650
|
-
|
|
106651
|
-
|
|
106479
|
+
* 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}.
|
|
106480
|
+
*
|
|
106481
|
+
* @remarks
|
|
106482
|
+
* [Api set: WordApi 1.3]
|
|
106483
|
+
*/
|
|
106652
106484
|
parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
|
|
106653
106485
|
/**
|
|
106654
|
-
|
|
106655
|
-
|
|
106656
|
-
|
|
106657
|
-
|
|
106658
|
-
|
|
106486
|
+
* 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}.
|
|
106487
|
+
*
|
|
106488
|
+
* @remarks
|
|
106489
|
+
* [Api set: WordApi 1.3]
|
|
106490
|
+
*/
|
|
106659
106491
|
parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
|
|
106660
106492
|
/**
|
|
106661
106493
|
* Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'.
|
|
@@ -106678,14 +106510,6 @@ declare namespace Word {
|
|
|
106678
106510
|
* [Api set: WordApi 1.1]
|
|
106679
106511
|
*/
|
|
106680
106512
|
cannotEdit?: boolean;
|
|
106681
|
-
/**
|
|
106682
|
-
* Gets the checkbox-related data if the content control's type is 'CheckBox'. Returns null otherwise.
|
|
106683
|
-
*
|
|
106684
|
-
* @remarks
|
|
106685
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
106686
|
-
* @beta
|
|
106687
|
-
*/
|
|
106688
|
-
checkboxContentControl?: boolean;
|
|
106689
106513
|
/**
|
|
106690
106514
|
* Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name.
|
|
106691
106515
|
*
|
|
@@ -106701,7 +106525,9 @@ declare namespace Word {
|
|
|
106701
106525
|
*/
|
|
106702
106526
|
id?: boolean;
|
|
106703
106527
|
/**
|
|
106704
|
-
* Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty.
|
|
106528
|
+
* Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty.
|
|
106529
|
+
|
|
106530
|
+
Note: The set operation for this property isn't supported in Word on the web.
|
|
106705
106531
|
*
|
|
106706
106532
|
* @remarks
|
|
106707
106533
|
* [Api set: WordApi 1.1]
|
|
@@ -106776,60 +106602,68 @@ declare namespace Word {
|
|
|
106776
106602
|
*/
|
|
106777
106603
|
$all?: boolean;
|
|
106778
106604
|
/**
|
|
106779
|
-
|
|
106780
|
-
|
|
106781
|
-
|
|
106782
|
-
|
|
106783
|
-
|
|
106605
|
+
* For EACH ITEM in the collection: Specifies the checkbox-related data if the content control's type is 'CheckBox'. It's null otherwise.
|
|
106606
|
+
*
|
|
106607
|
+
* @remarks
|
|
106608
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
106609
|
+
* @beta
|
|
106610
|
+
*/
|
|
106611
|
+
checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions;
|
|
106612
|
+
/**
|
|
106613
|
+
* For EACH ITEM in the collection: Gets the text format of the content control. Use this to get and set font name, size, color, and other properties.
|
|
106614
|
+
*
|
|
106615
|
+
* @remarks
|
|
106616
|
+
* [Api set: WordApi 1.1]
|
|
106617
|
+
*/
|
|
106784
106618
|
font?: Word.Interfaces.FontLoadOptions;
|
|
106785
106619
|
/**
|
|
106786
|
-
|
|
106787
|
-
|
|
106788
|
-
|
|
106789
|
-
|
|
106790
|
-
|
|
106620
|
+
* For EACH ITEM in the collection: Gets the parent body of the content control.
|
|
106621
|
+
*
|
|
106622
|
+
* @remarks
|
|
106623
|
+
* [Api set: WordApi 1.3]
|
|
106624
|
+
*/
|
|
106791
106625
|
parentBody?: Word.Interfaces.BodyLoadOptions;
|
|
106792
106626
|
/**
|
|
106793
|
-
|
|
106794
|
-
|
|
106795
|
-
|
|
106796
|
-
|
|
106797
|
-
|
|
106627
|
+
* For EACH ITEM in the collection: Gets the content control that contains the content control. Throws an `ItemNotFound` error if there isn't a parent content control.
|
|
106628
|
+
*
|
|
106629
|
+
* @remarks
|
|
106630
|
+
* [Api set: WordApi 1.1]
|
|
106631
|
+
*/
|
|
106798
106632
|
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
|
|
106799
106633
|
/**
|
|
106800
|
-
|
|
106801
|
-
|
|
106802
|
-
|
|
106803
|
-
|
|
106804
|
-
|
|
106634
|
+
* For EACH ITEM in the collection: Gets the content control that contains the content control. 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}.
|
|
106635
|
+
*
|
|
106636
|
+
* @remarks
|
|
106637
|
+
* [Api set: WordApi 1.3]
|
|
106638
|
+
*/
|
|
106805
106639
|
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
|
|
106806
106640
|
/**
|
|
106807
|
-
|
|
106808
|
-
|
|
106809
|
-
|
|
106810
|
-
|
|
106811
|
-
|
|
106641
|
+
* 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.
|
|
106642
|
+
*
|
|
106643
|
+
* @remarks
|
|
106644
|
+
* [Api set: WordApi 1.3]
|
|
106645
|
+
*/
|
|
106812
106646
|
parentTable?: Word.Interfaces.TableLoadOptions;
|
|
106813
106647
|
/**
|
|
106814
|
-
|
|
106815
|
-
|
|
106816
|
-
|
|
106817
|
-
|
|
106818
|
-
|
|
106648
|
+
* 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.
|
|
106649
|
+
*
|
|
106650
|
+
* @remarks
|
|
106651
|
+
* [Api set: WordApi 1.3]
|
|
106652
|
+
*/
|
|
106819
106653
|
parentTableCell?: Word.Interfaces.TableCellLoadOptions;
|
|
106820
106654
|
/**
|
|
106821
|
-
|
|
106822
|
-
|
|
106823
|
-
|
|
106824
|
-
|
|
106825
|
-
|
|
106655
|
+
* For EACH ITEM in the collection: 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}.
|
|
106656
|
+
*
|
|
106657
|
+
* @remarks
|
|
106658
|
+
* [Api set: WordApi 1.3]
|
|
106659
|
+
*/
|
|
106826
106660
|
parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
|
|
106827
106661
|
/**
|
|
106828
|
-
|
|
106829
|
-
|
|
106830
|
-
|
|
106831
|
-
|
|
106832
|
-
|
|
106662
|
+
* For EACH ITEM in the collection: 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}.
|
|
106663
|
+
*
|
|
106664
|
+
* @remarks
|
|
106665
|
+
* [Api set: WordApi 1.3]
|
|
106666
|
+
*/
|
|
106833
106667
|
parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
|
|
106834
106668
|
/**
|
|
106835
106669
|
* For EACH ITEM in the collection: Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'.
|
|
@@ -106852,14 +106686,6 @@ declare namespace Word {
|
|
|
106852
106686
|
* [Api set: WordApi 1.1]
|
|
106853
106687
|
*/
|
|
106854
106688
|
cannotEdit?: boolean;
|
|
106855
|
-
/**
|
|
106856
|
-
* For EACH ITEM in the collection: Gets the checkbox-related data if the content control's type is 'CheckBox'. Returns null otherwise.
|
|
106857
|
-
*
|
|
106858
|
-
* @remarks
|
|
106859
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
106860
|
-
* @beta
|
|
106861
|
-
*/
|
|
106862
|
-
checkboxContentControl?: boolean;
|
|
106863
106689
|
/**
|
|
106864
106690
|
* For EACH ITEM in the collection: Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name.
|
|
106865
106691
|
*
|
|
@@ -106875,7 +106701,9 @@ declare namespace Word {
|
|
|
106875
106701
|
*/
|
|
106876
106702
|
id?: boolean;
|
|
106877
106703
|
/**
|
|
106878
|
-
* 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.
|
|
106704
|
+
* 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.
|
|
106705
|
+
|
|
106706
|
+
Note: The set operation for this property isn't supported in Word on the web.
|
|
106879
106707
|
*
|
|
106880
106708
|
* @remarks
|
|
106881
106709
|
* [Api set: WordApi 1.1]
|
|
@@ -107319,14 +107147,14 @@ declare namespace Word {
|
|
|
107319
107147
|
*/
|
|
107320
107148
|
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
|
|
107321
107149
|
/**
|
|
107322
|
-
* Gets the table that contains the field. Throws an `ItemNotFound` error if it
|
|
107150
|
+
* Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table.
|
|
107323
107151
|
*
|
|
107324
107152
|
* @remarks
|
|
107325
107153
|
* [Api set: WordApi 1.4]
|
|
107326
107154
|
*/
|
|
107327
107155
|
parentTable?: Word.Interfaces.TableLoadOptions;
|
|
107328
107156
|
/**
|
|
107329
|
-
* Gets the table cell that contains the field. Throws an `ItemNotFound` error if it
|
|
107157
|
+
* Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell.
|
|
107330
107158
|
*
|
|
107331
107159
|
* @remarks
|
|
107332
107160
|
* [Api set: WordApi 1.4]
|
|
@@ -107432,14 +107260,14 @@ declare namespace Word {
|
|
|
107432
107260
|
*/
|
|
107433
107261
|
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
|
|
107434
107262
|
/**
|
|
107435
|
-
* For EACH ITEM in the collection: Gets the table that contains the field. Throws an `ItemNotFound` error if it
|
|
107263
|
+
* 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.
|
|
107436
107264
|
*
|
|
107437
107265
|
* @remarks
|
|
107438
107266
|
* [Api set: WordApi 1.4]
|
|
107439
107267
|
*/
|
|
107440
107268
|
parentTable?: Word.Interfaces.TableLoadOptions;
|
|
107441
107269
|
/**
|
|
107442
|
-
* For EACH ITEM in the collection: Gets the table cell that contains the field. Throws an `ItemNotFound` error if it
|
|
107270
|
+
* 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.
|
|
107443
107271
|
*
|
|
107444
107272
|
* @remarks
|
|
107445
107273
|
* [Api set: WordApi 1.4]
|
|
@@ -107602,7 +107430,7 @@ declare namespace Word {
|
|
|
107602
107430
|
*/
|
|
107603
107431
|
superscript?: boolean;
|
|
107604
107432
|
/**
|
|
107605
|
-
* Specifies a value that indicates the font's underline type. 'None' if the font
|
|
107433
|
+
* Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined.
|
|
107606
107434
|
*
|
|
107607
107435
|
* @remarks
|
|
107608
107436
|
* [Api set: WordApi 1.1]
|
|
@@ -107642,14 +107470,14 @@ declare namespace Word {
|
|
|
107642
107470
|
*/
|
|
107643
107471
|
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
|
|
107644
107472
|
/**
|
|
107645
|
-
* Gets the table that contains the inline image. Throws an `ItemNotFound` error if it
|
|
107473
|
+
* Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table.
|
|
107646
107474
|
*
|
|
107647
107475
|
* @remarks
|
|
107648
107476
|
* [Api set: WordApi 1.3]
|
|
107649
107477
|
*/
|
|
107650
107478
|
parentTable?: Word.Interfaces.TableLoadOptions;
|
|
107651
107479
|
/**
|
|
107652
|
-
* Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it
|
|
107480
|
+
* Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table cell.
|
|
107653
107481
|
*
|
|
107654
107482
|
* @remarks
|
|
107655
107483
|
* [Api set: WordApi 1.3]
|
|
@@ -107732,53 +107560,53 @@ declare namespace Word {
|
|
|
107732
107560
|
*/
|
|
107733
107561
|
$all?: boolean;
|
|
107734
107562
|
/**
|
|
107735
|
-
|
|
107736
|
-
|
|
107737
|
-
|
|
107738
|
-
|
|
107739
|
-
|
|
107563
|
+
* For EACH ITEM in the collection: Gets the parent paragraph that contains the inline image.
|
|
107564
|
+
*
|
|
107565
|
+
* @remarks
|
|
107566
|
+
* [Api set: WordApi 1.2]
|
|
107567
|
+
*/
|
|
107740
107568
|
paragraph?: Word.Interfaces.ParagraphLoadOptions;
|
|
107741
107569
|
/**
|
|
107742
|
-
|
|
107743
|
-
|
|
107744
|
-
|
|
107745
|
-
|
|
107746
|
-
|
|
107570
|
+
* 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.
|
|
107571
|
+
*
|
|
107572
|
+
* @remarks
|
|
107573
|
+
* [Api set: WordApi 1.1]
|
|
107574
|
+
*/
|
|
107747
107575
|
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
|
|
107748
107576
|
/**
|
|
107749
|
-
|
|
107750
|
-
|
|
107751
|
-
|
|
107752
|
-
|
|
107753
|
-
|
|
107577
|
+
* 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}.
|
|
107578
|
+
*
|
|
107579
|
+
* @remarks
|
|
107580
|
+
* [Api set: WordApi 1.3]
|
|
107581
|
+
*/
|
|
107754
107582
|
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
|
|
107755
107583
|
/**
|
|
107756
|
-
|
|
107757
|
-
|
|
107758
|
-
|
|
107759
|
-
|
|
107760
|
-
|
|
107584
|
+
* 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.
|
|
107585
|
+
*
|
|
107586
|
+
* @remarks
|
|
107587
|
+
* [Api set: WordApi 1.3]
|
|
107588
|
+
*/
|
|
107761
107589
|
parentTable?: Word.Interfaces.TableLoadOptions;
|
|
107762
107590
|
/**
|
|
107763
|
-
|
|
107764
|
-
|
|
107765
|
-
|
|
107766
|
-
|
|
107767
|
-
|
|
107591
|
+
* 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.
|
|
107592
|
+
*
|
|
107593
|
+
* @remarks
|
|
107594
|
+
* [Api set: WordApi 1.3]
|
|
107595
|
+
*/
|
|
107768
107596
|
parentTableCell?: Word.Interfaces.TableCellLoadOptions;
|
|
107769
107597
|
/**
|
|
107770
|
-
|
|
107771
|
-
|
|
107772
|
-
|
|
107773
|
-
|
|
107774
|
-
|
|
107598
|
+
* 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}.
|
|
107599
|
+
*
|
|
107600
|
+
* @remarks
|
|
107601
|
+
* [Api set: WordApi 1.3]
|
|
107602
|
+
*/
|
|
107775
107603
|
parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
|
|
107776
107604
|
/**
|
|
107777
|
-
|
|
107778
|
-
|
|
107779
|
-
|
|
107780
|
-
|
|
107781
|
-
|
|
107605
|
+
* 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}.
|
|
107606
|
+
*
|
|
107607
|
+
* @remarks
|
|
107608
|
+
* [Api set: WordApi 1.3]
|
|
107609
|
+
*/
|
|
107782
107610
|
parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
|
|
107783
107611
|
/**
|
|
107784
107612
|
* For EACH ITEM in the collection: Specifies a string that represents the alternative text associated with the inline image.
|
|
@@ -108231,88 +108059,88 @@ declare namespace Word {
|
|
|
108231
108059
|
*/
|
|
108232
108060
|
$all?: boolean;
|
|
108233
108061
|
/**
|
|
108234
|
-
|
|
108235
|
-
|
|
108236
|
-
|
|
108237
|
-
|
|
108238
|
-
|
|
108062
|
+
* Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties.
|
|
108063
|
+
*
|
|
108064
|
+
* @remarks
|
|
108065
|
+
* [Api set: WordApi 1.1]
|
|
108066
|
+
*/
|
|
108239
108067
|
font?: Word.Interfaces.FontLoadOptions;
|
|
108240
108068
|
/**
|
|
108241
|
-
|
|
108242
|
-
|
|
108243
|
-
|
|
108244
|
-
|
|
108245
|
-
|
|
108069
|
+
* Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list.
|
|
108070
|
+
*
|
|
108071
|
+
* @remarks
|
|
108072
|
+
* [Api set: WordApi 1.3]
|
|
108073
|
+
*/
|
|
108246
108074
|
list?: Word.Interfaces.ListLoadOptions;
|
|
108247
108075
|
/**
|
|
108248
|
-
|
|
108249
|
-
|
|
108250
|
-
|
|
108251
|
-
|
|
108252
|
-
|
|
108076
|
+
* Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list.
|
|
108077
|
+
*
|
|
108078
|
+
* @remarks
|
|
108079
|
+
* [Api set: WordApi 1.3]
|
|
108080
|
+
*/
|
|
108253
108081
|
listItem?: Word.Interfaces.ListItemLoadOptions;
|
|
108254
108082
|
/**
|
|
108255
|
-
|
|
108256
|
-
|
|
108257
|
-
|
|
108258
|
-
|
|
108259
|
-
|
|
108083
|
+
* 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}.
|
|
108084
|
+
*
|
|
108085
|
+
* @remarks
|
|
108086
|
+
* [Api set: WordApi 1.3]
|
|
108087
|
+
*/
|
|
108260
108088
|
listItemOrNullObject?: Word.Interfaces.ListItemLoadOptions;
|
|
108261
108089
|
/**
|
|
108262
|
-
|
|
108263
|
-
|
|
108264
|
-
|
|
108265
|
-
|
|
108266
|
-
|
|
108090
|
+
* 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}.
|
|
108091
|
+
*
|
|
108092
|
+
* @remarks
|
|
108093
|
+
* [Api set: WordApi 1.3]
|
|
108094
|
+
*/
|
|
108267
108095
|
listOrNullObject?: Word.Interfaces.ListLoadOptions;
|
|
108268
108096
|
/**
|
|
108269
|
-
|
|
108270
|
-
|
|
108271
|
-
|
|
108272
|
-
|
|
108273
|
-
|
|
108097
|
+
* Gets the parent body of the paragraph.
|
|
108098
|
+
*
|
|
108099
|
+
* @remarks
|
|
108100
|
+
* [Api set: WordApi 1.3]
|
|
108101
|
+
*/
|
|
108274
108102
|
parentBody?: Word.Interfaces.BodyLoadOptions;
|
|
108275
108103
|
/**
|
|
108276
|
-
|
|
108277
|
-
|
|
108278
|
-
|
|
108279
|
-
|
|
108280
|
-
|
|
108104
|
+
* Gets the content control that contains the paragraph. Throws an `ItemNotFound` error if there isn't a parent content control.
|
|
108105
|
+
*
|
|
108106
|
+
* @remarks
|
|
108107
|
+
* [Api set: WordApi 1.1]
|
|
108108
|
+
*/
|
|
108281
108109
|
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
|
|
108282
108110
|
/**
|
|
108283
|
-
|
|
108284
|
-
|
|
108285
|
-
|
|
108286
|
-
|
|
108287
|
-
|
|
108111
|
+
* 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}.
|
|
108112
|
+
*
|
|
108113
|
+
* @remarks
|
|
108114
|
+
* [Api set: WordApi 1.3]
|
|
108115
|
+
*/
|
|
108288
108116
|
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
|
|
108289
108117
|
/**
|
|
108290
|
-
|
|
108291
|
-
|
|
108292
|
-
|
|
108293
|
-
|
|
108294
|
-
|
|
108118
|
+
* Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table.
|
|
108119
|
+
*
|
|
108120
|
+
* @remarks
|
|
108121
|
+
* [Api set: WordApi 1.3]
|
|
108122
|
+
*/
|
|
108295
108123
|
parentTable?: Word.Interfaces.TableLoadOptions;
|
|
108296
108124
|
/**
|
|
108297
|
-
|
|
108298
|
-
|
|
108299
|
-
|
|
108300
|
-
|
|
108301
|
-
|
|
108125
|
+
* Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell.
|
|
108126
|
+
*
|
|
108127
|
+
* @remarks
|
|
108128
|
+
* [Api set: WordApi 1.3]
|
|
108129
|
+
*/
|
|
108302
108130
|
parentTableCell?: Word.Interfaces.TableCellLoadOptions;
|
|
108303
108131
|
/**
|
|
108304
|
-
|
|
108305
|
-
|
|
108306
|
-
|
|
108307
|
-
|
|
108308
|
-
|
|
108132
|
+
* 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}.
|
|
108133
|
+
*
|
|
108134
|
+
* @remarks
|
|
108135
|
+
* [Api set: WordApi 1.3]
|
|
108136
|
+
*/
|
|
108309
108137
|
parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
|
|
108310
108138
|
/**
|
|
108311
|
-
|
|
108312
|
-
|
|
108313
|
-
|
|
108314
|
-
|
|
108315
|
-
|
|
108139
|
+
* 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}.
|
|
108140
|
+
*
|
|
108141
|
+
* @remarks
|
|
108142
|
+
* [Api set: WordApi 1.3]
|
|
108143
|
+
*/
|
|
108316
108144
|
parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
|
|
108317
108145
|
/**
|
|
108318
108146
|
* Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'.
|
|
@@ -108413,7 +108241,7 @@ declare namespace Word {
|
|
|
108413
108241
|
*/
|
|
108414
108242
|
styleBuiltIn?: boolean;
|
|
108415
108243
|
/**
|
|
108416
|
-
* Gets the level of the paragraph's table. It returns 0 if the paragraph
|
|
108244
|
+
* Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table.
|
|
108417
108245
|
*
|
|
108418
108246
|
* @remarks
|
|
108419
108247
|
* [Api set: WordApi 1.3]
|
|
@@ -108430,8 +108258,7 @@ declare namespace Word {
|
|
|
108430
108258
|
* 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.
|
|
108431
108259
|
*
|
|
108432
108260
|
* @remarks
|
|
108433
|
-
* [Api set: WordApi
|
|
108434
|
-
* @beta
|
|
108261
|
+
* [Api set: WordApi 1.6]
|
|
108435
108262
|
*/
|
|
108436
108263
|
uniqueLocalId?: boolean;
|
|
108437
108264
|
}
|
|
@@ -108454,14 +108281,14 @@ declare namespace Word {
|
|
|
108454
108281
|
*/
|
|
108455
108282
|
font?: Word.Interfaces.FontLoadOptions;
|
|
108456
108283
|
/**
|
|
108457
|
-
* For EACH ITEM in the collection: Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph
|
|
108284
|
+
* 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.
|
|
108458
108285
|
*
|
|
108459
108286
|
* @remarks
|
|
108460
108287
|
* [Api set: WordApi 1.3]
|
|
108461
108288
|
*/
|
|
108462
108289
|
list?: Word.Interfaces.ListLoadOptions;
|
|
108463
108290
|
/**
|
|
108464
|
-
* For EACH ITEM in the collection: Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph
|
|
108291
|
+
* 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.
|
|
108465
108292
|
*
|
|
108466
108293
|
* @remarks
|
|
108467
108294
|
* [Api set: WordApi 1.3]
|
|
@@ -108503,14 +108330,14 @@ declare namespace Word {
|
|
|
108503
108330
|
*/
|
|
108504
108331
|
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
|
|
108505
108332
|
/**
|
|
108506
|
-
* For EACH ITEM in the collection: Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it
|
|
108333
|
+
* 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.
|
|
108507
108334
|
*
|
|
108508
108335
|
* @remarks
|
|
108509
108336
|
* [Api set: WordApi 1.3]
|
|
108510
108337
|
*/
|
|
108511
108338
|
parentTable?: Word.Interfaces.TableLoadOptions;
|
|
108512
108339
|
/**
|
|
108513
|
-
* For EACH ITEM in the collection: Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it
|
|
108340
|
+
* 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.
|
|
108514
108341
|
*
|
|
108515
108342
|
* @remarks
|
|
108516
108343
|
* [Api set: WordApi 1.3]
|
|
@@ -108629,7 +108456,7 @@ declare namespace Word {
|
|
|
108629
108456
|
*/
|
|
108630
108457
|
styleBuiltIn?: boolean;
|
|
108631
108458
|
/**
|
|
108632
|
-
* For EACH ITEM in the collection: Gets the level of the paragraph's table. It returns 0 if the paragraph
|
|
108459
|
+
* 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.
|
|
108633
108460
|
*
|
|
108634
108461
|
* @remarks
|
|
108635
108462
|
* [Api set: WordApi 1.3]
|
|
@@ -108646,8 +108473,7 @@ declare namespace Word {
|
|
|
108646
108473
|
* 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.
|
|
108647
108474
|
*
|
|
108648
108475
|
* @remarks
|
|
108649
|
-
* [Api set: WordApi
|
|
108650
|
-
* @beta
|
|
108476
|
+
* [Api set: WordApi 1.6]
|
|
108651
108477
|
*/
|
|
108652
108478
|
uniqueLocalId?: boolean;
|
|
108653
108479
|
}
|
|
@@ -108801,14 +108627,14 @@ declare namespace Word {
|
|
|
108801
108627
|
*/
|
|
108802
108628
|
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
|
|
108803
108629
|
/**
|
|
108804
|
-
* Gets the table that contains the range. Throws an `ItemNotFound` error if it
|
|
108630
|
+
* Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table.
|
|
108805
108631
|
*
|
|
108806
108632
|
* @remarks
|
|
108807
108633
|
* [Api set: WordApi 1.3]
|
|
108808
108634
|
*/
|
|
108809
108635
|
parentTable?: Word.Interfaces.TableLoadOptions;
|
|
108810
108636
|
/**
|
|
108811
|
-
* Gets the table cell that contains the range. Throws an `ItemNotFound` error if it
|
|
108637
|
+
* Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell.
|
|
108812
108638
|
*
|
|
108813
108639
|
* @remarks
|
|
108814
108640
|
* [Api set: WordApi 1.3]
|
|
@@ -108904,14 +108730,14 @@ declare namespace Word {
|
|
|
108904
108730
|
*/
|
|
108905
108731
|
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
|
|
108906
108732
|
/**
|
|
108907
|
-
* For EACH ITEM in the collection: Gets the table that contains the range. Throws an `ItemNotFound` error if it
|
|
108733
|
+
* 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.
|
|
108908
108734
|
*
|
|
108909
108735
|
* @remarks
|
|
108910
108736
|
* [Api set: WordApi 1.3]
|
|
108911
108737
|
*/
|
|
108912
108738
|
parentTable?: Word.Interfaces.TableLoadOptions;
|
|
108913
108739
|
/**
|
|
108914
|
-
* For EACH ITEM in the collection: Gets the table cell that contains the range. Throws an `ItemNotFound` error if it
|
|
108740
|
+
* 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.
|
|
108915
108741
|
*
|
|
108916
108742
|
* @remarks
|
|
108917
108743
|
* [Api set: WordApi 1.3]
|
|
@@ -109041,11 +108867,11 @@ declare namespace Word {
|
|
|
109041
108867
|
*/
|
|
109042
108868
|
$all?: boolean;
|
|
109043
108869
|
/**
|
|
109044
|
-
|
|
109045
|
-
|
|
109046
|
-
|
|
109047
|
-
|
|
109048
|
-
|
|
108870
|
+
* Gets the body object of the section. This doesn't include the header/footer and other section metadata.
|
|
108871
|
+
*
|
|
108872
|
+
* @remarks
|
|
108873
|
+
* [Api set: WordApi 1.1]
|
|
108874
|
+
*/
|
|
109049
108875
|
body?: Word.Interfaces.BodyLoadOptions;
|
|
109050
108876
|
}
|
|
109051
108877
|
/**
|
|
@@ -109060,10 +108886,10 @@ declare namespace Word {
|
|
|
109060
108886
|
*/
|
|
109061
108887
|
$all?: boolean;
|
|
109062
108888
|
/**
|
|
109063
|
-
|
|
109064
|
-
|
|
109065
|
-
|
|
109066
|
-
|
|
108889
|
+
* For EACH ITEM in the collection: Gets the body object of the section. This doesn't include the header/footer and other section metadata.
|
|
108890
|
+
*
|
|
108891
|
+
* @remarks
|
|
108892
|
+
* [Api set: WordApi 1.1]
|
|
109067
108893
|
*/
|
|
109068
108894
|
body?: Word.Interfaces.BodyLoadOptions;
|
|
109069
108895
|
}
|
|
@@ -109164,23 +108990,23 @@ declare namespace Word {
|
|
|
109164
108990
|
* For EACH ITEM in the collection: Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
|
|
109165
108991
|
*
|
|
109166
108992
|
* @remarks
|
|
109167
|
-
* [Api set: WordApi
|
|
109168
|
-
* @beta
|
|
108993
|
+
* [Api set: WordApi 1.6]
|
|
109169
108994
|
*/
|
|
109170
108995
|
shading?: Word.Interfaces.ShadingLoadOptions;
|
|
109171
108996
|
/**
|
|
109172
108997
|
* For EACH ITEM in the collection: Gets a TableStyle object representing Style properties that can be applied to a table.
|
|
109173
108998
|
*
|
|
109174
108999
|
* @remarks
|
|
109175
|
-
* [Api set: WordApi
|
|
109176
|
-
* @beta
|
|
109000
|
+
* [Api set: WordApi 1.6]
|
|
109177
109001
|
*/
|
|
109178
109002
|
tableStyle?: Word.Interfaces.TableStyleLoadOptions;
|
|
109179
109003
|
/**
|
|
109180
|
-
* For EACH ITEM in the collection:
|
|
109004
|
+
* For EACH ITEM in the collection: Specifies the name of an existing style to use as the base formatting of another style.
|
|
109181
109005
|
*
|
|
109182
109006
|
* @remarks
|
|
109183
109007
|
* [Api set: WordApi 1.5]
|
|
109008
|
+
*
|
|
109009
|
+
* Note: The ability to set `baseStyle` was introduced in WordApi 1.6.
|
|
109184
109010
|
*/
|
|
109185
109011
|
baseStyle?: boolean;
|
|
109186
109012
|
/**
|
|
@@ -109220,10 +109046,12 @@ declare namespace Word {
|
|
|
109220
109046
|
*/
|
|
109221
109047
|
nameLocal?: boolean;
|
|
109222
109048
|
/**
|
|
109223
|
-
* For EACH ITEM in the collection:
|
|
109049
|
+
* 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.
|
|
109224
109050
|
*
|
|
109225
109051
|
* @remarks
|
|
109226
109052
|
* [Api set: WordApi 1.5]
|
|
109053
|
+
*
|
|
109054
|
+
* Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6.
|
|
109227
109055
|
*/
|
|
109228
109056
|
nextParagraphStyle?: boolean;
|
|
109229
109057
|
/**
|
|
@@ -109307,23 +109135,23 @@ declare namespace Word {
|
|
|
109307
109135
|
* Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
|
|
109308
109136
|
*
|
|
109309
109137
|
* @remarks
|
|
109310
|
-
* [Api set: WordApi
|
|
109311
|
-
* @beta
|
|
109138
|
+
* [Api set: WordApi 1.6]
|
|
109312
109139
|
*/
|
|
109313
109140
|
shading?: Word.Interfaces.ShadingLoadOptions;
|
|
109314
109141
|
/**
|
|
109315
109142
|
* Gets a TableStyle object representing Style properties that can be applied to a table.
|
|
109316
109143
|
*
|
|
109317
109144
|
* @remarks
|
|
109318
|
-
* [Api set: WordApi
|
|
109319
|
-
* @beta
|
|
109145
|
+
* [Api set: WordApi 1.6]
|
|
109320
109146
|
*/
|
|
109321
109147
|
tableStyle?: Word.Interfaces.TableStyleLoadOptions;
|
|
109322
109148
|
/**
|
|
109323
|
-
*
|
|
109149
|
+
* Specifies the name of an existing style to use as the base formatting of another style.
|
|
109324
109150
|
*
|
|
109325
109151
|
* @remarks
|
|
109326
109152
|
* [Api set: WordApi 1.5]
|
|
109153
|
+
*
|
|
109154
|
+
* Note: The ability to set `baseStyle` was introduced in WordApi 1.6.
|
|
109327
109155
|
*/
|
|
109328
109156
|
baseStyle?: boolean;
|
|
109329
109157
|
/**
|
|
@@ -109363,10 +109191,12 @@ declare namespace Word {
|
|
|
109363
109191
|
*/
|
|
109364
109192
|
nameLocal?: boolean;
|
|
109365
109193
|
/**
|
|
109366
|
-
*
|
|
109194
|
+
* 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.
|
|
109367
109195
|
*
|
|
109368
109196
|
* @remarks
|
|
109369
109197
|
* [Api set: WordApi 1.5]
|
|
109198
|
+
*
|
|
109199
|
+
* Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6.
|
|
109370
109200
|
*/
|
|
109371
109201
|
nextParagraphStyle?: boolean;
|
|
109372
109202
|
/**
|
|
@@ -109409,8 +109239,7 @@ declare namespace Word {
|
|
|
109409
109239
|
* Represents the shading object.
|
|
109410
109240
|
*
|
|
109411
109241
|
* @remarks
|
|
109412
|
-
* [Api set: WordApi
|
|
109413
|
-
* @beta
|
|
109242
|
+
* [Api set: WordApi 1.6]
|
|
109414
109243
|
*/
|
|
109415
109244
|
interface ShadingLoadOptions {
|
|
109416
109245
|
/**
|
|
@@ -109421,8 +109250,7 @@ declare namespace Word {
|
|
|
109421
109250
|
* Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name.
|
|
109422
109251
|
*
|
|
109423
109252
|
* @remarks
|
|
109424
|
-
* [Api set: WordApi
|
|
109425
|
-
* @beta
|
|
109253
|
+
* [Api set: WordApi 1.6]
|
|
109426
109254
|
*/
|
|
109427
109255
|
backgroundPatternColor?: boolean;
|
|
109428
109256
|
/**
|
|
@@ -109434,7 +109262,7 @@ declare namespace Word {
|
|
|
109434
109262
|
*/
|
|
109435
109263
|
foregroundPatternColor?: boolean;
|
|
109436
109264
|
/**
|
|
109437
|
-
* Specifies the shading texture of the object.
|
|
109265
|
+
* Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}.
|
|
109438
109266
|
*
|
|
109439
109267
|
* @remarks
|
|
109440
109268
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -109482,14 +109310,14 @@ declare namespace Word {
|
|
|
109482
109310
|
*/
|
|
109483
109311
|
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
|
|
109484
109312
|
/**
|
|
109485
|
-
* Gets the table that contains this table. Throws an `ItemNotFound` error if it
|
|
109313
|
+
* Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table.
|
|
109486
109314
|
*
|
|
109487
109315
|
* @remarks
|
|
109488
109316
|
* [Api set: WordApi 1.3]
|
|
109489
109317
|
*/
|
|
109490
109318
|
parentTable?: Word.Interfaces.TableLoadOptions;
|
|
109491
109319
|
/**
|
|
109492
|
-
* Gets the table cell that contains this table. Throws an `ItemNotFound` error if it
|
|
109320
|
+
* Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell.
|
|
109493
109321
|
*
|
|
109494
109322
|
* @remarks
|
|
109495
109323
|
* [Api set: WordApi 1.3]
|
|
@@ -109633,8 +109461,7 @@ declare namespace Word {
|
|
|
109633
109461
|
* Represents the TableStyle object.
|
|
109634
109462
|
*
|
|
109635
109463
|
* @remarks
|
|
109636
|
-
* [Api set: WordApi
|
|
109637
|
-
* @beta
|
|
109464
|
+
* [Api set: WordApi 1.6]
|
|
109638
109465
|
*/
|
|
109639
109466
|
interface TableStyleLoadOptions {
|
|
109640
109467
|
/**
|
|
@@ -109661,40 +109488,35 @@ declare namespace Word {
|
|
|
109661
109488
|
* Specifies the amount of space to add between the contents and the bottom borders of the cells.
|
|
109662
109489
|
*
|
|
109663
109490
|
* @remarks
|
|
109664
|
-
* [Api set: WordApi
|
|
109665
|
-
* @beta
|
|
109491
|
+
* [Api set: WordApi 1.6]
|
|
109666
109492
|
*/
|
|
109667
109493
|
bottomCellMargin?: boolean;
|
|
109668
109494
|
/**
|
|
109669
109495
|
* Specifies the spacing (in points) between the cells in a table style.
|
|
109670
109496
|
*
|
|
109671
109497
|
* @remarks
|
|
109672
|
-
* [Api set: WordApi
|
|
109673
|
-
* @beta
|
|
109498
|
+
* [Api set: WordApi 1.6]
|
|
109674
109499
|
*/
|
|
109675
109500
|
cellSpacing?: boolean;
|
|
109676
109501
|
/**
|
|
109677
109502
|
* Specifies the amount of space to add between the contents and the left borders of the cells.
|
|
109678
109503
|
*
|
|
109679
109504
|
* @remarks
|
|
109680
|
-
* [Api set: WordApi
|
|
109681
|
-
* @beta
|
|
109505
|
+
* [Api set: WordApi 1.6]
|
|
109682
109506
|
*/
|
|
109683
109507
|
leftCellMargin?: boolean;
|
|
109684
109508
|
/**
|
|
109685
109509
|
* Specifies the amount of space to add between the contents and the right borders of the cells.
|
|
109686
109510
|
*
|
|
109687
109511
|
* @remarks
|
|
109688
|
-
* [Api set: WordApi
|
|
109689
|
-
* @beta
|
|
109512
|
+
* [Api set: WordApi 1.6]
|
|
109690
109513
|
*/
|
|
109691
109514
|
rightCellMargin?: boolean;
|
|
109692
109515
|
/**
|
|
109693
109516
|
* Specifies the amount of space to add between the contents and the top borders of the cells.
|
|
109694
109517
|
*
|
|
109695
109518
|
* @remarks
|
|
109696
|
-
* [Api set: WordApi
|
|
109697
|
-
* @beta
|
|
109519
|
+
* [Api set: WordApi 1.6]
|
|
109698
109520
|
*/
|
|
109699
109521
|
topCellMargin?: boolean;
|
|
109700
109522
|
}
|
|
@@ -109738,14 +109560,14 @@ declare namespace Word {
|
|
|
109738
109560
|
*/
|
|
109739
109561
|
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
|
|
109740
109562
|
/**
|
|
109741
|
-
* For EACH ITEM in the collection: Gets the table that contains this table. Throws an `ItemNotFound` error if it
|
|
109563
|
+
* 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.
|
|
109742
109564
|
*
|
|
109743
109565
|
* @remarks
|
|
109744
109566
|
* [Api set: WordApi 1.3]
|
|
109745
109567
|
*/
|
|
109746
109568
|
parentTable?: Word.Interfaces.TableLoadOptions;
|
|
109747
109569
|
/**
|
|
109748
|
-
* For EACH ITEM in the collection: Gets the table cell that contains this table. Throws an `ItemNotFound` error if it
|
|
109570
|
+
* 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.
|
|
109749
109571
|
*
|
|
109750
109572
|
* @remarks
|
|
109751
109573
|
* [Api set: WordApi 1.3]
|
|
@@ -110264,8 +110086,7 @@ declare namespace Word {
|
|
|
110264
110086
|
* Represents a tracked change in a Word document.
|
|
110265
110087
|
*
|
|
110266
110088
|
* @remarks
|
|
110267
|
-
* [Api set: WordApi
|
|
110268
|
-
* @beta
|
|
110089
|
+
* [Api set: WordApi 1.6]
|
|
110269
110090
|
*/
|
|
110270
110091
|
interface TrackedChangeLoadOptions {
|
|
110271
110092
|
/**
|
|
@@ -110273,35 +110094,31 @@ declare namespace Word {
|
|
|
110273
110094
|
*/
|
|
110274
110095
|
$all?: boolean;
|
|
110275
110096
|
/**
|
|
110276
|
-
*
|
|
110097
|
+
* Gets the author of the tracked change.
|
|
110277
110098
|
*
|
|
110278
110099
|
* @remarks
|
|
110279
|
-
* [Api set: WordApi
|
|
110280
|
-
* @beta
|
|
110100
|
+
* [Api set: WordApi 1.6]
|
|
110281
110101
|
*/
|
|
110282
110102
|
author?: boolean;
|
|
110283
110103
|
/**
|
|
110284
|
-
*
|
|
110104
|
+
* Gets the date of the tracked change.
|
|
110285
110105
|
*
|
|
110286
110106
|
* @remarks
|
|
110287
|
-
* [Api set: WordApi
|
|
110288
|
-
* @beta
|
|
110107
|
+
* [Api set: WordApi 1.6]
|
|
110289
110108
|
*/
|
|
110290
110109
|
date?: boolean;
|
|
110291
110110
|
/**
|
|
110292
|
-
*
|
|
110111
|
+
* Gets the text of the tracked change.
|
|
110293
110112
|
*
|
|
110294
110113
|
* @remarks
|
|
110295
|
-
* [Api set: WordApi
|
|
110296
|
-
* @beta
|
|
110114
|
+
* [Api set: WordApi 1.6]
|
|
110297
110115
|
*/
|
|
110298
110116
|
text?: boolean;
|
|
110299
110117
|
/**
|
|
110300
|
-
*
|
|
110118
|
+
* Gets the type of the tracked change.
|
|
110301
110119
|
*
|
|
110302
110120
|
* @remarks
|
|
110303
|
-
* [Api set: WordApi
|
|
110304
|
-
* @beta
|
|
110121
|
+
* [Api set: WordApi 1.6]
|
|
110305
110122
|
*/
|
|
110306
110123
|
type?: boolean;
|
|
110307
110124
|
}
|
|
@@ -110309,8 +110126,7 @@ declare namespace Word {
|
|
|
110309
110126
|
* Contains a collection of {@link Word.TrackedChange} objects.
|
|
110310
110127
|
*
|
|
110311
110128
|
* @remarks
|
|
110312
|
-
* [Api set: WordApi
|
|
110313
|
-
* @beta
|
|
110129
|
+
* [Api set: WordApi 1.6]
|
|
110314
110130
|
*/
|
|
110315
110131
|
interface TrackedChangeCollectionLoadOptions {
|
|
110316
110132
|
/**
|
|
@@ -110318,35 +110134,31 @@ declare namespace Word {
|
|
|
110318
110134
|
*/
|
|
110319
110135
|
$all?: boolean;
|
|
110320
110136
|
/**
|
|
110321
|
-
* For EACH ITEM in the collection:
|
|
110137
|
+
* For EACH ITEM in the collection: Gets the author of the tracked change.
|
|
110322
110138
|
*
|
|
110323
110139
|
* @remarks
|
|
110324
|
-
* [Api set: WordApi
|
|
110325
|
-
* @beta
|
|
110140
|
+
* [Api set: WordApi 1.6]
|
|
110326
110141
|
*/
|
|
110327
110142
|
author?: boolean;
|
|
110328
110143
|
/**
|
|
110329
|
-
* For EACH ITEM in the collection:
|
|
110144
|
+
* For EACH ITEM in the collection: Gets the date of the tracked change.
|
|
110330
110145
|
*
|
|
110331
110146
|
* @remarks
|
|
110332
|
-
* [Api set: WordApi
|
|
110333
|
-
* @beta
|
|
110147
|
+
* [Api set: WordApi 1.6]
|
|
110334
110148
|
*/
|
|
110335
110149
|
date?: boolean;
|
|
110336
110150
|
/**
|
|
110337
|
-
* For EACH ITEM in the collection:
|
|
110151
|
+
* For EACH ITEM in the collection: Gets the text of the tracked change.
|
|
110338
110152
|
*
|
|
110339
110153
|
* @remarks
|
|
110340
|
-
* [Api set: WordApi
|
|
110341
|
-
* @beta
|
|
110154
|
+
* [Api set: WordApi 1.6]
|
|
110342
110155
|
*/
|
|
110343
110156
|
text?: boolean;
|
|
110344
110157
|
/**
|
|
110345
|
-
* For EACH ITEM in the collection:
|
|
110158
|
+
* For EACH ITEM in the collection: Gets the type of the tracked change.
|
|
110346
110159
|
*
|
|
110347
110160
|
* @remarks
|
|
110348
|
-
* [Api set: WordApi
|
|
110349
|
-
* @beta
|
|
110161
|
+
* [Api set: WordApi 1.6]
|
|
110350
110162
|
*/
|
|
110351
110163
|
type?: boolean;
|
|
110352
110164
|
}
|