@types/office-js 1.0.396 → 1.0.397
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- office-js/README.md +1 -1
- office-js/index.d.ts +618 -614
- office-js/package.json +3 -3
office-js/index.d.ts
CHANGED
|
@@ -85446,7 +85446,7 @@ declare namespace Word {
|
|
|
85446
85446
|
expand?: string;
|
|
85447
85447
|
}): Word.CritiqueAnnotation;
|
|
85448
85448
|
/**
|
|
85449
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
85449
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
85450
85450
|
*/
|
|
85451
85451
|
track(): Word.CritiqueAnnotation;
|
|
85452
85452
|
/**
|
|
@@ -85454,9 +85454,9 @@ declare namespace Word {
|
|
|
85454
85454
|
*/
|
|
85455
85455
|
untrack(): Word.CritiqueAnnotation;
|
|
85456
85456
|
/**
|
|
85457
|
-
|
|
85458
|
-
|
|
85459
|
-
|
|
85457
|
+
* 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.)
|
|
85458
|
+
* Whereas the original `Word.CritiqueAnnotation` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CritiqueAnnotationData`) that contains shallow copies of any loaded child properties from the original object.
|
|
85459
|
+
*/
|
|
85460
85460
|
toJSON(): Word.Interfaces.CritiqueAnnotationData;
|
|
85461
85461
|
}
|
|
85462
85462
|
/**
|
|
@@ -85567,9 +85567,9 @@ declare namespace Word {
|
|
|
85567
85567
|
*/
|
|
85568
85568
|
untrack(): Word.Annotation;
|
|
85569
85569
|
/**
|
|
85570
|
-
|
|
85571
|
-
|
|
85572
|
-
|
|
85570
|
+
* 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.)
|
|
85571
|
+
* Whereas the original `Word.Annotation` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.AnnotationData`) that contains shallow copies of any loaded child properties from the original object.
|
|
85572
|
+
*/
|
|
85573
85573
|
toJSON(): Word.Interfaces.AnnotationData;
|
|
85574
85574
|
}
|
|
85575
85575
|
/**
|
|
@@ -85764,13 +85764,13 @@ declare namespace Word {
|
|
|
85764
85764
|
*/
|
|
85765
85765
|
retrieveStylesFromBase64(base64File: string): OfficeExtension.ClientResult<string>;
|
|
85766
85766
|
/**
|
|
85767
|
-
* Create a new instance of Word.Application object
|
|
85767
|
+
* Create a new instance of the `Word.Application` object.
|
|
85768
85768
|
*/
|
|
85769
85769
|
static newObject(context: OfficeExtension.ClientRequestContext): Word.Application;
|
|
85770
85770
|
/**
|
|
85771
|
-
|
|
85772
|
-
|
|
85773
|
-
|
|
85771
|
+
* 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.)
|
|
85772
|
+
* Whereas the original `Word.Application` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ApplicationData`) that contains shallow copies of any loaded child properties from the original object.
|
|
85773
|
+
*/
|
|
85774
85774
|
toJSON(): {
|
|
85775
85775
|
[key: string]: string;
|
|
85776
85776
|
};
|
|
@@ -86163,9 +86163,9 @@ declare namespace Word {
|
|
|
86163
86163
|
*/
|
|
86164
86164
|
untrack(): Word.Body;
|
|
86165
86165
|
/**
|
|
86166
|
-
|
|
86167
|
-
|
|
86168
|
-
|
|
86166
|
+
* 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.)
|
|
86167
|
+
* Whereas the original `Word.Body` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BodyData`) that contains shallow copies of any loaded child properties from the original object.
|
|
86168
|
+
*/
|
|
86169
86169
|
toJSON(): Word.Interfaces.BodyData;
|
|
86170
86170
|
}
|
|
86171
86171
|
/**
|
|
@@ -86214,17 +86214,17 @@ declare namespace Word {
|
|
|
86214
86214
|
expand?: string;
|
|
86215
86215
|
}): Word.CheckboxContentControl;
|
|
86216
86216
|
/**
|
|
86217
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
86217
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
86218
86218
|
*/
|
|
86219
86219
|
track(): Word.CheckboxContentControl;
|
|
86220
86220
|
/**
|
|
86221
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
86221
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
86222
86222
|
*/
|
|
86223
86223
|
untrack(): Word.CheckboxContentControl;
|
|
86224
86224
|
/**
|
|
86225
|
-
|
|
86226
|
-
|
|
86227
|
-
|
|
86225
|
+
* 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.)
|
|
86226
|
+
* 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.
|
|
86227
|
+
*/
|
|
86228
86228
|
toJSON(): Word.Interfaces.CheckboxContentControlData;
|
|
86229
86229
|
}
|
|
86230
86230
|
/**
|
|
@@ -86353,9 +86353,9 @@ declare namespace Word {
|
|
|
86353
86353
|
*/
|
|
86354
86354
|
untrack(): Word.Comment;
|
|
86355
86355
|
/**
|
|
86356
|
-
|
|
86357
|
-
|
|
86358
|
-
|
|
86356
|
+
* 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.)
|
|
86357
|
+
* Whereas the original `Word.Comment` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentData`) that contains shallow copies of any loaded child properties from the original object.
|
|
86358
|
+
*/
|
|
86359
86359
|
toJSON(): Word.Interfaces.CommentData;
|
|
86360
86360
|
}
|
|
86361
86361
|
/**
|
|
@@ -86519,9 +86519,9 @@ declare namespace Word {
|
|
|
86519
86519
|
*/
|
|
86520
86520
|
untrack(): Word.CommentContentRange;
|
|
86521
86521
|
/**
|
|
86522
|
-
|
|
86523
|
-
|
|
86524
|
-
|
|
86522
|
+
* 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.)
|
|
86523
|
+
* Whereas the original `Word.CommentContentRange` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentContentRangeData`) that contains shallow copies of any loaded child properties from the original object.
|
|
86524
|
+
*/
|
|
86525
86525
|
toJSON(): Word.Interfaces.CommentContentRangeData;
|
|
86526
86526
|
}
|
|
86527
86527
|
/**
|
|
@@ -86627,9 +86627,9 @@ declare namespace Word {
|
|
|
86627
86627
|
*/
|
|
86628
86628
|
untrack(): Word.CommentReply;
|
|
86629
86629
|
/**
|
|
86630
|
-
|
|
86631
|
-
|
|
86632
|
-
|
|
86630
|
+
* 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.)
|
|
86631
|
+
* Whereas the original `Word.CommentReply` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentReplyData`) that contains shallow copies of any loaded child properties from the original object.
|
|
86632
|
+
*/
|
|
86633
86633
|
toJSON(): Word.Interfaces.CommentReplyData;
|
|
86634
86634
|
}
|
|
86635
86635
|
/**
|
|
@@ -87228,9 +87228,9 @@ declare namespace Word {
|
|
|
87228
87228
|
*/
|
|
87229
87229
|
untrack(): Word.ContentControl;
|
|
87230
87230
|
/**
|
|
87231
|
-
|
|
87232
|
-
|
|
87233
|
-
|
|
87231
|
+
* 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.)
|
|
87232
|
+
* Whereas the original `Word.ContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ContentControlData`) that contains shallow copies of any loaded child properties from the original object.
|
|
87233
|
+
*/
|
|
87234
87234
|
toJSON(): Word.Interfaces.ContentControlData;
|
|
87235
87235
|
}
|
|
87236
87236
|
/**
|
|
@@ -87445,9 +87445,9 @@ declare namespace Word {
|
|
|
87445
87445
|
*/
|
|
87446
87446
|
untrack(): Word.CustomProperty;
|
|
87447
87447
|
/**
|
|
87448
|
-
|
|
87449
|
-
|
|
87450
|
-
|
|
87448
|
+
* 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.)
|
|
87449
|
+
* Whereas the original `Word.CustomProperty` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomPropertyData`) that contains shallow copies of any loaded child properties from the original object.
|
|
87450
|
+
*/
|
|
87451
87451
|
toJSON(): Word.Interfaces.CustomPropertyData;
|
|
87452
87452
|
}
|
|
87453
87453
|
/**
|
|
@@ -87809,9 +87809,9 @@ declare namespace Word {
|
|
|
87809
87809
|
*/
|
|
87810
87810
|
untrack(): Word.CustomXmlPart;
|
|
87811
87811
|
/**
|
|
87812
|
-
|
|
87813
|
-
|
|
87814
|
-
|
|
87812
|
+
* 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.)
|
|
87813
|
+
* Whereas the original `Word.CustomXmlPart` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPartData`) that contains shallow copies of any loaded child properties from the original object.
|
|
87814
|
+
*/
|
|
87815
87815
|
toJSON(): Word.Interfaces.CustomXmlPartData;
|
|
87816
87816
|
}
|
|
87817
87817
|
/**
|
|
@@ -88078,6 +88078,8 @@ declare namespace Word {
|
|
|
88078
88078
|
/**
|
|
88079
88079
|
* Closes the current document.
|
|
88080
88080
|
*
|
|
88081
|
+
* Note: This API isn't supported in Word on the web.
|
|
88082
|
+
*
|
|
88081
88083
|
* @remarks
|
|
88082
88084
|
* [Api set: WordApi 1.5]
|
|
88083
88085
|
*
|
|
@@ -88087,6 +88089,8 @@ declare namespace Word {
|
|
|
88087
88089
|
/**
|
|
88088
88090
|
* Closes the current document.
|
|
88089
88091
|
*
|
|
88092
|
+
* Note: This API isn't supported in Word on the web.
|
|
88093
|
+
*
|
|
88090
88094
|
* @remarks
|
|
88091
88095
|
* [Api set: WordApi 1.5]
|
|
88092
88096
|
*
|
|
@@ -88352,9 +88356,9 @@ declare namespace Word {
|
|
|
88352
88356
|
*/
|
|
88353
88357
|
untrack(): Word.Document;
|
|
88354
88358
|
/**
|
|
88355
|
-
|
|
88356
|
-
|
|
88357
|
-
|
|
88359
|
+
* 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.)
|
|
88360
|
+
* Whereas the original `Word.Document` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentData`) that contains shallow copies of any loaded child properties from the original object.
|
|
88361
|
+
*/
|
|
88358
88362
|
toJSON(): Word.Interfaces.DocumentData;
|
|
88359
88363
|
}
|
|
88360
88364
|
/**
|
|
@@ -88565,9 +88569,9 @@ declare namespace Word {
|
|
|
88565
88569
|
*/
|
|
88566
88570
|
untrack(): Word.DocumentCreated;
|
|
88567
88571
|
/**
|
|
88568
|
-
|
|
88569
|
-
|
|
88570
|
-
|
|
88572
|
+
* 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.)
|
|
88573
|
+
* Whereas the original `Word.DocumentCreated` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentCreatedData`) that contains shallow copies of any loaded child properties from the original object.
|
|
88574
|
+
*/
|
|
88571
88575
|
toJSON(): Word.Interfaces.DocumentCreatedData;
|
|
88572
88576
|
}
|
|
88573
88577
|
/**
|
|
@@ -88743,9 +88747,9 @@ declare namespace Word {
|
|
|
88743
88747
|
*/
|
|
88744
88748
|
untrack(): Word.DocumentProperties;
|
|
88745
88749
|
/**
|
|
88746
|
-
|
|
88747
|
-
|
|
88748
|
-
|
|
88750
|
+
* 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.)
|
|
88751
|
+
* Whereas the original `Word.DocumentProperties` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentPropertiesData`) that contains shallow copies of any loaded child properties from the original object.
|
|
88752
|
+
*/
|
|
88749
88753
|
toJSON(): Word.Interfaces.DocumentPropertiesData;
|
|
88750
88754
|
}
|
|
88751
88755
|
/**
|
|
@@ -88936,9 +88940,9 @@ declare namespace Word {
|
|
|
88936
88940
|
*/
|
|
88937
88941
|
untrack(): Word.Field;
|
|
88938
88942
|
/**
|
|
88939
|
-
|
|
88940
|
-
|
|
88941
|
-
|
|
88943
|
+
* 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.)
|
|
88944
|
+
* Whereas the original `Word.Field` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FieldData`) that contains shallow copies of any loaded child properties from the original object.
|
|
88945
|
+
*/
|
|
88942
88946
|
toJSON(): Word.Interfaces.FieldData;
|
|
88943
88947
|
}
|
|
88944
88948
|
/**
|
|
@@ -89133,9 +89137,9 @@ declare namespace Word {
|
|
|
89133
89137
|
*/
|
|
89134
89138
|
untrack(): Word.Font;
|
|
89135
89139
|
/**
|
|
89136
|
-
|
|
89137
|
-
|
|
89138
|
-
|
|
89140
|
+
* 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.)
|
|
89141
|
+
* Whereas the original `Word.Font` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FontData`) that contains shallow copies of any loaded child properties from the original object.
|
|
89142
|
+
*/
|
|
89139
89143
|
toJSON(): Word.Interfaces.FontData;
|
|
89140
89144
|
}
|
|
89141
89145
|
/**
|
|
@@ -89410,9 +89414,9 @@ declare namespace Word {
|
|
|
89410
89414
|
*/
|
|
89411
89415
|
untrack(): Word.InlinePicture;
|
|
89412
89416
|
/**
|
|
89413
|
-
|
|
89414
|
-
|
|
89415
|
-
|
|
89417
|
+
* 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.)
|
|
89418
|
+
* Whereas the original `Word.InlinePicture` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.InlinePictureData`) that contains shallow copies of any loaded child properties from the original object.
|
|
89419
|
+
*/
|
|
89416
89420
|
toJSON(): Word.Interfaces.InlinePictureData;
|
|
89417
89421
|
}
|
|
89418
89422
|
/**
|
|
@@ -89654,9 +89658,9 @@ declare namespace Word {
|
|
|
89654
89658
|
*/
|
|
89655
89659
|
untrack(): Word.List;
|
|
89656
89660
|
/**
|
|
89657
|
-
|
|
89658
|
-
|
|
89659
|
-
|
|
89661
|
+
* 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.)
|
|
89662
|
+
* Whereas the original `Word.List` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListData`) that contains shallow copies of any loaded child properties from the original object.
|
|
89663
|
+
*/
|
|
89660
89664
|
toJSON(): Word.Interfaces.ListData;
|
|
89661
89665
|
}
|
|
89662
89666
|
/**
|
|
@@ -89838,9 +89842,9 @@ declare namespace Word {
|
|
|
89838
89842
|
*/
|
|
89839
89843
|
untrack(): Word.ListItem;
|
|
89840
89844
|
/**
|
|
89841
|
-
|
|
89842
|
-
|
|
89843
|
-
|
|
89845
|
+
* 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.)
|
|
89846
|
+
* Whereas the original `Word.ListItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListItemData`) that contains shallow copies of any loaded child properties from the original object.
|
|
89847
|
+
*/
|
|
89844
89848
|
toJSON(): Word.Interfaces.ListItemData;
|
|
89845
89849
|
}
|
|
89846
89850
|
/**
|
|
@@ -89932,9 +89936,9 @@ declare namespace Word {
|
|
|
89932
89936
|
*/
|
|
89933
89937
|
untrack(): Word.NoteItem;
|
|
89934
89938
|
/**
|
|
89935
|
-
|
|
89936
|
-
|
|
89937
|
-
|
|
89939
|
+
* 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.)
|
|
89940
|
+
* Whereas the original `Word.NoteItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.NoteItemData`) that contains shallow copies of any loaded child properties from the original object.
|
|
89941
|
+
*/
|
|
89938
89942
|
toJSON(): Word.Interfaces.NoteItemData;
|
|
89939
89943
|
}
|
|
89940
89944
|
/**
|
|
@@ -90595,9 +90599,9 @@ declare namespace Word {
|
|
|
90595
90599
|
*/
|
|
90596
90600
|
untrack(): Word.Paragraph;
|
|
90597
90601
|
/**
|
|
90598
|
-
|
|
90599
|
-
|
|
90600
|
-
|
|
90602
|
+
* 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.)
|
|
90603
|
+
* Whereas the original `Word.Paragraph` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ParagraphData`) that contains shallow copies of any loaded child properties from the original object.
|
|
90604
|
+
*/
|
|
90601
90605
|
toJSON(): Word.Interfaces.ParagraphData;
|
|
90602
90606
|
}
|
|
90603
90607
|
/**
|
|
@@ -90816,9 +90820,9 @@ declare namespace Word {
|
|
|
90816
90820
|
*/
|
|
90817
90821
|
untrack(): Word.ParagraphFormat;
|
|
90818
90822
|
/**
|
|
90819
|
-
|
|
90820
|
-
|
|
90821
|
-
|
|
90823
|
+
* 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.)
|
|
90824
|
+
* Whereas the original `Word.ParagraphFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ParagraphFormatData`) that contains shallow copies of any loaded child properties from the original object.
|
|
90825
|
+
*/
|
|
90822
90826
|
toJSON(): Word.Interfaces.ParagraphFormatData;
|
|
90823
90827
|
}
|
|
90824
90828
|
/**
|
|
@@ -91441,9 +91445,9 @@ declare namespace Word {
|
|
|
91441
91445
|
*/
|
|
91442
91446
|
untrack(): Word.Range;
|
|
91443
91447
|
/**
|
|
91444
|
-
|
|
91445
|
-
|
|
91446
|
-
|
|
91448
|
+
* 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.)
|
|
91449
|
+
* Whereas the original `Word.Range` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RangeData`) that contains shallow copies of any loaded child properties from the original object.
|
|
91450
|
+
*/
|
|
91447
91451
|
toJSON(): Word.Interfaces.RangeData;
|
|
91448
91452
|
}
|
|
91449
91453
|
/**
|
|
@@ -91656,13 +91660,13 @@ declare namespace Word {
|
|
|
91656
91660
|
expand?: string;
|
|
91657
91661
|
}): Word.SearchOptions;
|
|
91658
91662
|
/**
|
|
91659
|
-
* Create a new instance of Word.SearchOptions object
|
|
91663
|
+
* Create a new instance of the `Word.SearchOptions` object.
|
|
91660
91664
|
*/
|
|
91661
91665
|
static newObject(context: OfficeExtension.ClientRequestContext): Word.SearchOptions;
|
|
91662
91666
|
/**
|
|
91663
|
-
|
|
91664
|
-
|
|
91665
|
-
|
|
91667
|
+
* 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.)
|
|
91668
|
+
* Whereas the original `Word.SearchOptions` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SearchOptionsData`) that contains shallow copies of any loaded child properties from the original object.
|
|
91669
|
+
*/
|
|
91666
91670
|
toJSON(): Word.Interfaces.SearchOptionsData;
|
|
91667
91671
|
}
|
|
91668
91672
|
/**
|
|
@@ -91791,9 +91795,9 @@ declare namespace Word {
|
|
|
91791
91795
|
*/
|
|
91792
91796
|
untrack(): Word.Section;
|
|
91793
91797
|
/**
|
|
91794
|
-
|
|
91795
|
-
|
|
91796
|
-
|
|
91798
|
+
* 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.)
|
|
91799
|
+
* Whereas the original `Word.Section` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SectionData`) that contains shallow copies of any loaded child properties from the original object.
|
|
91800
|
+
*/
|
|
91797
91801
|
toJSON(): Word.Interfaces.SectionData;
|
|
91798
91802
|
}
|
|
91799
91803
|
/**
|
|
@@ -91921,9 +91925,9 @@ declare namespace Word {
|
|
|
91921
91925
|
*/
|
|
91922
91926
|
untrack(): Word.Setting;
|
|
91923
91927
|
/**
|
|
91924
|
-
|
|
91925
|
-
|
|
91926
|
-
|
|
91928
|
+
* 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.)
|
|
91929
|
+
* Whereas the original `Word.Setting` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SettingData`) that contains shallow copies of any loaded child properties from the original object.
|
|
91930
|
+
*/
|
|
91927
91931
|
toJSON(): Word.Interfaces.SettingData;
|
|
91928
91932
|
}
|
|
91929
91933
|
/**
|
|
@@ -92251,9 +92255,9 @@ declare namespace Word {
|
|
|
92251
92255
|
*/
|
|
92252
92256
|
untrack(): Word.Style;
|
|
92253
92257
|
/**
|
|
92254
|
-
|
|
92255
|
-
|
|
92256
|
-
|
|
92258
|
+
* 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.)
|
|
92259
|
+
* Whereas the original `Word.Style` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.StyleData`) that contains shallow copies of any loaded child properties from the original object.
|
|
92260
|
+
*/
|
|
92257
92261
|
toJSON(): Word.Interfaces.StyleData;
|
|
92258
92262
|
}
|
|
92259
92263
|
/**
|
|
@@ -92310,9 +92314,9 @@ declare namespace Word {
|
|
|
92310
92314
|
*/
|
|
92311
92315
|
untrack(): Word.Shading;
|
|
92312
92316
|
/**
|
|
92313
|
-
|
|
92314
|
-
|
|
92315
|
-
|
|
92317
|
+
* 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.)
|
|
92318
|
+
* Whereas the original `Word.Shading` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShadingData`) that contains shallow copies of any loaded child properties from the original object.
|
|
92319
|
+
*/
|
|
92316
92320
|
toJSON(): Word.Interfaces.ShadingData;
|
|
92317
92321
|
}
|
|
92318
92322
|
/**
|
|
@@ -92846,9 +92850,9 @@ declare namespace Word {
|
|
|
92846
92850
|
*/
|
|
92847
92851
|
untrack(): Word.Table;
|
|
92848
92852
|
/**
|
|
92849
|
-
|
|
92850
|
-
|
|
92851
|
-
|
|
92853
|
+
* 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.)
|
|
92854
|
+
* Whereas the original `Word.Table` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableData`) that contains shallow copies of any loaded child properties from the original object.
|
|
92855
|
+
*/
|
|
92852
92856
|
toJSON(): Word.Interfaces.TableData;
|
|
92853
92857
|
}
|
|
92854
92858
|
/**
|
|
@@ -92933,9 +92937,9 @@ declare namespace Word {
|
|
|
92933
92937
|
*/
|
|
92934
92938
|
untrack(): Word.TableStyle;
|
|
92935
92939
|
/**
|
|
92936
|
-
|
|
92937
|
-
|
|
92938
|
-
|
|
92940
|
+
* 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.)
|
|
92941
|
+
* Whereas the original `Word.TableStyle` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableStyleData`) that contains shallow copies of any loaded child properties from the original object.
|
|
92942
|
+
*/
|
|
92939
92943
|
toJSON(): Word.Interfaces.TableStyleData;
|
|
92940
92944
|
}
|
|
92941
92945
|
/**
|
|
@@ -93278,9 +93282,9 @@ declare namespace Word {
|
|
|
93278
93282
|
*/
|
|
93279
93283
|
untrack(): Word.TableRow;
|
|
93280
93284
|
/**
|
|
93281
|
-
|
|
93282
|
-
|
|
93283
|
-
|
|
93285
|
+
* 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.)
|
|
93286
|
+
* Whereas the original `Word.TableRow` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableRowData`) that contains shallow copies of any loaded child properties from the original object.
|
|
93287
|
+
*/
|
|
93284
93288
|
toJSON(): Word.Interfaces.TableRowData;
|
|
93285
93289
|
}
|
|
93286
93290
|
/**
|
|
@@ -93580,9 +93584,9 @@ declare namespace Word {
|
|
|
93580
93584
|
*/
|
|
93581
93585
|
untrack(): Word.TableCell;
|
|
93582
93586
|
/**
|
|
93583
|
-
|
|
93584
|
-
|
|
93585
|
-
|
|
93587
|
+
* 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.)
|
|
93588
|
+
* Whereas the original `Word.TableCell` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCellData`) that contains shallow copies of any loaded child properties from the original object.
|
|
93589
|
+
*/
|
|
93586
93590
|
toJSON(): Word.Interfaces.TableCellData;
|
|
93587
93591
|
}
|
|
93588
93592
|
/**
|
|
@@ -93710,9 +93714,9 @@ declare namespace Word {
|
|
|
93710
93714
|
*/
|
|
93711
93715
|
untrack(): Word.TableBorder;
|
|
93712
93716
|
/**
|
|
93713
|
-
|
|
93714
|
-
|
|
93715
|
-
|
|
93717
|
+
* 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.)
|
|
93718
|
+
* Whereas the original `Word.TableBorder` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableBorderData`) that contains shallow copies of any loaded child properties from the original object.
|
|
93719
|
+
*/
|
|
93716
93720
|
toJSON(): Word.Interfaces.TableBorderData;
|
|
93717
93721
|
}
|
|
93718
93722
|
/**
|
|
@@ -93817,9 +93821,9 @@ declare namespace Word {
|
|
|
93817
93821
|
*/
|
|
93818
93822
|
untrack(): Word.TrackedChange;
|
|
93819
93823
|
/**
|
|
93820
|
-
|
|
93821
|
-
|
|
93822
|
-
|
|
93824
|
+
* 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.)
|
|
93825
|
+
* Whereas the original `Word.TrackedChange` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TrackedChangeData`) that contains shallow copies of any loaded child properties from the original object.
|
|
93826
|
+
*/
|
|
93823
93827
|
toJSON(): Word.Interfaces.TrackedChangeData;
|
|
93824
93828
|
}
|
|
93825
93829
|
/**
|
|
@@ -96854,30 +96858,30 @@ declare namespace Word {
|
|
|
96854
96858
|
}
|
|
96855
96859
|
namespace Interfaces {
|
|
96856
96860
|
/**
|
|
96857
|
-
|
|
96858
|
-
|
|
96861
|
+
* Provides ways to load properties of only a subset of members of a collection.
|
|
96862
|
+
*/
|
|
96859
96863
|
interface CollectionLoadOptions {
|
|
96860
96864
|
/**
|
|
96861
|
-
|
|
96862
|
-
|
|
96865
|
+
* Specify the number of items in the queried collection to be included in the result.
|
|
96866
|
+
*/
|
|
96863
96867
|
$top?: number;
|
|
96864
96868
|
/**
|
|
96865
|
-
|
|
96866
|
-
|
|
96869
|
+
* Specify the number of items in the collection that are to be skipped and not included in the result. If top is specified, the selection of result will start after skipping the specified number of items.
|
|
96870
|
+
*/
|
|
96867
96871
|
$skip?: number;
|
|
96868
96872
|
}
|
|
96869
|
-
/** An interface for updating data on the AnnotationCollection object, for use in `annotationCollection.set({ ... })`. */
|
|
96873
|
+
/** An interface for updating data on the `AnnotationCollection` object, for use in `annotationCollection.set({ ... })`. */
|
|
96870
96874
|
interface AnnotationCollectionUpdateData {
|
|
96871
96875
|
items?: Word.Interfaces.AnnotationData[];
|
|
96872
96876
|
}
|
|
96873
|
-
/** An interface for updating data on the Body object, for use in `body.set({ ... })`. */
|
|
96877
|
+
/** An interface for updating data on the `Body` object, for use in `body.set({ ... })`. */
|
|
96874
96878
|
interface BodyUpdateData {
|
|
96875
96879
|
/**
|
|
96876
|
-
|
|
96877
|
-
|
|
96878
|
-
|
|
96879
|
-
|
|
96880
|
-
|
|
96880
|
+
* Gets the text format of the body. Use this to get and set font name, size, color and other properties.
|
|
96881
|
+
*
|
|
96882
|
+
* @remarks
|
|
96883
|
+
* [Api set: WordApi 1.1]
|
|
96884
|
+
*/
|
|
96881
96885
|
font?: Word.Interfaces.FontUpdateData;
|
|
96882
96886
|
/**
|
|
96883
96887
|
* 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.
|
|
@@ -96894,7 +96898,7 @@ declare namespace Word {
|
|
|
96894
96898
|
*/
|
|
96895
96899
|
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";
|
|
96896
96900
|
}
|
|
96897
|
-
/** An interface for updating data on the CheckboxContentControl object, for use in `checkboxContentControl.set({ ... })`. */
|
|
96901
|
+
/** An interface for updating data on the `CheckboxContentControl` object, for use in `checkboxContentControl.set({ ... })`. */
|
|
96898
96902
|
interface CheckboxContentControlUpdateData {
|
|
96899
96903
|
/**
|
|
96900
96904
|
* Specifies the current state of the checkbox.
|
|
@@ -96904,14 +96908,14 @@ declare namespace Word {
|
|
|
96904
96908
|
*/
|
|
96905
96909
|
isChecked?: boolean;
|
|
96906
96910
|
}
|
|
96907
|
-
/** An interface for updating data on the Comment object, for use in `comment.set({ ... })`. */
|
|
96911
|
+
/** An interface for updating data on the `Comment` object, for use in `comment.set({ ... })`. */
|
|
96908
96912
|
interface CommentUpdateData {
|
|
96909
96913
|
/**
|
|
96910
|
-
|
|
96911
|
-
|
|
96912
|
-
|
|
96913
|
-
|
|
96914
|
-
|
|
96914
|
+
* Specifies the comment's content range.
|
|
96915
|
+
*
|
|
96916
|
+
* @remarks
|
|
96917
|
+
* [Api set: WordApi 1.4]
|
|
96918
|
+
*/
|
|
96915
96919
|
contentRange?: Word.Interfaces.CommentContentRangeUpdateData;
|
|
96916
96920
|
/**
|
|
96917
96921
|
* Specifies the comment's content as plain text.
|
|
@@ -96928,11 +96932,11 @@ declare namespace Word {
|
|
|
96928
96932
|
*/
|
|
96929
96933
|
resolved?: boolean;
|
|
96930
96934
|
}
|
|
96931
|
-
/** An interface for updating data on the CommentCollection object, for use in `commentCollection.set({ ... })`. */
|
|
96935
|
+
/** An interface for updating data on the `CommentCollection` object, for use in `commentCollection.set({ ... })`. */
|
|
96932
96936
|
interface CommentCollectionUpdateData {
|
|
96933
96937
|
items?: Word.Interfaces.CommentData[];
|
|
96934
96938
|
}
|
|
96935
|
-
/** An interface for updating data on the CommentContentRange object, for use in `commentContentRange.set({ ... })`. */
|
|
96939
|
+
/** An interface for updating data on the `CommentContentRange` object, for use in `commentContentRange.set({ ... })`. */
|
|
96936
96940
|
interface CommentContentRangeUpdateData {
|
|
96937
96941
|
/**
|
|
96938
96942
|
* Specifies a value that indicates whether the comment text is bold.
|
|
@@ -96970,21 +96974,21 @@ declare namespace Word {
|
|
|
96970
96974
|
*/
|
|
96971
96975
|
underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble";
|
|
96972
96976
|
}
|
|
96973
|
-
/** An interface for updating data on the CommentReply object, for use in `commentReply.set({ ... })`. */
|
|
96977
|
+
/** An interface for updating data on the `CommentReply` object, for use in `commentReply.set({ ... })`. */
|
|
96974
96978
|
interface CommentReplyUpdateData {
|
|
96975
96979
|
/**
|
|
96976
|
-
|
|
96977
|
-
|
|
96978
|
-
|
|
96979
|
-
|
|
96980
|
-
|
|
96980
|
+
* Specifies the commentReply's content range.
|
|
96981
|
+
*
|
|
96982
|
+
* @remarks
|
|
96983
|
+
* [Api set: WordApi 1.4]
|
|
96984
|
+
*/
|
|
96981
96985
|
contentRange?: Word.Interfaces.CommentContentRangeUpdateData;
|
|
96982
96986
|
/**
|
|
96983
|
-
|
|
96984
|
-
|
|
96985
|
-
|
|
96986
|
-
|
|
96987
|
-
|
|
96987
|
+
* Gets the parent comment of this reply.
|
|
96988
|
+
*
|
|
96989
|
+
* @remarks
|
|
96990
|
+
* [Api set: WordApi 1.4]
|
|
96991
|
+
*/
|
|
96988
96992
|
parentComment?: Word.Interfaces.CommentUpdateData;
|
|
96989
96993
|
/**
|
|
96990
96994
|
* Specifies the comment reply's content. The string is plain text.
|
|
@@ -96994,11 +96998,11 @@ declare namespace Word {
|
|
|
96994
96998
|
*/
|
|
96995
96999
|
content?: string;
|
|
96996
97000
|
}
|
|
96997
|
-
/** An interface for updating data on the CommentReplyCollection object, for use in `commentReplyCollection.set({ ... })`. */
|
|
97001
|
+
/** An interface for updating data on the `CommentReplyCollection` object, for use in `commentReplyCollection.set({ ... })`. */
|
|
96998
97002
|
interface CommentReplyCollectionUpdateData {
|
|
96999
97003
|
items?: Word.Interfaces.CommentReplyData[];
|
|
97000
97004
|
}
|
|
97001
|
-
/** An interface for updating data on the ContentControl object, for use in `contentControl.set({ ... })`. */
|
|
97005
|
+
/** An interface for updating data on the `ContentControl` object, for use in `contentControl.set({ ... })`. */
|
|
97002
97006
|
interface ContentControlUpdateData {
|
|
97003
97007
|
/**
|
|
97004
97008
|
* Specifies the checkbox-related data if the content control's type is 'CheckBox'. It's null otherwise.
|
|
@@ -97087,11 +97091,11 @@ declare namespace Word {
|
|
|
97087
97091
|
*/
|
|
97088
97092
|
title?: string;
|
|
97089
97093
|
}
|
|
97090
|
-
/** An interface for updating data on the ContentControlCollection object, for use in `contentControlCollection.set({ ... })`. */
|
|
97094
|
+
/** An interface for updating data on the `ContentControlCollection` object, for use in `contentControlCollection.set({ ... })`. */
|
|
97091
97095
|
interface ContentControlCollectionUpdateData {
|
|
97092
97096
|
items?: Word.Interfaces.ContentControlData[];
|
|
97093
97097
|
}
|
|
97094
|
-
/** An interface for updating data on the CustomProperty object, for use in `customProperty.set({ ... })`. */
|
|
97098
|
+
/** An interface for updating data on the `CustomProperty` object, for use in `customProperty.set({ ... })`. */
|
|
97095
97099
|
interface CustomPropertyUpdateData {
|
|
97096
97100
|
/**
|
|
97097
97101
|
* Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair).
|
|
@@ -97101,33 +97105,33 @@ declare namespace Word {
|
|
|
97101
97105
|
*/
|
|
97102
97106
|
value?: any;
|
|
97103
97107
|
}
|
|
97104
|
-
/** An interface for updating data on the CustomPropertyCollection object, for use in `customPropertyCollection.set({ ... })`. */
|
|
97108
|
+
/** An interface for updating data on the `CustomPropertyCollection` object, for use in `customPropertyCollection.set({ ... })`. */
|
|
97105
97109
|
interface CustomPropertyCollectionUpdateData {
|
|
97106
97110
|
items?: Word.Interfaces.CustomPropertyData[];
|
|
97107
97111
|
}
|
|
97108
|
-
/** An interface for updating data on the CustomXmlPartCollection object, for use in `customXmlPartCollection.set({ ... })`. */
|
|
97112
|
+
/** An interface for updating data on the `CustomXmlPartCollection` object, for use in `customXmlPartCollection.set({ ... })`. */
|
|
97109
97113
|
interface CustomXmlPartCollectionUpdateData {
|
|
97110
97114
|
items?: Word.Interfaces.CustomXmlPartData[];
|
|
97111
97115
|
}
|
|
97112
|
-
/** An interface for updating data on the CustomXmlPartScopedCollection object, for use in `customXmlPartScopedCollection.set({ ... })`. */
|
|
97116
|
+
/** An interface for updating data on the `CustomXmlPartScopedCollection` object, for use in `customXmlPartScopedCollection.set({ ... })`. */
|
|
97113
97117
|
interface CustomXmlPartScopedCollectionUpdateData {
|
|
97114
97118
|
items?: Word.Interfaces.CustomXmlPartData[];
|
|
97115
97119
|
}
|
|
97116
|
-
/** An interface for updating data on the Document object, for use in `document.set({ ... })`. */
|
|
97120
|
+
/** An interface for updating data on the `Document` object, for use in `document.set({ ... })`. */
|
|
97117
97121
|
interface DocumentUpdateData {
|
|
97118
97122
|
/**
|
|
97119
|
-
|
|
97120
|
-
|
|
97121
|
-
|
|
97122
|
-
|
|
97123
|
-
|
|
97123
|
+
* Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc.
|
|
97124
|
+
*
|
|
97125
|
+
* @remarks
|
|
97126
|
+
* [Api set: WordApi 1.1]
|
|
97127
|
+
*/
|
|
97124
97128
|
body?: Word.Interfaces.BodyUpdateData;
|
|
97125
97129
|
/**
|
|
97126
|
-
|
|
97127
|
-
|
|
97128
|
-
|
|
97129
|
-
|
|
97130
|
-
|
|
97130
|
+
* Gets the properties of the document.
|
|
97131
|
+
*
|
|
97132
|
+
* @remarks
|
|
97133
|
+
* [Api set: WordApi 1.3]
|
|
97134
|
+
*/
|
|
97131
97135
|
properties?: Word.Interfaces.DocumentPropertiesUpdateData;
|
|
97132
97136
|
/**
|
|
97133
97137
|
* Specifies the ChangeTracking mode.
|
|
@@ -97137,24 +97141,24 @@ declare namespace Word {
|
|
|
97137
97141
|
*/
|
|
97138
97142
|
changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly";
|
|
97139
97143
|
}
|
|
97140
|
-
/** An interface for updating data on the DocumentCreated object, for use in `documentCreated.set({ ... })`. */
|
|
97144
|
+
/** An interface for updating data on the `DocumentCreated` object, for use in `documentCreated.set({ ... })`. */
|
|
97141
97145
|
interface DocumentCreatedUpdateData {
|
|
97142
97146
|
/**
|
|
97143
|
-
|
|
97144
|
-
|
|
97145
|
-
|
|
97146
|
-
|
|
97147
|
-
|
|
97147
|
+
* Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc.
|
|
97148
|
+
*
|
|
97149
|
+
* @remarks
|
|
97150
|
+
* [Api set: WordApiHiddenDocument 1.3]
|
|
97151
|
+
*/
|
|
97148
97152
|
body?: Word.Interfaces.BodyUpdateData;
|
|
97149
97153
|
/**
|
|
97150
|
-
|
|
97151
|
-
|
|
97152
|
-
|
|
97153
|
-
|
|
97154
|
-
|
|
97154
|
+
* Gets the properties of the document.
|
|
97155
|
+
*
|
|
97156
|
+
* @remarks
|
|
97157
|
+
* [Api set: WordApiHiddenDocument 1.3]
|
|
97158
|
+
*/
|
|
97155
97159
|
properties?: Word.Interfaces.DocumentPropertiesUpdateData;
|
|
97156
97160
|
}
|
|
97157
|
-
/** An interface for updating data on the DocumentProperties object, for use in `documentProperties.set({ ... })`. */
|
|
97161
|
+
/** An interface for updating data on the `DocumentProperties` object, for use in `documentProperties.set({ ... })`. */
|
|
97158
97162
|
interface DocumentPropertiesUpdateData {
|
|
97159
97163
|
/**
|
|
97160
97164
|
* Specifies the author of the document.
|
|
@@ -97220,14 +97224,14 @@ declare namespace Word {
|
|
|
97220
97224
|
*/
|
|
97221
97225
|
title?: string;
|
|
97222
97226
|
}
|
|
97223
|
-
/** An interface for updating data on the Field object, for use in `field.set({ ... })`. */
|
|
97227
|
+
/** An interface for updating data on the `Field` object, for use in `field.set({ ... })`. */
|
|
97224
97228
|
interface FieldUpdateData {
|
|
97225
97229
|
/**
|
|
97226
|
-
|
|
97227
|
-
|
|
97228
|
-
|
|
97229
|
-
|
|
97230
|
-
|
|
97230
|
+
* Gets the field's result data.
|
|
97231
|
+
*
|
|
97232
|
+
* @remarks
|
|
97233
|
+
* [Api set: WordApi 1.4]
|
|
97234
|
+
*/
|
|
97231
97235
|
result?: Word.Interfaces.RangeUpdateData;
|
|
97232
97236
|
/**
|
|
97233
97237
|
* Specifies the field's code instruction.
|
|
@@ -97253,11 +97257,11 @@ declare namespace Word {
|
|
|
97253
97257
|
*/
|
|
97254
97258
|
locked?: boolean;
|
|
97255
97259
|
}
|
|
97256
|
-
/** An interface for updating data on the FieldCollection object, for use in `fieldCollection.set({ ... })`. */
|
|
97260
|
+
/** An interface for updating data on the `FieldCollection` object, for use in `fieldCollection.set({ ... })`. */
|
|
97257
97261
|
interface FieldCollectionUpdateData {
|
|
97258
97262
|
items?: Word.Interfaces.FieldData[];
|
|
97259
97263
|
}
|
|
97260
|
-
/** An interface for updating data on the Font object, for use in `font.set({ ... })`. */
|
|
97264
|
+
/** An interface for updating data on the `Font` object, for use in `font.set({ ... })`. */
|
|
97261
97265
|
interface FontUpdateData {
|
|
97262
97266
|
/**
|
|
97263
97267
|
* Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false.
|
|
@@ -97337,7 +97341,7 @@ declare namespace Word {
|
|
|
97337
97341
|
*/
|
|
97338
97342
|
underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble";
|
|
97339
97343
|
}
|
|
97340
|
-
/** An interface for updating data on the InlinePicture object, for use in `inlinePicture.set({ ... })`. */
|
|
97344
|
+
/** An interface for updating data on the `InlinePicture` object, for use in `inlinePicture.set({ ... })`. */
|
|
97341
97345
|
interface InlinePictureUpdateData {
|
|
97342
97346
|
/**
|
|
97343
97347
|
* Specifies a string that represents the alternative text associated with the inline image.
|
|
@@ -97382,15 +97386,15 @@ declare namespace Word {
|
|
|
97382
97386
|
*/
|
|
97383
97387
|
width?: number;
|
|
97384
97388
|
}
|
|
97385
|
-
/** An interface for updating data on the InlinePictureCollection object, for use in `inlinePictureCollection.set({ ... })`. */
|
|
97389
|
+
/** An interface for updating data on the `InlinePictureCollection` object, for use in `inlinePictureCollection.set({ ... })`. */
|
|
97386
97390
|
interface InlinePictureCollectionUpdateData {
|
|
97387
97391
|
items?: Word.Interfaces.InlinePictureData[];
|
|
97388
97392
|
}
|
|
97389
|
-
/** An interface for updating data on the ListCollection object, for use in `listCollection.set({ ... })`. */
|
|
97393
|
+
/** An interface for updating data on the `ListCollection` object, for use in `listCollection.set({ ... })`. */
|
|
97390
97394
|
interface ListCollectionUpdateData {
|
|
97391
97395
|
items?: Word.Interfaces.ListData[];
|
|
97392
97396
|
}
|
|
97393
|
-
/** An interface for updating data on the ListItem object, for use in `listItem.set({ ... })`. */
|
|
97397
|
+
/** An interface for updating data on the `ListItem` object, for use in `listItem.set({ ... })`. */
|
|
97394
97398
|
interface ListItemUpdateData {
|
|
97395
97399
|
/**
|
|
97396
97400
|
* Specifies the level of the item in the list.
|
|
@@ -97400,62 +97404,62 @@ declare namespace Word {
|
|
|
97400
97404
|
*/
|
|
97401
97405
|
level?: number;
|
|
97402
97406
|
}
|
|
97403
|
-
/** An interface for updating data on the NoteItem object, for use in `noteItem.set({ ... })`. */
|
|
97407
|
+
/** An interface for updating data on the `NoteItem` object, for use in `noteItem.set({ ... })`. */
|
|
97404
97408
|
interface NoteItemUpdateData {
|
|
97405
97409
|
/**
|
|
97406
|
-
|
|
97407
|
-
|
|
97408
|
-
|
|
97409
|
-
|
|
97410
|
-
|
|
97410
|
+
* Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
|
|
97411
|
+
*
|
|
97412
|
+
* @remarks
|
|
97413
|
+
* [Api set: WordApi 1.5]
|
|
97414
|
+
*/
|
|
97411
97415
|
body?: Word.Interfaces.BodyUpdateData;
|
|
97412
97416
|
/**
|
|
97413
|
-
|
|
97414
|
-
|
|
97415
|
-
|
|
97416
|
-
|
|
97417
|
-
|
|
97417
|
+
* Represents a footnote or endnote reference in the main document.
|
|
97418
|
+
*
|
|
97419
|
+
* @remarks
|
|
97420
|
+
* [Api set: WordApi 1.5]
|
|
97421
|
+
*/
|
|
97418
97422
|
reference?: Word.Interfaces.RangeUpdateData;
|
|
97419
97423
|
}
|
|
97420
|
-
/** An interface for updating data on the NoteItemCollection object, for use in `noteItemCollection.set({ ... })`. */
|
|
97424
|
+
/** An interface for updating data on the `NoteItemCollection` object, for use in `noteItemCollection.set({ ... })`. */
|
|
97421
97425
|
interface NoteItemCollectionUpdateData {
|
|
97422
97426
|
items?: Word.Interfaces.NoteItemData[];
|
|
97423
97427
|
}
|
|
97424
|
-
/** An interface for updating data on the Paragraph object, for use in `paragraph.set({ ... })`. */
|
|
97428
|
+
/** An interface for updating data on the `Paragraph` object, for use in `paragraph.set({ ... })`. */
|
|
97425
97429
|
interface ParagraphUpdateData {
|
|
97426
97430
|
/**
|
|
97427
|
-
|
|
97428
|
-
*
|
|
97429
|
-
* @remarks
|
|
97430
|
-
* [Api set: WordApi 1.1]
|
|
97431
|
-
*/
|
|
97432
|
-
font?: Word.Interfaces.FontUpdateData;
|
|
97433
|
-
/**
|
|
97434
|
-
* Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list.
|
|
97435
|
-
*
|
|
97436
|
-
* @remarks
|
|
97437
|
-
* [Api set: WordApi 1.3]
|
|
97438
|
-
*/
|
|
97439
|
-
listItem?: Word.Interfaces.ListItemUpdateData;
|
|
97440
|
-
/**
|
|
97441
|
-
* 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}.
|
|
97442
|
-
*
|
|
97443
|
-
* @remarks
|
|
97444
|
-
* [Api set: WordApi 1.3]
|
|
97445
|
-
*/
|
|
97446
|
-
listItemOrNullObject?: Word.Interfaces.ListItemUpdateData;
|
|
97447
|
-
/**
|
|
97448
|
-
* Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'.
|
|
97431
|
+
* Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties.
|
|
97449
97432
|
*
|
|
97450
97433
|
* @remarks
|
|
97451
97434
|
* [Api set: WordApi 1.1]
|
|
97452
97435
|
*/
|
|
97453
|
-
|
|
97436
|
+
font?: Word.Interfaces.FontUpdateData;
|
|
97454
97437
|
/**
|
|
97455
|
-
*
|
|
97438
|
+
* Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list.
|
|
97456
97439
|
*
|
|
97457
97440
|
* @remarks
|
|
97458
|
-
* [Api set: WordApi 1.
|
|
97441
|
+
* [Api set: WordApi 1.3]
|
|
97442
|
+
*/
|
|
97443
|
+
listItem?: Word.Interfaces.ListItemUpdateData;
|
|
97444
|
+
/**
|
|
97445
|
+
* 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}.
|
|
97446
|
+
*
|
|
97447
|
+
* @remarks
|
|
97448
|
+
* [Api set: WordApi 1.3]
|
|
97449
|
+
*/
|
|
97450
|
+
listItemOrNullObject?: Word.Interfaces.ListItemUpdateData;
|
|
97451
|
+
/**
|
|
97452
|
+
* Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'.
|
|
97453
|
+
*
|
|
97454
|
+
* @remarks
|
|
97455
|
+
* [Api set: WordApi 1.1]
|
|
97456
|
+
*/
|
|
97457
|
+
alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";
|
|
97458
|
+
/**
|
|
97459
|
+
* Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent.
|
|
97460
|
+
*
|
|
97461
|
+
* @remarks
|
|
97462
|
+
* [Api set: WordApi 1.1]
|
|
97459
97463
|
*/
|
|
97460
97464
|
firstLineIndent?: number;
|
|
97461
97465
|
/**
|
|
@@ -97529,11 +97533,11 @@ declare namespace Word {
|
|
|
97529
97533
|
*/
|
|
97530
97534
|
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";
|
|
97531
97535
|
}
|
|
97532
|
-
/** An interface for updating data on the ParagraphCollection object, for use in `paragraphCollection.set({ ... })`. */
|
|
97536
|
+
/** An interface for updating data on the `ParagraphCollection` object, for use in `paragraphCollection.set({ ... })`. */
|
|
97533
97537
|
interface ParagraphCollectionUpdateData {
|
|
97534
97538
|
items?: Word.Interfaces.ParagraphData[];
|
|
97535
97539
|
}
|
|
97536
|
-
/** An interface for updating data on the ParagraphFormat object, for use in `paragraphFormat.set({ ... })`. */
|
|
97540
|
+
/** An interface for updating data on the `ParagraphFormat` object, for use in `paragraphFormat.set({ ... })`. */
|
|
97537
97541
|
interface ParagraphFormatUpdateData {
|
|
97538
97542
|
/**
|
|
97539
97543
|
* Specifies the alignment for the specified paragraphs.
|
|
@@ -97634,14 +97638,14 @@ declare namespace Word {
|
|
|
97634
97638
|
*/
|
|
97635
97639
|
widowControl?: boolean;
|
|
97636
97640
|
}
|
|
97637
|
-
/** An interface for updating data on the Range object, for use in `range.set({ ... })`. */
|
|
97641
|
+
/** An interface for updating data on the `Range` object, for use in `range.set({ ... })`. */
|
|
97638
97642
|
interface RangeUpdateData {
|
|
97639
97643
|
/**
|
|
97640
|
-
|
|
97641
|
-
|
|
97642
|
-
|
|
97643
|
-
|
|
97644
|
-
|
|
97644
|
+
* Gets the text format of the range. Use this to get and set font name, size, color, and other properties.
|
|
97645
|
+
*
|
|
97646
|
+
* @remarks
|
|
97647
|
+
* [Api set: WordApi 1.1]
|
|
97648
|
+
*/
|
|
97645
97649
|
font?: Word.Interfaces.FontUpdateData;
|
|
97646
97650
|
/**
|
|
97647
97651
|
* Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part.
|
|
@@ -97665,11 +97669,11 @@ declare namespace Word {
|
|
|
97665
97669
|
*/
|
|
97666
97670
|
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";
|
|
97667
97671
|
}
|
|
97668
|
-
/** An interface for updating data on the RangeCollection object, for use in `rangeCollection.set({ ... })`. */
|
|
97672
|
+
/** An interface for updating data on the `RangeCollection` object, for use in `rangeCollection.set({ ... })`. */
|
|
97669
97673
|
interface RangeCollectionUpdateData {
|
|
97670
97674
|
items?: Word.Interfaces.RangeData[];
|
|
97671
97675
|
}
|
|
97672
|
-
/** An interface for updating data on the SearchOptions object, for use in `searchOptions.set({ ... })`. */
|
|
97676
|
+
/** An interface for updating data on the `SearchOptions` object, for use in `searchOptions.set({ ... })`. */
|
|
97673
97677
|
interface SearchOptionsUpdateData {
|
|
97674
97678
|
/**
|
|
97675
97679
|
* Specifies a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box.
|
|
@@ -97721,21 +97725,21 @@ declare namespace Word {
|
|
|
97721
97725
|
*/
|
|
97722
97726
|
matchWildcards?: boolean;
|
|
97723
97727
|
}
|
|
97724
|
-
/** An interface for updating data on the Section object, for use in `section.set({ ... })`. */
|
|
97728
|
+
/** An interface for updating data on the `Section` object, for use in `section.set({ ... })`. */
|
|
97725
97729
|
interface SectionUpdateData {
|
|
97726
97730
|
/**
|
|
97727
|
-
|
|
97728
|
-
|
|
97729
|
-
|
|
97730
|
-
|
|
97731
|
-
|
|
97731
|
+
* Gets the body object of the section. This doesn't include the header/footer and other section metadata.
|
|
97732
|
+
*
|
|
97733
|
+
* @remarks
|
|
97734
|
+
* [Api set: WordApi 1.1]
|
|
97735
|
+
*/
|
|
97732
97736
|
body?: Word.Interfaces.BodyUpdateData;
|
|
97733
97737
|
}
|
|
97734
|
-
/** An interface for updating data on the SectionCollection object, for use in `sectionCollection.set({ ... })`. */
|
|
97738
|
+
/** An interface for updating data on the `SectionCollection` object, for use in `sectionCollection.set({ ... })`. */
|
|
97735
97739
|
interface SectionCollectionUpdateData {
|
|
97736
97740
|
items?: Word.Interfaces.SectionData[];
|
|
97737
97741
|
}
|
|
97738
|
-
/** An interface for updating data on the Setting object, for use in `setting.set({ ... })`. */
|
|
97742
|
+
/** An interface for updating data on the `Setting` object, for use in `setting.set({ ... })`. */
|
|
97739
97743
|
interface SettingUpdateData {
|
|
97740
97744
|
/**
|
|
97741
97745
|
* Specifies the value of the setting.
|
|
@@ -97745,43 +97749,43 @@ declare namespace Word {
|
|
|
97745
97749
|
*/
|
|
97746
97750
|
value?: any;
|
|
97747
97751
|
}
|
|
97748
|
-
/** An interface for updating data on the SettingCollection object, for use in `settingCollection.set({ ... })`. */
|
|
97752
|
+
/** An interface for updating data on the `SettingCollection` object, for use in `settingCollection.set({ ... })`. */
|
|
97749
97753
|
interface SettingCollectionUpdateData {
|
|
97750
97754
|
items?: Word.Interfaces.SettingData[];
|
|
97751
97755
|
}
|
|
97752
|
-
/** An interface for updating data on the StyleCollection object, for use in `styleCollection.set({ ... })`. */
|
|
97756
|
+
/** An interface for updating data on the `StyleCollection` object, for use in `styleCollection.set({ ... })`. */
|
|
97753
97757
|
interface StyleCollectionUpdateData {
|
|
97754
97758
|
items?: Word.Interfaces.StyleData[];
|
|
97755
97759
|
}
|
|
97756
|
-
/** An interface for updating data on the Style object, for use in `style.set({ ... })`. */
|
|
97760
|
+
/** An interface for updating data on the `Style` object, for use in `style.set({ ... })`. */
|
|
97757
97761
|
interface StyleUpdateData {
|
|
97758
97762
|
/**
|
|
97759
|
-
|
|
97760
|
-
|
|
97761
|
-
|
|
97762
|
-
|
|
97763
|
-
|
|
97763
|
+
* Gets a font object that represents the character formatting of the specified style.
|
|
97764
|
+
*
|
|
97765
|
+
* @remarks
|
|
97766
|
+
* [Api set: WordApi 1.5]
|
|
97767
|
+
*/
|
|
97764
97768
|
font?: Word.Interfaces.FontUpdateData;
|
|
97765
97769
|
/**
|
|
97766
|
-
|
|
97767
|
-
|
|
97768
|
-
|
|
97769
|
-
|
|
97770
|
-
|
|
97770
|
+
* Gets a ParagraphFormat object that represents the paragraph settings for the specified style.
|
|
97771
|
+
*
|
|
97772
|
+
* @remarks
|
|
97773
|
+
* [Api set: WordApi 1.5]
|
|
97774
|
+
*/
|
|
97771
97775
|
paragraphFormat?: Word.Interfaces.ParagraphFormatUpdateData;
|
|
97772
97776
|
/**
|
|
97773
|
-
|
|
97774
|
-
|
|
97775
|
-
|
|
97776
|
-
|
|
97777
|
-
|
|
97777
|
+
* Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
|
|
97778
|
+
*
|
|
97779
|
+
* @remarks
|
|
97780
|
+
* [Api set: WordApi 1.6]
|
|
97781
|
+
*/
|
|
97778
97782
|
shading?: Word.Interfaces.ShadingUpdateData;
|
|
97779
97783
|
/**
|
|
97780
|
-
|
|
97781
|
-
|
|
97782
|
-
|
|
97783
|
-
|
|
97784
|
-
|
|
97784
|
+
* Gets a TableStyle object representing Style properties that can be applied to a table.
|
|
97785
|
+
*
|
|
97786
|
+
* @remarks
|
|
97787
|
+
* [Api set: WordApi 1.6]
|
|
97788
|
+
*/
|
|
97785
97789
|
tableStyle?: Word.Interfaces.TableStyleUpdateData;
|
|
97786
97790
|
/**
|
|
97787
97791
|
* Specifies the name of an existing style to use as the base formatting of another style.
|
|
@@ -97830,7 +97834,7 @@ declare namespace Word {
|
|
|
97830
97834
|
*/
|
|
97831
97835
|
visibility?: boolean;
|
|
97832
97836
|
}
|
|
97833
|
-
/** An interface for updating data on the Shading object, for use in `shading.set({ ... })`. */
|
|
97837
|
+
/** An interface for updating data on the `Shading` object, for use in `shading.set({ ... })`. */
|
|
97834
97838
|
interface ShadingUpdateData {
|
|
97835
97839
|
/**
|
|
97836
97840
|
* Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name.
|
|
@@ -97840,7 +97844,7 @@ declare namespace Word {
|
|
|
97840
97844
|
*/
|
|
97841
97845
|
backgroundPatternColor?: string;
|
|
97842
97846
|
}
|
|
97843
|
-
/** An interface for updating data on the Table object, for use in `table.set({ ... })`. */
|
|
97847
|
+
/** An interface for updating data on the `Table` object, for use in `table.set({ ... })`. */
|
|
97844
97848
|
interface TableUpdateData {
|
|
97845
97849
|
/**
|
|
97846
97850
|
* Gets the font. Use this to get and set font name, size, color, and other properties.
|
|
@@ -97948,7 +97952,7 @@ declare namespace Word {
|
|
|
97948
97952
|
*/
|
|
97949
97953
|
width?: number;
|
|
97950
97954
|
}
|
|
97951
|
-
/** An interface for updating data on the TableStyle object, for use in `tableStyle.set({ ... })`. */
|
|
97955
|
+
/** An interface for updating data on the `TableStyle` object, for use in `tableStyle.set({ ... })`. */
|
|
97952
97956
|
interface TableStyleUpdateData {
|
|
97953
97957
|
/**
|
|
97954
97958
|
* Specifies the amount of space to add between the contents and the bottom borders of the cells.
|
|
@@ -97986,18 +97990,18 @@ declare namespace Word {
|
|
|
97986
97990
|
*/
|
|
97987
97991
|
topCellMargin?: number;
|
|
97988
97992
|
}
|
|
97989
|
-
/** An interface for updating data on the TableCollection object, for use in `tableCollection.set({ ... })`. */
|
|
97993
|
+
/** An interface for updating data on the `TableCollection` object, for use in `tableCollection.set({ ... })`. */
|
|
97990
97994
|
interface TableCollectionUpdateData {
|
|
97991
97995
|
items?: Word.Interfaces.TableData[];
|
|
97992
97996
|
}
|
|
97993
|
-
/** An interface for updating data on the TableRow object, for use in `tableRow.set({ ... })`. */
|
|
97997
|
+
/** An interface for updating data on the `TableRow` object, for use in `tableRow.set({ ... })`. */
|
|
97994
97998
|
interface TableRowUpdateData {
|
|
97995
97999
|
/**
|
|
97996
|
-
|
|
97997
|
-
|
|
97998
|
-
|
|
97999
|
-
|
|
98000
|
-
|
|
98000
|
+
* Gets the font. Use this to get and set font name, size, color, and other properties.
|
|
98001
|
+
*
|
|
98002
|
+
* @remarks
|
|
98003
|
+
* [Api set: WordApi 1.3]
|
|
98004
|
+
*/
|
|
98001
98005
|
font?: Word.Interfaces.FontUpdateData;
|
|
98002
98006
|
/**
|
|
98003
98007
|
* Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'.
|
|
@@ -98035,18 +98039,18 @@ declare namespace Word {
|
|
|
98035
98039
|
*/
|
|
98036
98040
|
verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom";
|
|
98037
98041
|
}
|
|
98038
|
-
/** An interface for updating data on the TableRowCollection object, for use in `tableRowCollection.set({ ... })`. */
|
|
98042
|
+
/** An interface for updating data on the `TableRowCollection` object, for use in `tableRowCollection.set({ ... })`. */
|
|
98039
98043
|
interface TableRowCollectionUpdateData {
|
|
98040
98044
|
items?: Word.Interfaces.TableRowData[];
|
|
98041
98045
|
}
|
|
98042
|
-
/** An interface for updating data on the TableCell object, for use in `tableCell.set({ ... })`. */
|
|
98046
|
+
/** An interface for updating data on the `TableCell` object, for use in `tableCell.set({ ... })`. */
|
|
98043
98047
|
interface TableCellUpdateData {
|
|
98044
98048
|
/**
|
|
98045
|
-
|
|
98046
|
-
|
|
98047
|
-
|
|
98048
|
-
|
|
98049
|
-
|
|
98049
|
+
* Gets the body object of the cell.
|
|
98050
|
+
*
|
|
98051
|
+
* @remarks
|
|
98052
|
+
* [Api set: WordApi 1.3]
|
|
98053
|
+
*/
|
|
98050
98054
|
body?: Word.Interfaces.BodyUpdateData;
|
|
98051
98055
|
/**
|
|
98052
98056
|
* Specifies the width of the cell's column in points. This is applicable to uniform tables.
|
|
@@ -98084,11 +98088,11 @@ declare namespace Word {
|
|
|
98084
98088
|
*/
|
|
98085
98089
|
verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom";
|
|
98086
98090
|
}
|
|
98087
|
-
/** An interface for updating data on the TableCellCollection object, for use in `tableCellCollection.set({ ... })`. */
|
|
98091
|
+
/** An interface for updating data on the `TableCellCollection` object, for use in `tableCellCollection.set({ ... })`. */
|
|
98088
98092
|
interface TableCellCollectionUpdateData {
|
|
98089
98093
|
items?: Word.Interfaces.TableCellData[];
|
|
98090
98094
|
}
|
|
98091
|
-
/** An interface for updating data on the TableBorder object, for use in `tableBorder.set({ ... })`. */
|
|
98095
|
+
/** An interface for updating data on the `TableBorder` object, for use in `tableBorder.set({ ... })`. */
|
|
98092
98096
|
interface TableBorderUpdateData {
|
|
98093
98097
|
/**
|
|
98094
98098
|
* Specifies the table border color.
|
|
@@ -98112,7 +98116,7 @@ declare namespace Word {
|
|
|
98112
98116
|
*/
|
|
98113
98117
|
width?: number;
|
|
98114
98118
|
}
|
|
98115
|
-
/** An interface for updating data on the TrackedChangeCollection object, for use in `trackedChangeCollection.set({ ... })`. */
|
|
98119
|
+
/** An interface for updating data on the `TrackedChangeCollection` object, for use in `trackedChangeCollection.set({ ... })`. */
|
|
98116
98120
|
interface TrackedChangeCollectionUpdateData {
|
|
98117
98121
|
items?: Word.Interfaces.TrackedChangeData[];
|
|
98118
98122
|
}
|
|
@@ -100086,7 +100090,7 @@ declare namespace Word {
|
|
|
100086
100090
|
*/
|
|
100087
100091
|
interface CritiqueAnnotationLoadOptions {
|
|
100088
100092
|
/**
|
|
100089
|
-
Specifying `$all` for the
|
|
100093
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
100090
100094
|
*/
|
|
100091
100095
|
$all?: boolean;
|
|
100092
100096
|
/**
|
|
@@ -100112,15 +100116,15 @@ declare namespace Word {
|
|
|
100112
100116
|
*/
|
|
100113
100117
|
interface AnnotationLoadOptions {
|
|
100114
100118
|
/**
|
|
100115
|
-
Specifying `$all` for the
|
|
100119
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
100116
100120
|
*/
|
|
100117
100121
|
$all?: boolean;
|
|
100118
100122
|
/**
|
|
100119
|
-
|
|
100120
|
-
|
|
100121
|
-
|
|
100122
|
-
|
|
100123
|
-
|
|
100123
|
+
* Gets the critique annotation object.
|
|
100124
|
+
*
|
|
100125
|
+
* @remarks
|
|
100126
|
+
* [Api set: WordApi 1.7]
|
|
100127
|
+
*/
|
|
100124
100128
|
critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions;
|
|
100125
100129
|
/**
|
|
100126
100130
|
* Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects.
|
|
@@ -100145,15 +100149,15 @@ declare namespace Word {
|
|
|
100145
100149
|
*/
|
|
100146
100150
|
interface AnnotationCollectionLoadOptions {
|
|
100147
100151
|
/**
|
|
100148
|
-
Specifying `$all` for the
|
|
100152
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
100149
100153
|
*/
|
|
100150
100154
|
$all?: boolean;
|
|
100151
100155
|
/**
|
|
100152
|
-
|
|
100153
|
-
|
|
100154
|
-
|
|
100155
|
-
|
|
100156
|
-
|
|
100156
|
+
* For EACH ITEM in the collection: Gets the critique annotation object.
|
|
100157
|
+
*
|
|
100158
|
+
* @remarks
|
|
100159
|
+
* [Api set: WordApi 1.7]
|
|
100160
|
+
*/
|
|
100157
100161
|
critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions;
|
|
100158
100162
|
/**
|
|
100159
100163
|
* For EACH ITEM in the collection: Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects.
|
|
@@ -100178,57 +100182,57 @@ declare namespace Word {
|
|
|
100178
100182
|
*/
|
|
100179
100183
|
interface BodyLoadOptions {
|
|
100180
100184
|
/**
|
|
100181
|
-
Specifying `$all` for the
|
|
100185
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
100182
100186
|
*/
|
|
100183
100187
|
$all?: boolean;
|
|
100184
100188
|
/**
|
|
100185
|
-
|
|
100186
|
-
|
|
100187
|
-
|
|
100188
|
-
|
|
100189
|
-
|
|
100189
|
+
* Gets the text format of the body. Use this to get and set font name, size, color and other properties.
|
|
100190
|
+
*
|
|
100191
|
+
* @remarks
|
|
100192
|
+
* [Api set: WordApi 1.1]
|
|
100193
|
+
*/
|
|
100190
100194
|
font?: Word.Interfaces.FontLoadOptions;
|
|
100191
100195
|
/**
|
|
100192
|
-
|
|
100193
|
-
|
|
100194
|
-
|
|
100195
|
-
|
|
100196
|
-
|
|
100196
|
+
* Gets the parent body of the body. For example, a table cell body's parent body could be a header. Throws an `ItemNotFound` error if there isn't a parent body.
|
|
100197
|
+
*
|
|
100198
|
+
* @remarks
|
|
100199
|
+
* [Api set: WordApi 1.3]
|
|
100200
|
+
*/
|
|
100197
100201
|
parentBody?: Word.Interfaces.BodyLoadOptions;
|
|
100198
100202
|
/**
|
|
100199
|
-
|
|
100200
|
-
|
|
100201
|
-
|
|
100202
|
-
|
|
100203
|
-
|
|
100203
|
+
* Gets the parent body of the body. For example, a table cell body's parent body could be a header. If there isn't a parent body, 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}.
|
|
100204
|
+
*
|
|
100205
|
+
* @remarks
|
|
100206
|
+
* [Api set: WordApi 1.3]
|
|
100207
|
+
*/
|
|
100204
100208
|
parentBodyOrNullObject?: Word.Interfaces.BodyLoadOptions;
|
|
100205
100209
|
/**
|
|
100206
|
-
|
|
100207
|
-
|
|
100208
|
-
|
|
100209
|
-
|
|
100210
|
-
|
|
100210
|
+
* Gets the content control that contains the body. Throws an `ItemNotFound` error if there isn't a parent content control.
|
|
100211
|
+
*
|
|
100212
|
+
* @remarks
|
|
100213
|
+
* [Api set: WordApi 1.1]
|
|
100214
|
+
*/
|
|
100211
100215
|
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
|
|
100212
100216
|
/**
|
|
100213
|
-
|
|
100214
|
-
|
|
100215
|
-
|
|
100216
|
-
|
|
100217
|
-
|
|
100217
|
+
* Gets the content control that contains the body. 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}.
|
|
100218
|
+
*
|
|
100219
|
+
* @remarks
|
|
100220
|
+
* [Api set: WordApi 1.3]
|
|
100221
|
+
*/
|
|
100218
100222
|
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
|
|
100219
100223
|
/**
|
|
100220
|
-
|
|
100221
|
-
|
|
100222
|
-
|
|
100223
|
-
|
|
100224
|
-
|
|
100224
|
+
* Gets the parent section of the body. Throws an `ItemNotFound` error if there isn't a parent section.
|
|
100225
|
+
*
|
|
100226
|
+
* @remarks
|
|
100227
|
+
* [Api set: WordApi 1.3]
|
|
100228
|
+
*/
|
|
100225
100229
|
parentSection?: Word.Interfaces.SectionLoadOptions;
|
|
100226
100230
|
/**
|
|
100227
|
-
|
|
100228
|
-
|
|
100229
|
-
|
|
100230
|
-
|
|
100231
|
-
|
|
100231
|
+
* Gets the parent section of the body. If there isn't a parent section, 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}.
|
|
100232
|
+
*
|
|
100233
|
+
* @remarks
|
|
100234
|
+
* [Api set: WordApi 1.3]
|
|
100235
|
+
*/
|
|
100232
100236
|
parentSectionOrNullObject?: Word.Interfaces.SectionLoadOptions;
|
|
100233
100237
|
/**
|
|
100234
100238
|
* 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.
|
|
@@ -100267,7 +100271,7 @@ declare namespace Word {
|
|
|
100267
100271
|
*/
|
|
100268
100272
|
interface CheckboxContentControlLoadOptions {
|
|
100269
100273
|
/**
|
|
100270
|
-
Specifying `$all` for the
|
|
100274
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
100271
100275
|
*/
|
|
100272
100276
|
$all?: boolean;
|
|
100273
100277
|
/**
|
|
@@ -100286,15 +100290,15 @@ declare namespace Word {
|
|
|
100286
100290
|
*/
|
|
100287
100291
|
interface CommentLoadOptions {
|
|
100288
100292
|
/**
|
|
100289
|
-
Specifying `$all` for the
|
|
100293
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
100290
100294
|
*/
|
|
100291
100295
|
$all?: boolean;
|
|
100292
100296
|
/**
|
|
100293
|
-
|
|
100294
|
-
|
|
100295
|
-
|
|
100296
|
-
|
|
100297
|
-
|
|
100297
|
+
* Specifies the comment's content range.
|
|
100298
|
+
*
|
|
100299
|
+
* @remarks
|
|
100300
|
+
* [Api set: WordApi 1.4]
|
|
100301
|
+
*/
|
|
100298
100302
|
contentRange?: Word.Interfaces.CommentContentRangeLoadOptions;
|
|
100299
100303
|
/**
|
|
100300
100304
|
* Gets the email of the comment's author.
|
|
@@ -100347,15 +100351,15 @@ declare namespace Word {
|
|
|
100347
100351
|
*/
|
|
100348
100352
|
interface CommentCollectionLoadOptions {
|
|
100349
100353
|
/**
|
|
100350
|
-
Specifying `$all` for the
|
|
100354
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
100351
100355
|
*/
|
|
100352
100356
|
$all?: boolean;
|
|
100353
100357
|
/**
|
|
100354
|
-
|
|
100355
|
-
|
|
100356
|
-
|
|
100357
|
-
|
|
100358
|
-
|
|
100358
|
+
* For EACH ITEM in the collection: Specifies the comment's content range.
|
|
100359
|
+
*
|
|
100360
|
+
* @remarks
|
|
100361
|
+
* [Api set: WordApi 1.4]
|
|
100362
|
+
*/
|
|
100359
100363
|
contentRange?: Word.Interfaces.CommentContentRangeLoadOptions;
|
|
100360
100364
|
/**
|
|
100361
100365
|
* For EACH ITEM in the collection: Gets the email of the comment's author.
|
|
@@ -100406,7 +100410,7 @@ declare namespace Word {
|
|
|
100406
100410
|
*/
|
|
100407
100411
|
interface CommentContentRangeLoadOptions {
|
|
100408
100412
|
/**
|
|
100409
|
-
Specifying `$all` for the
|
|
100413
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
100410
100414
|
*/
|
|
100411
100415
|
$all?: boolean;
|
|
100412
100416
|
/**
|
|
@@ -100467,7 +100471,7 @@ declare namespace Word {
|
|
|
100467
100471
|
*/
|
|
100468
100472
|
interface CommentReplyLoadOptions {
|
|
100469
100473
|
/**
|
|
100470
|
-
Specifying `$all` for the
|
|
100474
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
100471
100475
|
*/
|
|
100472
100476
|
$all?: boolean;
|
|
100473
100477
|
/**
|
|
@@ -100528,7 +100532,7 @@ declare namespace Word {
|
|
|
100528
100532
|
*/
|
|
100529
100533
|
interface CommentReplyCollectionLoadOptions {
|
|
100530
100534
|
/**
|
|
100531
|
-
Specifying `$all` for the
|
|
100535
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
100532
100536
|
*/
|
|
100533
100537
|
$all?: boolean;
|
|
100534
100538
|
/**
|
|
@@ -100589,7 +100593,7 @@ declare namespace Word {
|
|
|
100589
100593
|
*/
|
|
100590
100594
|
interface ContentControlLoadOptions {
|
|
100591
100595
|
/**
|
|
100592
|
-
Specifying `$all` for the
|
|
100596
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
100593
100597
|
*/
|
|
100594
100598
|
$all?: boolean;
|
|
100595
100599
|
/**
|
|
@@ -100764,7 +100768,7 @@ declare namespace Word {
|
|
|
100764
100768
|
*/
|
|
100765
100769
|
interface ContentControlCollectionLoadOptions {
|
|
100766
100770
|
/**
|
|
100767
|
-
Specifying `$all` for the
|
|
100771
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
100768
100772
|
*/
|
|
100769
100773
|
$all?: boolean;
|
|
100770
100774
|
/**
|
|
@@ -100939,7 +100943,7 @@ declare namespace Word {
|
|
|
100939
100943
|
*/
|
|
100940
100944
|
interface CustomPropertyLoadOptions {
|
|
100941
100945
|
/**
|
|
100942
|
-
Specifying `$all` for the
|
|
100946
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
100943
100947
|
*/
|
|
100944
100948
|
$all?: boolean;
|
|
100945
100949
|
/**
|
|
@@ -100972,7 +100976,7 @@ declare namespace Word {
|
|
|
100972
100976
|
*/
|
|
100973
100977
|
interface CustomPropertyCollectionLoadOptions {
|
|
100974
100978
|
/**
|
|
100975
|
-
Specifying `$all` for the
|
|
100979
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
100976
100980
|
*/
|
|
100977
100981
|
$all?: boolean;
|
|
100978
100982
|
/**
|
|
@@ -101005,7 +101009,7 @@ declare namespace Word {
|
|
|
101005
101009
|
*/
|
|
101006
101010
|
interface CustomXmlPartLoadOptions {
|
|
101007
101011
|
/**
|
|
101008
|
-
Specifying `$all` for the
|
|
101012
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
101009
101013
|
*/
|
|
101010
101014
|
$all?: boolean;
|
|
101011
101015
|
/**
|
|
@@ -101031,7 +101035,7 @@ declare namespace Word {
|
|
|
101031
101035
|
*/
|
|
101032
101036
|
interface CustomXmlPartCollectionLoadOptions {
|
|
101033
101037
|
/**
|
|
101034
|
-
Specifying `$all` for the
|
|
101038
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
101035
101039
|
*/
|
|
101036
101040
|
$all?: boolean;
|
|
101037
101041
|
/**
|
|
@@ -101057,7 +101061,7 @@ declare namespace Word {
|
|
|
101057
101061
|
*/
|
|
101058
101062
|
interface CustomXmlPartScopedCollectionLoadOptions {
|
|
101059
101063
|
/**
|
|
101060
|
-
Specifying `$all` for the
|
|
101064
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
101061
101065
|
*/
|
|
101062
101066
|
$all?: boolean;
|
|
101063
101067
|
/**
|
|
@@ -101083,22 +101087,22 @@ declare namespace Word {
|
|
|
101083
101087
|
*/
|
|
101084
101088
|
interface DocumentLoadOptions {
|
|
101085
101089
|
/**
|
|
101086
|
-
Specifying `$all` for the
|
|
101090
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
101087
101091
|
*/
|
|
101088
101092
|
$all?: boolean;
|
|
101089
101093
|
/**
|
|
101090
|
-
|
|
101091
|
-
|
|
101092
|
-
|
|
101093
|
-
|
|
101094
|
-
|
|
101094
|
+
* Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc.
|
|
101095
|
+
*
|
|
101096
|
+
* @remarks
|
|
101097
|
+
* [Api set: WordApi 1.1]
|
|
101098
|
+
*/
|
|
101095
101099
|
body?: Word.Interfaces.BodyLoadOptions;
|
|
101096
101100
|
/**
|
|
101097
|
-
|
|
101098
|
-
|
|
101099
|
-
|
|
101100
|
-
|
|
101101
|
-
|
|
101101
|
+
* Gets the properties of the document.
|
|
101102
|
+
*
|
|
101103
|
+
* @remarks
|
|
101104
|
+
* [Api set: WordApi 1.3]
|
|
101105
|
+
*/
|
|
101102
101106
|
properties?: Word.Interfaces.DocumentPropertiesLoadOptions;
|
|
101103
101107
|
/**
|
|
101104
101108
|
* Specifies the ChangeTracking mode.
|
|
@@ -101123,22 +101127,22 @@ declare namespace Word {
|
|
|
101123
101127
|
*/
|
|
101124
101128
|
interface DocumentCreatedLoadOptions {
|
|
101125
101129
|
/**
|
|
101126
|
-
Specifying `$all` for the
|
|
101130
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
101127
101131
|
*/
|
|
101128
101132
|
$all?: boolean;
|
|
101129
101133
|
/**
|
|
101130
|
-
|
|
101131
|
-
|
|
101132
|
-
|
|
101133
|
-
|
|
101134
|
-
|
|
101134
|
+
* Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc.
|
|
101135
|
+
*
|
|
101136
|
+
* @remarks
|
|
101137
|
+
* [Api set: WordApiHiddenDocument 1.3]
|
|
101138
|
+
*/
|
|
101135
101139
|
body?: Word.Interfaces.BodyLoadOptions;
|
|
101136
101140
|
/**
|
|
101137
|
-
|
|
101138
|
-
|
|
101139
|
-
|
|
101140
|
-
|
|
101141
|
-
|
|
101141
|
+
* Gets the properties of the document.
|
|
101142
|
+
*
|
|
101143
|
+
* @remarks
|
|
101144
|
+
* [Api set: WordApiHiddenDocument 1.3]
|
|
101145
|
+
*/
|
|
101142
101146
|
properties?: Word.Interfaces.DocumentPropertiesLoadOptions;
|
|
101143
101147
|
/**
|
|
101144
101148
|
* Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved.
|
|
@@ -101156,7 +101160,7 @@ declare namespace Word {
|
|
|
101156
101160
|
*/
|
|
101157
101161
|
interface DocumentPropertiesLoadOptions {
|
|
101158
101162
|
/**
|
|
101159
|
-
Specifying `$all` for the
|
|
101163
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
101160
101164
|
*/
|
|
101161
101165
|
$all?: boolean;
|
|
101162
101166
|
/**
|
|
@@ -101287,64 +101291,64 @@ declare namespace Word {
|
|
|
101287
101291
|
*/
|
|
101288
101292
|
interface FieldLoadOptions {
|
|
101289
101293
|
/**
|
|
101290
|
-
Specifying `$all` for the
|
|
101294
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
101291
101295
|
*/
|
|
101292
101296
|
$all?: boolean;
|
|
101293
101297
|
/**
|
|
101294
|
-
|
|
101295
|
-
|
|
101296
|
-
|
|
101297
|
-
|
|
101298
|
-
|
|
101298
|
+
* Gets the parent body of the field.
|
|
101299
|
+
*
|
|
101300
|
+
* @remarks
|
|
101301
|
+
* [Api set: WordApi 1.4]
|
|
101302
|
+
*/
|
|
101299
101303
|
parentBody?: Word.Interfaces.BodyLoadOptions;
|
|
101300
101304
|
/**
|
|
101301
|
-
|
|
101302
|
-
|
|
101303
|
-
|
|
101304
|
-
|
|
101305
|
-
|
|
101305
|
+
* Gets the content control that contains the field. Throws an `ItemNotFound` error if there isn't a parent content control.
|
|
101306
|
+
*
|
|
101307
|
+
* @remarks
|
|
101308
|
+
* [Api set: WordApi 1.4]
|
|
101309
|
+
*/
|
|
101306
101310
|
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
|
|
101307
101311
|
/**
|
|
101308
|
-
|
|
101309
|
-
|
|
101310
|
-
|
|
101311
|
-
|
|
101312
|
-
|
|
101312
|
+
* Gets the content control that contains the field. 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}.
|
|
101313
|
+
*
|
|
101314
|
+
* @remarks
|
|
101315
|
+
* [Api set: WordApi 1.4]
|
|
101316
|
+
*/
|
|
101313
101317
|
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
|
|
101314
101318
|
/**
|
|
101315
|
-
|
|
101316
|
-
|
|
101317
|
-
|
|
101318
|
-
|
|
101319
|
-
|
|
101319
|
+
* Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table.
|
|
101320
|
+
*
|
|
101321
|
+
* @remarks
|
|
101322
|
+
* [Api set: WordApi 1.4]
|
|
101323
|
+
*/
|
|
101320
101324
|
parentTable?: Word.Interfaces.TableLoadOptions;
|
|
101321
101325
|
/**
|
|
101322
|
-
|
|
101323
|
-
|
|
101324
|
-
|
|
101325
|
-
|
|
101326
|
-
|
|
101326
|
+
* Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell.
|
|
101327
|
+
*
|
|
101328
|
+
* @remarks
|
|
101329
|
+
* [Api set: WordApi 1.4]
|
|
101330
|
+
*/
|
|
101327
101331
|
parentTableCell?: Word.Interfaces.TableCellLoadOptions;
|
|
101328
101332
|
/**
|
|
101329
|
-
|
|
101330
|
-
|
|
101331
|
-
|
|
101332
|
-
|
|
101333
|
-
|
|
101333
|
+
* Gets the table cell that contains the field. 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}.
|
|
101334
|
+
*
|
|
101335
|
+
* @remarks
|
|
101336
|
+
* [Api set: WordApi 1.4]
|
|
101337
|
+
*/
|
|
101334
101338
|
parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
|
|
101335
101339
|
/**
|
|
101336
|
-
|
|
101337
|
-
|
|
101338
|
-
|
|
101339
|
-
|
|
101340
|
-
|
|
101340
|
+
* Gets the table that contains the field. 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}.
|
|
101341
|
+
*
|
|
101342
|
+
* @remarks
|
|
101343
|
+
* [Api set: WordApi 1.4]
|
|
101344
|
+
*/
|
|
101341
101345
|
parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
|
|
101342
101346
|
/**
|
|
101343
|
-
|
|
101344
|
-
|
|
101345
|
-
|
|
101346
|
-
|
|
101347
|
-
|
|
101347
|
+
* Gets the field's result data.
|
|
101348
|
+
*
|
|
101349
|
+
* @remarks
|
|
101350
|
+
* [Api set: WordApi 1.4]
|
|
101351
|
+
*/
|
|
101348
101352
|
result?: Word.Interfaces.RangeLoadOptions;
|
|
101349
101353
|
/**
|
|
101350
101354
|
* Specifies the field's code instruction.
|
|
@@ -101392,64 +101396,64 @@ declare namespace Word {
|
|
|
101392
101396
|
*/
|
|
101393
101397
|
interface FieldCollectionLoadOptions {
|
|
101394
101398
|
/**
|
|
101395
|
-
Specifying `$all` for the
|
|
101399
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
101396
101400
|
*/
|
|
101397
101401
|
$all?: boolean;
|
|
101398
101402
|
/**
|
|
101399
|
-
|
|
101400
|
-
|
|
101401
|
-
|
|
101402
|
-
|
|
101403
|
-
|
|
101403
|
+
* For EACH ITEM in the collection: Gets the parent body of the field.
|
|
101404
|
+
*
|
|
101405
|
+
* @remarks
|
|
101406
|
+
* [Api set: WordApi 1.4]
|
|
101407
|
+
*/
|
|
101404
101408
|
parentBody?: Word.Interfaces.BodyLoadOptions;
|
|
101405
101409
|
/**
|
|
101406
|
-
|
|
101407
|
-
|
|
101408
|
-
|
|
101409
|
-
|
|
101410
|
-
|
|
101410
|
+
* For EACH ITEM in the collection: Gets the content control that contains the field. Throws an `ItemNotFound` error if there isn't a parent content control.
|
|
101411
|
+
*
|
|
101412
|
+
* @remarks
|
|
101413
|
+
* [Api set: WordApi 1.4]
|
|
101414
|
+
*/
|
|
101411
101415
|
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
|
|
101412
101416
|
/**
|
|
101413
|
-
|
|
101414
|
-
|
|
101415
|
-
|
|
101416
|
-
|
|
101417
|
-
|
|
101417
|
+
* For EACH ITEM in the collection: Gets the content control that contains the field. 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}.
|
|
101418
|
+
*
|
|
101419
|
+
* @remarks
|
|
101420
|
+
* [Api set: WordApi 1.4]
|
|
101421
|
+
*/
|
|
101418
101422
|
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
|
|
101419
101423
|
/**
|
|
101420
|
-
|
|
101421
|
-
|
|
101422
|
-
|
|
101423
|
-
|
|
101424
|
-
|
|
101424
|
+
* 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.
|
|
101425
|
+
*
|
|
101426
|
+
* @remarks
|
|
101427
|
+
* [Api set: WordApi 1.4]
|
|
101428
|
+
*/
|
|
101425
101429
|
parentTable?: Word.Interfaces.TableLoadOptions;
|
|
101426
101430
|
/**
|
|
101427
|
-
|
|
101428
|
-
|
|
101429
|
-
|
|
101430
|
-
|
|
101431
|
-
|
|
101431
|
+
* 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.
|
|
101432
|
+
*
|
|
101433
|
+
* @remarks
|
|
101434
|
+
* [Api set: WordApi 1.4]
|
|
101435
|
+
*/
|
|
101432
101436
|
parentTableCell?: Word.Interfaces.TableCellLoadOptions;
|
|
101433
101437
|
/**
|
|
101434
|
-
|
|
101435
|
-
|
|
101436
|
-
|
|
101437
|
-
|
|
101438
|
-
|
|
101438
|
+
* For EACH ITEM in the collection: Gets the table cell that contains the field. 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}.
|
|
101439
|
+
*
|
|
101440
|
+
* @remarks
|
|
101441
|
+
* [Api set: WordApi 1.4]
|
|
101442
|
+
*/
|
|
101439
101443
|
parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
|
|
101440
101444
|
/**
|
|
101441
|
-
|
|
101442
|
-
|
|
101443
|
-
|
|
101444
|
-
|
|
101445
|
-
|
|
101445
|
+
* For EACH ITEM in the collection: Gets the table that contains the field. 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}.
|
|
101446
|
+
*
|
|
101447
|
+
* @remarks
|
|
101448
|
+
* [Api set: WordApi 1.4]
|
|
101449
|
+
*/
|
|
101446
101450
|
parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
|
|
101447
101451
|
/**
|
|
101448
|
-
|
|
101449
|
-
|
|
101450
|
-
|
|
101451
|
-
|
|
101452
|
-
|
|
101452
|
+
* For EACH ITEM in the collection: Gets the field's result data.
|
|
101453
|
+
*
|
|
101454
|
+
* @remarks
|
|
101455
|
+
* [Api set: WordApi 1.4]
|
|
101456
|
+
*/
|
|
101453
101457
|
result?: Word.Interfaces.RangeLoadOptions;
|
|
101454
101458
|
/**
|
|
101455
101459
|
* For EACH ITEM in the collection: Specifies the field's code instruction.
|
|
@@ -101497,7 +101501,7 @@ declare namespace Word {
|
|
|
101497
101501
|
*/
|
|
101498
101502
|
interface FontLoadOptions {
|
|
101499
101503
|
/**
|
|
101500
|
-
Specifying `$all` for the
|
|
101504
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
101501
101505
|
*/
|
|
101502
101506
|
$all?: boolean;
|
|
101503
101507
|
/**
|
|
@@ -101586,7 +101590,7 @@ declare namespace Word {
|
|
|
101586
101590
|
*/
|
|
101587
101591
|
interface InlinePictureLoadOptions {
|
|
101588
101592
|
/**
|
|
101589
|
-
Specifying `$all` for the
|
|
101593
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
101590
101594
|
*/
|
|
101591
101595
|
$all?: boolean;
|
|
101592
101596
|
/**
|
|
@@ -101689,7 +101693,7 @@ declare namespace Word {
|
|
|
101689
101693
|
*/
|
|
101690
101694
|
interface InlinePictureCollectionLoadOptions {
|
|
101691
101695
|
/**
|
|
101692
|
-
Specifying `$all` for the
|
|
101696
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
101693
101697
|
*/
|
|
101694
101698
|
$all?: boolean;
|
|
101695
101699
|
/**
|
|
@@ -101792,7 +101796,7 @@ declare namespace Word {
|
|
|
101792
101796
|
*/
|
|
101793
101797
|
interface ListLoadOptions {
|
|
101794
101798
|
/**
|
|
101795
|
-
Specifying `$all` for the
|
|
101799
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
101796
101800
|
*/
|
|
101797
101801
|
$all?: boolean;
|
|
101798
101802
|
/**
|
|
@@ -101825,7 +101829,7 @@ declare namespace Word {
|
|
|
101825
101829
|
*/
|
|
101826
101830
|
interface ListCollectionLoadOptions {
|
|
101827
101831
|
/**
|
|
101828
|
-
Specifying `$all` for the
|
|
101832
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
101829
101833
|
*/
|
|
101830
101834
|
$all?: boolean;
|
|
101831
101835
|
/**
|
|
@@ -101858,7 +101862,7 @@ declare namespace Word {
|
|
|
101858
101862
|
*/
|
|
101859
101863
|
interface ListItemLoadOptions {
|
|
101860
101864
|
/**
|
|
101861
|
-
Specifying `$all` for the
|
|
101865
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
101862
101866
|
*/
|
|
101863
101867
|
$all?: boolean;
|
|
101864
101868
|
/**
|
|
@@ -101891,22 +101895,22 @@ declare namespace Word {
|
|
|
101891
101895
|
*/
|
|
101892
101896
|
interface NoteItemLoadOptions {
|
|
101893
101897
|
/**
|
|
101894
|
-
Specifying `$all` for the
|
|
101898
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
101895
101899
|
*/
|
|
101896
101900
|
$all?: boolean;
|
|
101897
101901
|
/**
|
|
101898
|
-
|
|
101899
|
-
|
|
101900
|
-
|
|
101901
|
-
|
|
101902
|
-
|
|
101902
|
+
* Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
|
|
101903
|
+
*
|
|
101904
|
+
* @remarks
|
|
101905
|
+
* [Api set: WordApi 1.5]
|
|
101906
|
+
*/
|
|
101903
101907
|
body?: Word.Interfaces.BodyLoadOptions;
|
|
101904
101908
|
/**
|
|
101905
|
-
|
|
101906
|
-
|
|
101907
|
-
|
|
101908
|
-
|
|
101909
|
-
|
|
101909
|
+
* Represents a footnote or endnote reference in the main document.
|
|
101910
|
+
*
|
|
101911
|
+
* @remarks
|
|
101912
|
+
* [Api set: WordApi 1.5]
|
|
101913
|
+
*/
|
|
101910
101914
|
reference?: Word.Interfaces.RangeLoadOptions;
|
|
101911
101915
|
/**
|
|
101912
101916
|
* Represents the note item type: footnote or endnote.
|
|
@@ -101924,7 +101928,7 @@ declare namespace Word {
|
|
|
101924
101928
|
*/
|
|
101925
101929
|
interface NoteItemCollectionLoadOptions {
|
|
101926
101930
|
/**
|
|
101927
|
-
Specifying `$all` for the
|
|
101931
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
101928
101932
|
*/
|
|
101929
101933
|
$all?: boolean;
|
|
101930
101934
|
/**
|
|
@@ -101957,7 +101961,7 @@ declare namespace Word {
|
|
|
101957
101961
|
*/
|
|
101958
101962
|
interface ParagraphLoadOptions {
|
|
101959
101963
|
/**
|
|
101960
|
-
Specifying `$all` for the
|
|
101964
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
101961
101965
|
*/
|
|
101962
101966
|
$all?: boolean;
|
|
101963
101967
|
/**
|
|
@@ -102172,92 +102176,92 @@ declare namespace Word {
|
|
|
102172
102176
|
*/
|
|
102173
102177
|
interface ParagraphCollectionLoadOptions {
|
|
102174
102178
|
/**
|
|
102175
|
-
Specifying `$all` for the
|
|
102179
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
102176
102180
|
*/
|
|
102177
102181
|
$all?: boolean;
|
|
102178
102182
|
/**
|
|
102179
|
-
|
|
102180
|
-
|
|
102181
|
-
|
|
102182
|
-
|
|
102183
|
-
|
|
102183
|
+
* For EACH ITEM in the collection: Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties.
|
|
102184
|
+
*
|
|
102185
|
+
* @remarks
|
|
102186
|
+
* [Api set: WordApi 1.1]
|
|
102187
|
+
*/
|
|
102184
102188
|
font?: Word.Interfaces.FontLoadOptions;
|
|
102185
102189
|
/**
|
|
102186
|
-
|
|
102187
|
-
|
|
102188
|
-
|
|
102189
|
-
|
|
102190
|
-
|
|
102190
|
+
* 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.
|
|
102191
|
+
*
|
|
102192
|
+
* @remarks
|
|
102193
|
+
* [Api set: WordApi 1.3]
|
|
102194
|
+
*/
|
|
102191
102195
|
list?: Word.Interfaces.ListLoadOptions;
|
|
102192
102196
|
/**
|
|
102193
|
-
|
|
102194
|
-
|
|
102195
|
-
|
|
102196
|
-
|
|
102197
|
-
|
|
102197
|
+
* 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.
|
|
102198
|
+
*
|
|
102199
|
+
* @remarks
|
|
102200
|
+
* [Api set: WordApi 1.3]
|
|
102201
|
+
*/
|
|
102198
102202
|
listItem?: Word.Interfaces.ListItemLoadOptions;
|
|
102199
102203
|
/**
|
|
102200
|
-
|
|
102201
|
-
|
|
102202
|
-
|
|
102203
|
-
|
|
102204
|
-
|
|
102204
|
+
* For EACH ITEM in the collection: 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}.
|
|
102205
|
+
*
|
|
102206
|
+
* @remarks
|
|
102207
|
+
* [Api set: WordApi 1.3]
|
|
102208
|
+
*/
|
|
102205
102209
|
listItemOrNullObject?: Word.Interfaces.ListItemLoadOptions;
|
|
102206
102210
|
/**
|
|
102207
|
-
|
|
102208
|
-
|
|
102209
|
-
|
|
102210
|
-
|
|
102211
|
-
|
|
102211
|
+
* For EACH ITEM in the collection: 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}.
|
|
102212
|
+
*
|
|
102213
|
+
* @remarks
|
|
102214
|
+
* [Api set: WordApi 1.3]
|
|
102215
|
+
*/
|
|
102212
102216
|
listOrNullObject?: Word.Interfaces.ListLoadOptions;
|
|
102213
102217
|
/**
|
|
102214
|
-
|
|
102215
|
-
|
|
102216
|
-
|
|
102217
|
-
|
|
102218
|
-
|
|
102218
|
+
* For EACH ITEM in the collection: Gets the parent body of the paragraph.
|
|
102219
|
+
*
|
|
102220
|
+
* @remarks
|
|
102221
|
+
* [Api set: WordApi 1.3]
|
|
102222
|
+
*/
|
|
102219
102223
|
parentBody?: Word.Interfaces.BodyLoadOptions;
|
|
102220
102224
|
/**
|
|
102221
|
-
|
|
102222
|
-
|
|
102223
|
-
|
|
102224
|
-
|
|
102225
|
-
|
|
102225
|
+
* For EACH ITEM in the collection: Gets the content control that contains the paragraph. Throws an `ItemNotFound` error if there isn't a parent content control.
|
|
102226
|
+
*
|
|
102227
|
+
* @remarks
|
|
102228
|
+
* [Api set: WordApi 1.1]
|
|
102229
|
+
*/
|
|
102226
102230
|
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
|
|
102227
102231
|
/**
|
|
102228
|
-
|
|
102229
|
-
|
|
102230
|
-
|
|
102231
|
-
|
|
102232
|
-
|
|
102232
|
+
* For EACH ITEM in the collection: 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}.
|
|
102233
|
+
*
|
|
102234
|
+
* @remarks
|
|
102235
|
+
* [Api set: WordApi 1.3]
|
|
102236
|
+
*/
|
|
102233
102237
|
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
|
|
102234
102238
|
/**
|
|
102235
|
-
|
|
102236
|
-
|
|
102237
|
-
|
|
102238
|
-
|
|
102239
|
-
|
|
102239
|
+
* 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.
|
|
102240
|
+
*
|
|
102241
|
+
* @remarks
|
|
102242
|
+
* [Api set: WordApi 1.3]
|
|
102243
|
+
*/
|
|
102240
102244
|
parentTable?: Word.Interfaces.TableLoadOptions;
|
|
102241
102245
|
/**
|
|
102242
|
-
|
|
102243
|
-
|
|
102244
|
-
|
|
102245
|
-
|
|
102246
|
-
|
|
102246
|
+
* 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.
|
|
102247
|
+
*
|
|
102248
|
+
* @remarks
|
|
102249
|
+
* [Api set: WordApi 1.3]
|
|
102250
|
+
*/
|
|
102247
102251
|
parentTableCell?: Word.Interfaces.TableCellLoadOptions;
|
|
102248
102252
|
/**
|
|
102249
|
-
|
|
102250
|
-
|
|
102251
|
-
|
|
102252
|
-
|
|
102253
|
-
|
|
102253
|
+
* For EACH ITEM in the collection: 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}.
|
|
102254
|
+
*
|
|
102255
|
+
* @remarks
|
|
102256
|
+
* [Api set: WordApi 1.3]
|
|
102257
|
+
*/
|
|
102254
102258
|
parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
|
|
102255
102259
|
/**
|
|
102256
|
-
|
|
102257
|
-
|
|
102258
|
-
|
|
102259
|
-
|
|
102260
|
-
|
|
102260
|
+
* For EACH ITEM in the collection: 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}.
|
|
102261
|
+
*
|
|
102262
|
+
* @remarks
|
|
102263
|
+
* [Api set: WordApi 1.3]
|
|
102264
|
+
*/
|
|
102261
102265
|
parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
|
|
102262
102266
|
/**
|
|
102263
102267
|
* For EACH ITEM in the collection: Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'.
|
|
@@ -102387,7 +102391,7 @@ declare namespace Word {
|
|
|
102387
102391
|
*/
|
|
102388
102392
|
interface ParagraphFormatLoadOptions {
|
|
102389
102393
|
/**
|
|
102390
|
-
Specifying `$all` for the
|
|
102394
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
102391
102395
|
*/
|
|
102392
102396
|
$all?: boolean;
|
|
102393
102397
|
/**
|
|
@@ -102497,7 +102501,7 @@ declare namespace Word {
|
|
|
102497
102501
|
*/
|
|
102498
102502
|
interface RangeLoadOptions {
|
|
102499
102503
|
/**
|
|
102500
|
-
Specifying `$all` for the
|
|
102504
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
102501
102505
|
*/
|
|
102502
102506
|
$all?: boolean;
|
|
102503
102507
|
/**
|
|
@@ -102600,7 +102604,7 @@ declare namespace Word {
|
|
|
102600
102604
|
*/
|
|
102601
102605
|
interface RangeCollectionLoadOptions {
|
|
102602
102606
|
/**
|
|
102603
|
-
Specifying `$all` for the
|
|
102607
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
102604
102608
|
*/
|
|
102605
102609
|
$all?: boolean;
|
|
102606
102610
|
/**
|
|
@@ -102704,7 +102708,7 @@ declare namespace Word {
|
|
|
102704
102708
|
*/
|
|
102705
102709
|
interface SearchOptionsLoadOptions {
|
|
102706
102710
|
/**
|
|
102707
|
-
Specifying `$all` for the
|
|
102711
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
102708
102712
|
*/
|
|
102709
102713
|
$all?: boolean;
|
|
102710
102714
|
/**
|
|
@@ -102765,7 +102769,7 @@ declare namespace Word {
|
|
|
102765
102769
|
*/
|
|
102766
102770
|
interface SectionLoadOptions {
|
|
102767
102771
|
/**
|
|
102768
|
-
Specifying `$all` for the
|
|
102772
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
102769
102773
|
*/
|
|
102770
102774
|
$all?: boolean;
|
|
102771
102775
|
/**
|
|
@@ -102784,15 +102788,15 @@ declare namespace Word {
|
|
|
102784
102788
|
*/
|
|
102785
102789
|
interface SectionCollectionLoadOptions {
|
|
102786
102790
|
/**
|
|
102787
|
-
Specifying `$all` for the
|
|
102791
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
102788
102792
|
*/
|
|
102789
102793
|
$all?: boolean;
|
|
102790
102794
|
/**
|
|
102791
|
-
|
|
102792
|
-
|
|
102793
|
-
|
|
102794
|
-
|
|
102795
|
-
|
|
102795
|
+
* For EACH ITEM in the collection: Gets the body object of the section. This doesn't include the header/footer and other section metadata.
|
|
102796
|
+
*
|
|
102797
|
+
* @remarks
|
|
102798
|
+
* [Api set: WordApi 1.1]
|
|
102799
|
+
*/
|
|
102796
102800
|
body?: Word.Interfaces.BodyLoadOptions;
|
|
102797
102801
|
}
|
|
102798
102802
|
/**
|
|
@@ -102803,7 +102807,7 @@ declare namespace Word {
|
|
|
102803
102807
|
*/
|
|
102804
102808
|
interface SettingLoadOptions {
|
|
102805
102809
|
/**
|
|
102806
|
-
Specifying `$all` for the
|
|
102810
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
102807
102811
|
*/
|
|
102808
102812
|
$all?: boolean;
|
|
102809
102813
|
/**
|
|
@@ -102829,7 +102833,7 @@ declare namespace Word {
|
|
|
102829
102833
|
*/
|
|
102830
102834
|
interface SettingCollectionLoadOptions {
|
|
102831
102835
|
/**
|
|
102832
|
-
Specifying `$all` for the
|
|
102836
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
102833
102837
|
*/
|
|
102834
102838
|
$all?: boolean;
|
|
102835
102839
|
/**
|
|
@@ -102855,7 +102859,7 @@ declare namespace Word {
|
|
|
102855
102859
|
*/
|
|
102856
102860
|
interface StyleCollectionLoadOptions {
|
|
102857
102861
|
/**
|
|
102858
|
-
Specifying `$all` for the
|
|
102862
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
102859
102863
|
*/
|
|
102860
102864
|
$all?: boolean;
|
|
102861
102865
|
/**
|
|
@@ -102976,7 +102980,7 @@ declare namespace Word {
|
|
|
102976
102980
|
*/
|
|
102977
102981
|
interface StyleLoadOptions {
|
|
102978
102982
|
/**
|
|
102979
|
-
Specifying `$all` for the
|
|
102983
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
102980
102984
|
*/
|
|
102981
102985
|
$all?: boolean;
|
|
102982
102986
|
/**
|
|
@@ -103097,7 +103101,7 @@ declare namespace Word {
|
|
|
103097
103101
|
*/
|
|
103098
103102
|
interface ShadingLoadOptions {
|
|
103099
103103
|
/**
|
|
103100
|
-
Specifying `$all` for the
|
|
103104
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
103101
103105
|
*/
|
|
103102
103106
|
$all?: boolean;
|
|
103103
103107
|
/**
|
|
@@ -103116,7 +103120,7 @@ declare namespace Word {
|
|
|
103116
103120
|
*/
|
|
103117
103121
|
interface TableLoadOptions {
|
|
103118
103122
|
/**
|
|
103119
|
-
Specifying `$all` for the
|
|
103123
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
103120
103124
|
*/
|
|
103121
103125
|
$all?: boolean;
|
|
103122
103126
|
/**
|
|
@@ -103303,7 +103307,7 @@ declare namespace Word {
|
|
|
103303
103307
|
*/
|
|
103304
103308
|
interface TableStyleLoadOptions {
|
|
103305
103309
|
/**
|
|
103306
|
-
Specifying `$all` for the
|
|
103310
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
103307
103311
|
*/
|
|
103308
103312
|
$all?: boolean;
|
|
103309
103313
|
/**
|
|
@@ -103350,7 +103354,7 @@ declare namespace Word {
|
|
|
103350
103354
|
*/
|
|
103351
103355
|
interface TableCollectionLoadOptions {
|
|
103352
103356
|
/**
|
|
103353
|
-
Specifying `$all` for the
|
|
103357
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
103354
103358
|
*/
|
|
103355
103359
|
$all?: boolean;
|
|
103356
103360
|
/**
|
|
@@ -103537,22 +103541,22 @@ declare namespace Word {
|
|
|
103537
103541
|
*/
|
|
103538
103542
|
interface TableRowLoadOptions {
|
|
103539
103543
|
/**
|
|
103540
|
-
Specifying `$all` for the
|
|
103544
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
103541
103545
|
*/
|
|
103542
103546
|
$all?: boolean;
|
|
103543
103547
|
/**
|
|
103544
|
-
|
|
103545
|
-
|
|
103546
|
-
|
|
103547
|
-
|
|
103548
|
-
|
|
103548
|
+
* Gets the font. Use this to get and set font name, size, color, and other properties.
|
|
103549
|
+
*
|
|
103550
|
+
* @remarks
|
|
103551
|
+
* [Api set: WordApi 1.3]
|
|
103552
|
+
*/
|
|
103549
103553
|
font?: Word.Interfaces.FontLoadOptions;
|
|
103550
103554
|
/**
|
|
103551
|
-
|
|
103552
|
-
|
|
103553
|
-
|
|
103554
|
-
|
|
103555
|
-
|
|
103555
|
+
* Gets parent table.
|
|
103556
|
+
*
|
|
103557
|
+
* @remarks
|
|
103558
|
+
* [Api set: WordApi 1.3]
|
|
103559
|
+
*/
|
|
103556
103560
|
parentTable?: Word.Interfaces.TableLoadOptions;
|
|
103557
103561
|
/**
|
|
103558
103562
|
* Gets the number of cells in the row.
|
|
@@ -103619,22 +103623,22 @@ declare namespace Word {
|
|
|
103619
103623
|
*/
|
|
103620
103624
|
interface TableRowCollectionLoadOptions {
|
|
103621
103625
|
/**
|
|
103622
|
-
Specifying `$all` for the
|
|
103626
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
103623
103627
|
*/
|
|
103624
103628
|
$all?: boolean;
|
|
103625
103629
|
/**
|
|
103626
|
-
|
|
103627
|
-
|
|
103628
|
-
|
|
103629
|
-
|
|
103630
|
-
|
|
103630
|
+
* For EACH ITEM in the collection: Gets the font. Use this to get and set font name, size, color, and other properties.
|
|
103631
|
+
*
|
|
103632
|
+
* @remarks
|
|
103633
|
+
* [Api set: WordApi 1.3]
|
|
103634
|
+
*/
|
|
103631
103635
|
font?: Word.Interfaces.FontLoadOptions;
|
|
103632
103636
|
/**
|
|
103633
|
-
|
|
103634
|
-
|
|
103635
|
-
|
|
103636
|
-
|
|
103637
|
-
|
|
103637
|
+
* For EACH ITEM in the collection: Gets parent table.
|
|
103638
|
+
*
|
|
103639
|
+
* @remarks
|
|
103640
|
+
* [Api set: WordApi 1.3]
|
|
103641
|
+
*/
|
|
103638
103642
|
parentTable?: Word.Interfaces.TableLoadOptions;
|
|
103639
103643
|
/**
|
|
103640
103644
|
* For EACH ITEM in the collection: Gets the number of cells in the row.
|
|
@@ -103701,29 +103705,29 @@ declare namespace Word {
|
|
|
103701
103705
|
*/
|
|
103702
103706
|
interface TableCellLoadOptions {
|
|
103703
103707
|
/**
|
|
103704
|
-
Specifying `$all` for the
|
|
103708
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
103705
103709
|
*/
|
|
103706
103710
|
$all?: boolean;
|
|
103707
103711
|
/**
|
|
103708
|
-
|
|
103709
|
-
|
|
103710
|
-
|
|
103711
|
-
|
|
103712
|
-
|
|
103712
|
+
* Gets the body object of the cell.
|
|
103713
|
+
*
|
|
103714
|
+
* @remarks
|
|
103715
|
+
* [Api set: WordApi 1.3]
|
|
103716
|
+
*/
|
|
103713
103717
|
body?: Word.Interfaces.BodyLoadOptions;
|
|
103714
103718
|
/**
|
|
103715
|
-
|
|
103716
|
-
|
|
103717
|
-
|
|
103718
|
-
|
|
103719
|
-
|
|
103719
|
+
* Gets the parent row of the cell.
|
|
103720
|
+
*
|
|
103721
|
+
* @remarks
|
|
103722
|
+
* [Api set: WordApi 1.3]
|
|
103723
|
+
*/
|
|
103720
103724
|
parentRow?: Word.Interfaces.TableRowLoadOptions;
|
|
103721
103725
|
/**
|
|
103722
|
-
|
|
103723
|
-
|
|
103724
|
-
|
|
103725
|
-
|
|
103726
|
-
|
|
103726
|
+
* Gets the parent table of the cell.
|
|
103727
|
+
*
|
|
103728
|
+
* @remarks
|
|
103729
|
+
* [Api set: WordApi 1.3]
|
|
103730
|
+
*/
|
|
103727
103731
|
parentTable?: Word.Interfaces.TableLoadOptions;
|
|
103728
103732
|
/**
|
|
103729
103733
|
* Gets the index of the cell in its row.
|
|
@@ -103790,29 +103794,29 @@ declare namespace Word {
|
|
|
103790
103794
|
*/
|
|
103791
103795
|
interface TableCellCollectionLoadOptions {
|
|
103792
103796
|
/**
|
|
103793
|
-
Specifying `$all` for the
|
|
103797
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
103794
103798
|
*/
|
|
103795
103799
|
$all?: boolean;
|
|
103796
103800
|
/**
|
|
103797
|
-
|
|
103798
|
-
|
|
103799
|
-
|
|
103800
|
-
|
|
103801
|
-
|
|
103801
|
+
* For EACH ITEM in the collection: Gets the body object of the cell.
|
|
103802
|
+
*
|
|
103803
|
+
* @remarks
|
|
103804
|
+
* [Api set: WordApi 1.3]
|
|
103805
|
+
*/
|
|
103802
103806
|
body?: Word.Interfaces.BodyLoadOptions;
|
|
103803
103807
|
/**
|
|
103804
|
-
|
|
103805
|
-
|
|
103806
|
-
|
|
103807
|
-
|
|
103808
|
-
|
|
103808
|
+
* For EACH ITEM in the collection: Gets the parent row of the cell.
|
|
103809
|
+
*
|
|
103810
|
+
* @remarks
|
|
103811
|
+
* [Api set: WordApi 1.3]
|
|
103812
|
+
*/
|
|
103809
103813
|
parentRow?: Word.Interfaces.TableRowLoadOptions;
|
|
103810
103814
|
/**
|
|
103811
|
-
|
|
103812
|
-
|
|
103813
|
-
|
|
103814
|
-
|
|
103815
|
-
|
|
103815
|
+
* For EACH ITEM in the collection: Gets the parent table of the cell.
|
|
103816
|
+
*
|
|
103817
|
+
* @remarks
|
|
103818
|
+
* [Api set: WordApi 1.3]
|
|
103819
|
+
*/
|
|
103816
103820
|
parentTable?: Word.Interfaces.TableLoadOptions;
|
|
103817
103821
|
/**
|
|
103818
103822
|
* For EACH ITEM in the collection: Gets the index of the cell in its row.
|
|
@@ -103879,7 +103883,7 @@ declare namespace Word {
|
|
|
103879
103883
|
*/
|
|
103880
103884
|
interface TableBorderLoadOptions {
|
|
103881
103885
|
/**
|
|
103882
|
-
Specifying `$all` for the
|
|
103886
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
103883
103887
|
*/
|
|
103884
103888
|
$all?: boolean;
|
|
103885
103889
|
/**
|
|
@@ -103912,7 +103916,7 @@ declare namespace Word {
|
|
|
103912
103916
|
*/
|
|
103913
103917
|
interface TrackedChangeLoadOptions {
|
|
103914
103918
|
/**
|
|
103915
|
-
Specifying `$all` for the
|
|
103919
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
103916
103920
|
*/
|
|
103917
103921
|
$all?: boolean;
|
|
103918
103922
|
/**
|
|
@@ -103952,7 +103956,7 @@ declare namespace Word {
|
|
|
103952
103956
|
*/
|
|
103953
103957
|
interface TrackedChangeCollectionLoadOptions {
|
|
103954
103958
|
/**
|
|
103955
|
-
Specifying `$all` for the
|
|
103959
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
103956
103960
|
*/
|
|
103957
103961
|
$all?: boolean;
|
|
103958
103962
|
/**
|