From 1afd970a77cf6cfbe1af1970f53cfbc0baab52c3 Mon Sep 17 00:00:00 2001 From: Elizabeth Samuel Date: Mon, 3 Mar 2025 12:48:58 -0800 Subject: [PATCH] [office-js] [office-js-preview] (Word, PowerPoint) Updates from CDN (#72104) --- types/office-js-preview/index.d.ts | 2991 ++++++++++++++++------------ types/office-js/index.d.ts | 248 ++- 2 files changed, 1886 insertions(+), 1353 deletions(-) diff --git a/types/office-js-preview/index.d.ts b/types/office-js-preview/index.d.ts index 160d909ed6aed5..9ef060af489798 100644 --- a/types/office-js-preview/index.d.ts +++ b/types/office-js-preview/index.d.ts @@ -94471,9 +94471,9 @@ declare namespace Word { */ untrack(): Word.CritiqueAnnotation; /** - * 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's passed to it.) - * 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. - */ + * 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's passed to it.) + * 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. + */ toJSON(): Word.Interfaces.CritiqueAnnotationData; } /** @@ -94584,9 +94584,9 @@ declare namespace Word { */ untrack(): Word.Annotation; /** - * 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's passed to it.) - * 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. - */ + * 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's passed to it.) + * 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. + */ toJSON(): Word.Interfaces.AnnotationData; } /** @@ -94732,9 +94732,9 @@ declare namespace Word { */ untrack(): Word.AnnotationCollection; /** - * 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's passed to it.) - * Whereas the original `Word.AnnotationCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.AnnotationCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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's passed to it.) + * Whereas the original `Word.AnnotationCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.AnnotationCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.AnnotationCollectionData; } /** @@ -94785,9 +94785,9 @@ declare namespace Word { */ static newObject(context: OfficeExtension.ClientRequestContext): Word.Application; /** - * 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's passed to it.) - * 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. - */ + * 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's passed to it.) + * 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. + */ toJSON(): { [key: string]: string; }; @@ -95054,7 +95054,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario. + * Note: Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario. * * @param base64File Required. The Base64-encoded content of a .docx file. * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. @@ -95238,9 +95238,9 @@ declare namespace Word { */ untrack(): Word.Body; /** - * 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's passed to it.) - * 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. - */ + * 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's passed to it.) + * 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. + */ toJSON(): Word.Interfaces.BodyData; } /** @@ -95325,9 +95325,9 @@ declare namespace Word { */ untrack(): Word.Border; /** - * 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's passed to it.) - * Whereas the original `Word.Border` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BorderData`) that contains shallow copies of any loaded child properties from the original object. - */ + * 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's passed to it.) + * Whereas the original `Word.Border` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BorderData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.BorderData; } /** @@ -95440,9 +95440,9 @@ declare namespace Word { */ untrack(): Word.BorderCollection; /** - * 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's passed to it.) - * Whereas the original `Word.BorderCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BorderCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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's passed to it.) + * Whereas the original `Word.BorderCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BorderCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.BorderCollectionData; } /** @@ -95499,9 +95499,9 @@ declare namespace Word { */ untrack(): Word.CheckboxContentControl; /** - * 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's passed to it.) - * 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. - */ + * 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's passed to it.) + * 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. + */ toJSON(): Word.Interfaces.CheckboxContentControlData; } /** @@ -95630,9 +95630,9 @@ declare namespace Word { */ untrack(): Word.Comment; /** - * 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's passed to it.) - * 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. - */ + * 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's passed to it.) + * 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. + */ toJSON(): Word.Interfaces.CommentData; } /** @@ -95687,9 +95687,9 @@ declare namespace Word { */ untrack(): Word.CommentCollection; /** - * 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's passed to it.) - * Whereas the original `Word.CommentCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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's passed to it.) + * Whereas the original `Word.CommentCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.CommentCollectionData; } /** @@ -95796,9 +95796,9 @@ declare namespace Word { */ untrack(): Word.CommentContentRange; /** - * 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's passed to it.) - * 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. - */ + * 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's passed to it.) + * 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. + */ toJSON(): Word.Interfaces.CommentContentRangeData; } /** @@ -95904,9 +95904,9 @@ declare namespace Word { */ untrack(): Word.CommentReply; /** - * 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's passed to it.) - * 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. - */ + * 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's passed to it.) + * 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. + */ toJSON(): Word.Interfaces.CommentReplyData; } /** @@ -95961,9 +95961,9 @@ declare namespace Word { */ untrack(): Word.CommentReplyCollection; /** - * 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's passed to it.) - * Whereas the original `Word.CommentReplyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentReplyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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's passed to it.) + * Whereas the original `Word.CommentReplyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentReplyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.CommentReplyCollectionData; } /** @@ -96326,7 +96326,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario. + * Note: Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario. * * @param base64File Required. The Base64-encoded content of a .docx file. * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls. @@ -96585,9 +96585,9 @@ declare namespace Word { */ untrack(): Word.ContentControl; /** - * 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's passed to it.) - * 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. - */ + * 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's passed to it.) + * 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. + */ toJSON(): Word.Interfaces.ContentControlData; } /** @@ -96705,9 +96705,9 @@ declare namespace Word { */ untrack(): Word.ContentControlCollection; /** - * 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's passed to it.) - * Whereas the original `Word.ContentControlCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ContentControlCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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's passed to it.) + * Whereas the original `Word.ContentControlCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ContentControlCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.ContentControlCollectionData; } /** @@ -96949,9 +96949,9 @@ declare namespace Word { */ untrack(): Word.CustomProperty; /** - * 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's passed to it.) - * 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. - */ + * 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's passed to it.) + * 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. + */ toJSON(): Word.Interfaces.CustomPropertyData; } /** @@ -97034,9 +97034,9 @@ declare namespace Word { */ untrack(): Word.CustomPropertyCollection; /** - * 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's passed to it.) - * Whereas the original `Word.CustomPropertyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomPropertyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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's passed to it.) + * Whereas the original `Word.CustomPropertyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomPropertyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.CustomPropertyCollectionData; } /** @@ -97313,9 +97313,9 @@ declare namespace Word { */ untrack(): Word.CustomXmlPart; /** - * 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's passed to it.) - * 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. - */ + * 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's passed to it.) + * 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. + */ toJSON(): Word.Interfaces.CustomXmlPartData; } /** @@ -97399,9 +97399,9 @@ declare namespace Word { */ untrack(): Word.CustomXmlPartCollection; /** - * 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's passed to it.) - * Whereas the original `Word.CustomXmlPartCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPartCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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's passed to it.) + * Whereas the original `Word.CustomXmlPartCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPartCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.CustomXmlPartCollectionData; } /** @@ -97481,9 +97481,9 @@ declare namespace Word { */ untrack(): Word.CustomXmlPartScopedCollection; /** - * 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's passed to it.) - * Whereas the original `Word.CustomXmlPartScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPartScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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's passed to it.) + * Whereas the original `Word.CustomXmlPartScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPartScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.CustomXmlPartScopedCollectionData; } /** @@ -97752,7 +97752,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.5] * - * Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario. + * Note: Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario. * * @param base64File Required. The Base64-encoded content of a .docx file. * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. @@ -97909,9 +97909,9 @@ declare namespace Word { */ untrack(): Word.Document; /** - * 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's passed to it.) - * 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. - */ + * 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's passed to it.) + * 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. + */ toJSON(): Word.Interfaces.DocumentData; } /** @@ -98054,7 +98054,7 @@ declare namespace Word { * @remarks * [Api set: WordApiHiddenDocument 1.5] * - * Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario. + * Note: Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario. * * @param base64File Required. The Base64-encoded content of a .docx file. * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. @@ -98122,9 +98122,9 @@ declare namespace Word { */ untrack(): Word.DocumentCreated; /** - * 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's passed to it.) - * 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. - */ + * 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's passed to it.) + * 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. + */ toJSON(): Word.Interfaces.DocumentCreatedData; } /** @@ -98300,9 +98300,9 @@ declare namespace Word { */ untrack(): Word.DocumentProperties; /** - * 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's passed to it.) - * 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. - */ + * 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's passed to it.) + * 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. + */ toJSON(): Word.Interfaces.DocumentPropertiesData; } /** @@ -98630,9 +98630,9 @@ declare namespace Word { */ untrack(): Word.Field; /** - * 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's passed to it.) - * 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. - */ + * 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's passed to it.) + * 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. + */ toJSON(): Word.Interfaces.FieldData; } /** @@ -98702,9 +98702,9 @@ declare namespace Word { */ untrack(): Word.FieldCollection; /** - * 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's passed to it.) - * Whereas the original `Word.FieldCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FieldCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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's passed to it.) + * Whereas the original `Word.FieldCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FieldCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.FieldCollectionData; } /** @@ -98839,9 +98839,9 @@ declare namespace Word { */ untrack(): Word.Font; /** - * 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's passed to it.) - * 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. - */ + * 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's passed to it.) + * 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. + */ toJSON(): Word.Interfaces.FontData; } /** @@ -99019,7 +99019,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.2] * - * Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario. + * Note: Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario. * * @param base64File Required. The Base64-encoded content of a .docx file. * @param insertLocation Required. The value must be 'Before' or 'After'. @@ -99123,9 +99123,9 @@ declare namespace Word { */ untrack(): Word.InlinePicture; /** - * 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's passed to it.) - * 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. - */ + * 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's passed to it.) + * 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. + */ toJSON(): Word.Interfaces.InlinePictureData; } /** @@ -99180,9 +99180,9 @@ declare namespace Word { */ untrack(): Word.InlinePictureCollection; /** - * 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's passed to it.) - * Whereas the original `Word.InlinePictureCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.InlinePictureCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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's passed to it.) + * Whereas the original `Word.InlinePictureCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.InlinePictureCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.InlinePictureCollectionData; } /** @@ -99405,9 +99405,9 @@ declare namespace Word { */ untrack(): Word.List; /** - * 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's passed to it.) - * 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. - */ + * 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's passed to it.) + * 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. + */ toJSON(): Word.Interfaces.ListData; } /** @@ -99489,9 +99489,9 @@ declare namespace Word { */ untrack(): Word.ListCollection; /** - * 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's passed to it.) - * Whereas the original `Word.ListCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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's passed to it.) + * Whereas the original `Word.ListCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.ListCollectionData; } /** @@ -99589,9 +99589,9 @@ declare namespace Word { */ untrack(): Word.ListItem; /** - * 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's passed to it.) - * 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. - */ + * 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's passed to it.) + * 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. + */ toJSON(): Word.Interfaces.ListItemData; } /** @@ -99718,9 +99718,9 @@ declare namespace Word { */ untrack(): Word.ListLevel; /** - * 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's passed to it.) - * Whereas the original `Word.ListLevel` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListLevelData`) that contains shallow copies of any loaded child properties from the original object. - */ + * 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's passed to it.) + * Whereas the original `Word.ListLevel` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListLevelData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ListLevelData; } /** @@ -99775,9 +99775,9 @@ declare namespace Word { */ untrack(): Word.ListLevelCollection; /** - * 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's passed to it.) - * Whereas the original `Word.ListLevelCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListLevelCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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's passed to it.) + * Whereas the original `Word.ListLevelCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListLevelCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.ListLevelCollectionData; } /** @@ -99841,9 +99841,9 @@ declare namespace Word { */ untrack(): Word.ListTemplate; /** - * 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's passed to it.) - * Whereas the original `Word.ListTemplate` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListTemplateData`) that contains shallow copies of any loaded child properties from the original object. - */ + * 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's passed to it.) + * Whereas the original `Word.ListTemplate` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListTemplateData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ListTemplateData; } /** @@ -99935,9 +99935,9 @@ declare namespace Word { */ untrack(): Word.NoteItem; /** - * 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's passed to it.) - * 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. - */ + * 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's passed to it.) + * 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. + */ toJSON(): Word.Interfaces.NoteItemData; } /** @@ -99992,9 +99992,9 @@ declare namespace Word { */ untrack(): Word.NoteItemCollection; /** - * 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's passed to it.) - * Whereas the original `Word.NoteItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.NoteItemCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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's passed to it.) + * Whereas the original `Word.NoteItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.NoteItemCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.NoteItemCollectionData; } /** @@ -100832,7 +100832,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario. + * Note: Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario. * * @param base64File Required. The Base64-encoded content of a .docx file. * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. @@ -101074,9 +101074,9 @@ declare namespace Word { */ untrack(): Word.Paragraph; /** - * 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's passed to it.) - * 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. - */ + * 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's passed to it.) + * 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. + */ toJSON(): Word.Interfaces.ParagraphData; } /** @@ -101145,9 +101145,9 @@ declare namespace Word { */ untrack(): Word.ParagraphCollection; /** - * 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's passed to it.) - * Whereas the original `Word.ParagraphCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ParagraphCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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's passed to it.) + * Whereas the original `Word.ParagraphCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ParagraphCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.ParagraphCollectionData; } /** @@ -101295,9 +101295,9 @@ declare namespace Word { */ untrack(): Word.ParagraphFormat; /** - * 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's passed to it.) - * 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. - */ + * 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's passed to it.) + * 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. + */ toJSON(): Word.Interfaces.ParagraphFormatData; } /** @@ -101764,7 +101764,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario. + * Note: Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario. * * @param base64File Required. The Base64-encoded content of a .docx file. * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. @@ -102024,9 +102024,9 @@ declare namespace Word { */ untrack(): Word.Range; /** - * 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's passed to it.) - * 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. - */ + * 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's passed to it.) + * 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. + */ toJSON(): Word.Interfaces.RangeData; } /** @@ -102081,9 +102081,9 @@ declare namespace Word { */ untrack(): Word.RangeCollection; /** - * 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's passed to it.) - * Whereas the original `Word.RangeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RangeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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's passed to it.) + * Whereas the original `Word.RangeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RangeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.RangeCollectionData; } /** @@ -102279,9 +102279,9 @@ declare namespace Word { */ static newObject(context: OfficeExtension.ClientRequestContext): Word.SearchOptions; /** - * 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's passed to it.) - * 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. - */ + * 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's passed to it.) + * 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. + */ toJSON(): Word.Interfaces.SearchOptionsData; } /** @@ -102468,9 +102468,9 @@ declare namespace Word { */ untrack(): Word.Section; /** - * 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's passed to it.) - * 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. - */ + * 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's passed to it.) + * 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. + */ toJSON(): Word.Interfaces.SectionData; } /** @@ -102525,9 +102525,9 @@ declare namespace Word { */ untrack(): Word.SectionCollection; /** - * 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's passed to it.) - * Whereas the original `Word.SectionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SectionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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's passed to it.) + * Whereas the original `Word.SectionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SectionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.SectionCollectionData; } /** @@ -102598,9 +102598,9 @@ declare namespace Word { */ untrack(): Word.Setting; /** - * 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's passed to it.) - * 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. - */ + * 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's passed to it.) + * 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. + */ toJSON(): Word.Interfaces.SettingData; } /** @@ -102683,9 +102683,9 @@ declare namespace Word { */ untrack(): Word.SettingCollection; /** - * 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's passed to it.) - * Whereas the original `Word.SettingCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SettingCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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's passed to it.) + * Whereas the original `Word.SettingCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SettingCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.SettingCollectionData; } /** @@ -102760,9 +102760,9 @@ declare namespace Word { */ untrack(): Word.StyleCollection; /** - * 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's passed to it.) - * Whereas the original `Word.StyleCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.StyleCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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's passed to it.) + * Whereas the original `Word.StyleCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.StyleCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.StyleCollectionData; } /** @@ -102950,9 +102950,9 @@ declare namespace Word { */ untrack(): Word.Style; /** - * 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's passed to it.) - * 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. - */ + * 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's passed to it.) + * 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. + */ toJSON(): Word.Interfaces.StyleData; } /** @@ -103023,9 +103023,9 @@ declare namespace Word { */ untrack(): Word.Shading; /** - * 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's passed to it.) - * 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. - */ + * 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's passed to it.) + * 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. + */ toJSON(): Word.Interfaces.ShadingData; } /** @@ -103559,9 +103559,9 @@ declare namespace Word { */ untrack(): Word.Table; /** - * 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's passed to it.) - * 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. - */ + * 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's passed to it.) + * 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. + */ toJSON(): Word.Interfaces.TableData; } /** @@ -103660,9 +103660,9 @@ declare namespace Word { */ untrack(): Word.TableStyle; /** - * 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's passed to it.) - * 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. - */ + * 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's passed to it.) + * 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. + */ toJSON(): Word.Interfaces.TableStyleData; } /** @@ -103717,9 +103717,9 @@ declare namespace Word { */ untrack(): Word.TableCollection; /** - * 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's passed to it.) - * Whereas the original `Word.TableCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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's passed to it.) + * Whereas the original `Word.TableCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.TableCollectionData; } /** @@ -104012,9 +104012,9 @@ declare namespace Word { */ untrack(): Word.TableRow; /** - * 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's passed to it.) - * 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. - */ + * 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's passed to it.) + * 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. + */ toJSON(): Word.Interfaces.TableRowData; } /** @@ -104069,9 +104069,9 @@ declare namespace Word { */ untrack(): Word.TableRowCollection; /** - * 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's passed to it.) - * Whereas the original `Word.TableRowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableRowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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's passed to it.) + * Whereas the original `Word.TableRowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableRowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.TableRowCollectionData; } /** @@ -104314,9 +104314,9 @@ declare namespace Word { */ untrack(): Word.TableCell; /** - * 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's passed to it.) - * 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. - */ + * 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's passed to it.) + * 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. + */ toJSON(): Word.Interfaces.TableCellData; } /** @@ -104371,9 +104371,9 @@ declare namespace Word { */ untrack(): Word.TableCellCollection; /** - * 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's passed to it.) - * Whereas the original `Word.TableCellCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCellCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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's passed to it.) + * Whereas the original `Word.TableCellCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCellCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.TableCellCollectionData; } /** @@ -104444,9 +104444,9 @@ declare namespace Word { */ untrack(): Word.TableBorder; /** - * 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's passed to it.) - * 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. - */ + * 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's passed to it.) + * 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. + */ toJSON(): Word.Interfaces.TableBorderData; } /** @@ -104551,9 +104551,9 @@ declare namespace Word { */ untrack(): Word.TrackedChange; /** - * 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's passed to it.) - * 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. - */ + * 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's passed to it.) + * 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. + */ toJSON(): Word.Interfaces.TrackedChangeData; } /** @@ -104622,9 +104622,9 @@ declare namespace Word { */ untrack(): Word.TrackedChangeCollection; /** - * 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's passed to it.) - * Whereas the original `Word.TrackedChangeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TrackedChangeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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's passed to it.) + * Whereas the original `Word.TrackedChangeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TrackedChangeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.TrackedChangeCollectionData; } /** @@ -104699,6 +104699,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ allowOverlap: boolean; + /** + * Specifies a string that represents the alternative text associated with the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + altTextDescription: string; /** * The geometric shape type of the shape. It will be null if isn't a geometric shape. * @@ -104713,6 +104720,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ height: number; + /** + * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + heightRelative: number; /** * Gets an integer that represents the shape identifier. * @@ -104734,6 +104748,20 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ left: number; + /** + * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + leftRelative: number; + /** + * Specifies if the aspect ratio of this shape is locked. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + lockAspectRatio: boolean; /** * The name of the shape. * @@ -104748,6 +104776,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + /** + * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + relativeHorizontalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. * @@ -104755,6 +104790,20 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + /** + * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + relativeVerticalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + /** + * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + rotation: number; /** * The distance, in points, from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * @@ -104762,6 +104811,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ top: number; + /** + * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + topRelative: number; /** * Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * @@ -104769,6 +104825,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ readonly type: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas"; + /** + * Specifies if the shape is visible. Not applicable to inline shapes. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + visible: boolean; /** * The width, in points, of the shape. * @@ -104776,6 +104839,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ width: number; + /** + * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + widthRelative: number; /** * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. @@ -104809,6 +104879,50 @@ declare namespace Word { * @param distance Required. Specifies how far the shape is to be moved vertically, in points. Use a positive value to move the shape up. Use a negative value to move the shape down. */ moveVertically(distance: number): void; + /** + * Scales the height of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + * + * @param scaleFactor Specifies the ratio between the height of the shape after you resize it and the current or original height. + * @param scaleType Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. + * @param scaleFrom Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. + */ + scaleHeight(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void; + /** + * Scales the height of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + * + * @param scaleFactor Specifies the ratio between the height of the shape after you resize it and the current or original height. + * @param scaleType Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. + * @param scaleFrom Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. + */ + scaleHeight(scaleFactor: number, scaleType: "CurrentSize" | "OriginalSize", scaleFrom?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void; + /** + * Scales the width of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + * + * @param scaleFactor Specifies the ratio between the width of the shape after you resize it and the current or original width. + * @param scaleType Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. + * @param scaleFrom Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. + */ + scaleWidth(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void; + /** + * Scales the width of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + * + * @param scaleFactor Specifies the ratio between the width of the shape after you resize it and the current or original width. + * @param scaleType Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. + * @param scaleFrom Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. + */ + scaleWidth(scaleFactor: number, scaleType: "CurrentSize" | "OriginalSize", scaleFrom?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void; /** * Selects the shape. * @@ -104848,9 +104962,9 @@ declare namespace Word { */ untrack(): Word.Shape; /** - * 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's passed to it.) - * Whereas the original `Word.Shape` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeData`) that contains shallow copies of any loaded child properties from the original object. - */ + * 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's passed to it.) + * Whereas the original `Word.Shape` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ShapeData; } /** @@ -105119,9 +105233,9 @@ declare namespace Word { */ untrack(): Word.ShapeCollection; /** - * 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's passed to it.) - * Whereas the original `Word.ShapeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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's passed to it.) + * Whereas the original `Word.ShapeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.ShapeCollectionData; } /** @@ -106736,7 +106850,7 @@ declare namespace Word { */ start = "Start", /** - * The ending point of the object. For paragraph, it's the point before the EOP (end of paragraph). For content control, it is the point before the closing tag. + * The ending point of the object. For paragraph, it's the point before the EOP (end of paragraph). For content control, it's the point before the closing tag. * @remarks * [Api set: WordApi 1.3] */ @@ -109573,6 +109687,51 @@ declare namespace Word { */ outsideMargin = "OutsideMargin", } + /** + * Represents what the horizontal or vertical size of a shape is relative to. + For more information about margins, see {@link https://support.microsoft.com/office/c95c1ea1-70b1-4dde-a1da-f5aa2042c829 | Change the margins in your Word document}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum RelativeSize { + /** + * Relative to margin. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + margin = "Margin", + /** + * Relative to page. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + page = "Page", + /** + * Relative to top margin. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + topMargin = "TopMargin", + /** + * Relative to bottom margin. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + bottomMargin = "BottomMargin", + /** + * Relative to inside margin. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + insideMargin = "InsideMargin", + /** + * Relative to outside margin. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + outsideMargin = "OutsideMargin", + } /** * Specifies the shape type for a `GeometricShape` object. * @@ -110889,6 +111048,52 @@ declare namespace Word { */ largest = "Largest", } + /** + * Specifies the scale size type of a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeScaleType { + /** + * Scale from current size of the shape. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + currentSize = "CurrentSize", + /** + * Scale from original size of the shape. It only works for pictures. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + originalSize = "OriginalSize", + } + /** + * Specifies which part of the shape retains its position when the shape is scaled. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeScaleFrom { + /** + * Scale from the top left corner of the shape. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + scaleFromTopLeft = "ScaleFromTopLeft", + /** + * Scale from the center of the shape. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + scaleFromMiddle = "ScaleFromMiddle", + /** + * Scale from the bottom right corner of the shape. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + scaleFromBottomRight = "ScaleFromBottomRight", + } enum ErrorCodes { accessDenied = "AccessDenied", generalException = "GeneralException", @@ -110901,16 +111106,16 @@ declare namespace Word { } namespace Interfaces { /** - * Provides ways to load properties of only a subset of members of a collection. - */ + * Provides ways to load properties of only a subset of members of a collection. + */ interface CollectionLoadOptions { /** - * Specify the number of items in the queried collection to be included in the result. - */ + * Specify the number of items in the queried collection to be included in the result. + */ $top?: number; /** - * 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. - */ + * 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. + */ $skip?: number; } /** An interface for updating data on the `AnnotationCollection` object, for use in `annotationCollection.set({ ... })`. */ @@ -110920,11 +111125,11 @@ declare namespace Word { /** An interface for updating data on the `Body` object, for use in `body.set({ ... })`. */ interface BodyUpdateData { /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ font?: Word.Interfaces.FontUpdateData; /** * 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. @@ -111031,11 +111236,11 @@ declare namespace Word { /** An interface for updating data on the `Comment` object, for use in `comment.set({ ... })`. */ interface CommentUpdateData { /** - * Specifies the comment's content range. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Specifies the comment's content range. + * + * @remarks + * [Api set: WordApi 1.4] + */ contentRange?: Word.Interfaces.CommentContentRangeUpdateData; /** * Specifies the comment's content as plain text. @@ -111097,18 +111302,18 @@ declare namespace Word { /** An interface for updating data on the `CommentReply` object, for use in `commentReply.set({ ... })`. */ interface CommentReplyUpdateData { /** - * Specifies the commentReply's content range. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Specifies the commentReply's content range. + * + * @remarks + * [Api set: WordApi 1.4] + */ contentRange?: Word.Interfaces.CommentContentRangeUpdateData; /** - * Gets the parent comment of this reply. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the parent comment of this reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentComment?: Word.Interfaces.CommentUpdateData; /** * Specifies the comment reply's content. The string is plain text. @@ -111125,18 +111330,18 @@ declare namespace Word { /** An interface for updating data on the `ContentControl` object, for use in `contentControl.set({ ... })`. */ interface ContentControlUpdateData { /** - * Gets the data of the content control when its type is 'CheckBox'. It's `null` otherwise. - * - * @remarks - * [Api set: WordApi 1.7] - */ + * Gets the data of the content control when its type is 'CheckBox'. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi 1.7] + */ checkboxContentControl?: Word.Interfaces.CheckboxContentControlUpdateData; /** - * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ font?: Word.Interfaces.FontUpdateData; /** * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. @@ -111266,18 +111471,18 @@ declare namespace Word { /** An interface for updating data on the `Document` object, for use in `document.set({ ... })`. */ interface DocumentUpdateData { /** - * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * + * @remarks + * [Api set: WordApi 1.1] + */ body?: Word.Interfaces.BodyUpdateData; /** - * Gets the properties of the document. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the properties of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ properties?: Word.Interfaces.DocumentPropertiesUpdateData; /** * Specifies the ChangeTracking mode. @@ -111290,18 +111495,18 @@ declare namespace Word { /** An interface for updating data on the `DocumentCreated` object, for use in `documentCreated.set({ ... })`. */ interface DocumentCreatedUpdateData { /** - * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ + * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ body?: Word.Interfaces.BodyUpdateData; /** - * Gets the properties of the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ + * Gets the properties of the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ properties?: Word.Interfaces.DocumentPropertiesUpdateData; } /** An interface for updating data on the `DocumentProperties` object, for use in `documentProperties.set({ ... })`. */ @@ -111373,11 +111578,11 @@ declare namespace Word { /** An interface for updating data on the `Field` object, for use in `field.set({ ... })`. */ interface FieldUpdateData { /** - * Gets the field's result data. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the field's result data. + * + * @remarks + * [Api set: WordApi 1.4] + */ result?: Word.Interfaces.RangeUpdateData; /** * Specifies the field's code instruction. @@ -111568,11 +111773,11 @@ declare namespace Word { /** An interface for updating data on the `ListLevel` object, for use in `listLevel.set({ ... })`. */ interface ListLevelUpdateData { /** - * Gets a Font object that represents the character formatting of the specified object. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ + * Gets a Font object that represents the character formatting of the specified object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ font?: Word.Interfaces.FontUpdateData; /** * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. @@ -111662,18 +111867,18 @@ declare namespace Word { /** An interface for updating data on the `NoteItem` object, for use in `noteItem.set({ ... })`. */ interface NoteItemUpdateData { /** - * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. + * + * @remarks + * [Api set: WordApi 1.5] + */ body?: Word.Interfaces.BodyUpdateData; /** - * Represents a footnote or endnote reference in the main document. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * Represents a footnote or endnote reference in the main document. + * + * @remarks + * [Api set: WordApi 1.5] + */ reference?: Word.Interfaces.RangeUpdateData; } /** An interface for updating data on the `NoteItemCollection` object, for use in `noteItemCollection.set({ ... })`. */ @@ -111908,11 +112113,11 @@ declare namespace Word { /** An interface for updating data on the `Range` object, for use in `range.set({ ... })`. */ interface RangeUpdateData { /** - * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ font?: Word.Interfaces.FontUpdateData; /** * 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. @@ -111995,11 +112200,11 @@ declare namespace Word { /** An interface for updating data on the `Section` object, for use in `section.set({ ... })`. */ interface SectionUpdateData { /** - * Gets the body object of the section. This doesn't include the header/footer and other section metadata. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the body object of the section. This doesn't include the header/footer and other section metadata. + * + * @remarks + * [Api set: WordApi 1.1] + */ body?: Word.Interfaces.BodyUpdateData; } /** An interface for updating data on the `SectionCollection` object, for use in `sectionCollection.set({ ... })`. */ @@ -112027,46 +112232,46 @@ declare namespace Word { /** An interface for updating data on the `Style` object, for use in `style.set({ ... })`. */ interface StyleUpdateData { /** - * Specifies a BorderCollection object that represents all the borders for the specified style. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ + * Specifies a BorderCollection object that represents all the borders for the specified style. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ borders?: Word.Interfaces.BorderCollectionUpdateData; /** - * Gets a font object that represents the character formatting of the specified style. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * Gets a font object that represents the character formatting of the specified style. + * + * @remarks + * [Api set: WordApi 1.5] + */ font?: Word.Interfaces.FontUpdateData; /** - * Gets a ListTemplate object that represents the list formatting for the specified Style object. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ + * Gets a ListTemplate object that represents the list formatting for the specified Style object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ listTemplate?: Word.Interfaces.ListTemplateUpdateData; /** - * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. + * + * @remarks + * [Api set: WordApi 1.5] + */ paragraphFormat?: Word.Interfaces.ParagraphFormatUpdateData; /** - * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. - * - * @remarks - * [Api set: WordApi 1.6] - */ + * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. + * + * @remarks + * [Api set: WordApi 1.6] + */ shading?: Word.Interfaces.ShadingUpdateData; /** - * Gets a TableStyle object representing Style properties that can be applied to a table. - * - * @remarks - * [Api set: WordApi 1.6] - */ + * Gets a TableStyle object representing Style properties that can be applied to a table. + * + * @remarks + * [Api set: WordApi 1.6] + */ tableStyle?: Word.Interfaces.TableStyleUpdateData; /** * Specifies the name of an existing style to use as the base formatting of another style. @@ -112142,11 +112347,11 @@ declare namespace Word { /** An interface for updating data on the `Table` object, for use in `table.set({ ... })`. */ interface TableUpdateData { /** - * Gets the font. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the font. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.3] + */ font?: Word.Interfaces.FontUpdateData; /** * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. @@ -112306,11 +112511,11 @@ declare namespace Word { /** An interface for updating data on the `TableRow` object, for use in `tableRow.set({ ... })`. */ interface TableRowUpdateData { /** - * Gets the font. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the font. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.3] + */ font?: Word.Interfaces.FontUpdateData; /** * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. @@ -112355,11 +112560,11 @@ declare namespace Word { /** An interface for updating data on the `TableCell` object, for use in `tableCell.set({ ... })`. */ interface TableCellUpdateData { /** - * Gets the body object of the cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the body object of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ body?: Word.Interfaces.BodyUpdateData; /** * Specifies the width of the cell's column in points. This is applicable to uniform tables. @@ -112494,6 +112699,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ allowOverlap?: boolean; + /** + * Specifies a string that represents the alternative text associated with the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + altTextDescription?: string; /** * The geometric shape type of the shape. It will be null if isn't a geometric shape. * @@ -112508,6 +112720,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ height?: number; + /** + * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + heightRelative?: number; /** * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * @@ -112515,6 +112734,20 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ left?: number; + /** + * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + leftRelative?: number; + /** + * Specifies if the aspect ratio of this shape is locked. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + lockAspectRatio?: boolean; /** * The name of the shape. * @@ -112529,6 +112762,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + /** + * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. * @@ -112536,6 +112776,20 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + /** + * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + relativeVerticalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + /** + * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + rotation?: number; /** * The distance, in points, from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * @@ -112543,6 +112797,20 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ top?: number; + /** + * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + topRelative?: number; + /** + * Specifies if the shape is visible. Not applicable to inline shapes. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + visible?: boolean; /** * The width, in points, of the shape. * @@ -112550,6 +112818,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ width?: number; + /** + * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + widthRelative?: number; } /** An interface for updating data on the `ShapeGroup` object, for use in `shapeGroup.set({ ... })`. */ interface ShapeGroupUpdateData { @@ -112558,7 +112833,7 @@ declare namespace Word { * * @remarks * [Api set: WordApiDesktop 1.2] - */ + */ shape?: Word.Interfaces.ShapeUpdateData; } /** An interface for updating data on the `Canvas` object, for use in `canvas.set({ ... })`. */ @@ -112744,62 +113019,62 @@ declare namespace Word { /** An interface describing the data returned by calling `body.toJSON()`. */ interface BodyData { /** - * Gets the collection of rich text content control objects in the body. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the collection of rich text content control objects in the body. + * + * @remarks + * [Api set: WordApi 1.1] + */ contentControls?: Word.Interfaces.ContentControlData[]; /** - * Gets the collection of field objects in the body. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the collection of field objects in the body. + * + * @remarks + * [Api set: WordApi 1.4] + */ fields?: Word.Interfaces.FieldData[]; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ font?: Word.Interfaces.FontData; /** - * Gets the collection of InlinePicture objects in the body. The collection doesn't include floating images. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the collection of InlinePicture objects in the body. The collection doesn't include floating images. + * + * @remarks + * [Api set: WordApi 1.1] + */ inlinePictures?: Word.Interfaces.InlinePictureData[]; /** - * Gets the collection of list objects in the body. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the collection of list objects in the body. + * + * @remarks + * [Api set: WordApi 1.3] + */ lists?: Word.Interfaces.ListData[]; /** - * Gets the collection of paragraph objects in the body. - * - * @remarks - * [Api set: WordApi 1.1] - * - * Important: Paragraphs in tables aren't returned for requirement sets 1.1 and 1.2. From requirement set 1.3, paragraphs in tables are also returned. - */ + * Gets the collection of paragraph objects in the body. + * + * @remarks + * [Api set: WordApi 1.1] + * + * Important: Paragraphs in tables aren't returned for requirement sets 1.1 and 1.2. From requirement set 1.3, paragraphs in tables are also returned. + */ paragraphs?: Word.Interfaces.ParagraphData[]; /** - * Gets the collection of shape objects in the body, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the collection of shape objects in the body, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ shapes?: Word.Interfaces.ShapeData[]; /** - * Gets the collection of table objects in the body. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the collection of table objects in the body. + * + * @remarks + * [Api set: WordApi 1.3] + */ tables?: Word.Interfaces.TableData[]; /** * 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. @@ -113056,76 +113331,76 @@ declare namespace Word { /** An interface describing the data returned by calling `contentControl.toJSON()`. */ interface ContentControlData { /** - * Gets the data of the content control when its type is 'CheckBox'. It's `null` otherwise. - * - * @remarks - * [Api set: WordApi 1.7] - */ + * Gets the data of the content control when its type is 'CheckBox'. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi 1.7] + */ checkboxContentControl?: Word.Interfaces.CheckboxContentControlData; /** - * Gets the data of the content control when its type is 'ComboBox'. It's `null` otherwise. - * - * @remarks - * [Api set: WordApi 1.9] - */ + * Gets the data of the content control when its type is 'ComboBox'. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi 1.9] + */ comboBoxContentControl?: Word.Interfaces.ComboBoxContentControlData; /** - * Gets the collection of content control objects in the content control. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the collection of content control objects in the content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ contentControls?: Word.Interfaces.ContentControlData[]; /** - * Gets the data of the content control when its type is 'DropDownList'. It's `null` otherwise. - * - * @remarks - * [Api set: WordApi 1.9] - */ + * Gets the data of the content control when its type is 'DropDownList'. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi 1.9] + */ dropDownListContentControl?: Word.Interfaces.DropDownListContentControlData; /** - * Gets the collection of field objects in the content control. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the collection of field objects in the content control. + * + * @remarks + * [Api set: WordApi 1.4] + */ fields?: Word.Interfaces.FieldData[]; /** - * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ font?: Word.Interfaces.FontData; /** - * Gets the collection of InlinePicture objects in the content control. The collection doesn't include floating images. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the collection of InlinePicture objects in the content control. The collection doesn't include floating images. + * + * @remarks + * [Api set: WordApi 1.1] + */ inlinePictures?: Word.Interfaces.InlinePictureData[]; /** - * Gets the collection of list objects in the content control. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the collection of list objects in the content control. + * + * @remarks + * [Api set: WordApi 1.3] + */ lists?: Word.Interfaces.ListData[]; /** - * Gets the collection of paragraph objects in the content control. - * - * @remarks - * [Api set: WordApi 1.1] - * - * Important: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this content control aren't returned. From requirement set 1.3, paragraphs in such tables are also returned. - */ + * Gets the collection of paragraph objects in the content control. + * + * @remarks + * [Api set: WordApi 1.1] + * + * Important: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this content control aren't returned. From requirement set 1.3, paragraphs in such tables are also returned. + */ paragraphs?: Word.Interfaces.ParagraphData[]; /** - * Gets the collection of table objects in the content control. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the collection of table objects in the content control. + * + * @remarks + * [Api set: WordApi 1.3] + */ tables?: Word.Interfaces.TableData[]; /** * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. @@ -113835,11 +114110,11 @@ declare namespace Word { /** An interface describing the data returned by calling `listLevel.toJSON()`. */ interface ListLevelData { /** - * Gets a Font object that represents the character formatting of the specified object. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ + * Gets a Font object that represents the character formatting of the specified object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ font?: Word.Interfaces.FontData; /** * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. @@ -113919,11 +114194,11 @@ declare namespace Word { /** An interface describing the data returned by calling `listTemplate.toJSON()`. */ interface ListTemplateData { /** - * Gets a ListLevels collection that represents all the levels for the specified ListTemplate. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ + * Gets a ListLevels collection that represents all the levels for the specified ListTemplate. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ listLevels?: Word.Interfaces.ListLevelData[]; /** * Specifies whether the specified ListTemplate object is outline numbered. @@ -113936,18 +114211,18 @@ declare namespace Word { /** An interface describing the data returned by calling `noteItem.toJSON()`. */ interface NoteItemData { /** - * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. + * + * @remarks + * [Api set: WordApi 1.5] + */ body?: Word.Interfaces.BodyData; /** - * Represents a footnote or endnote reference in the main document. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * Represents a footnote or endnote reference in the main document. + * + * @remarks + * [Api set: WordApi 1.5] + */ reference?: Word.Interfaces.RangeData; /** * Represents the note item type: footnote or endnote. @@ -114020,32 +114295,32 @@ declare namespace Word { /** An interface describing the data returned by calling `paragraph.toJSON()`. */ interface ParagraphData { /** - * Gets the collection of fields in the paragraph. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the collection of fields in the paragraph. + * + * @remarks + * [Api set: WordApi 1.4] + */ fields?: Word.Interfaces.FieldData[]; /** - * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ font?: Word.Interfaces.FontData; /** - * Gets the collection of InlinePicture objects in the paragraph. The collection doesn't include floating images. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the collection of InlinePicture objects in the paragraph. The collection doesn't include floating images. + * + * @remarks + * [Api set: WordApi 1.1] + */ inlinePictures?: Word.Interfaces.InlinePictureData[]; /** - * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. + * + * @remarks + * [Api set: WordApi 1.3] + */ listItem?: Word.Interfaces.ListItemData; /** * 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}. @@ -114418,11 +114693,11 @@ declare namespace Word { /** An interface describing the data returned by calling `section.toJSON()`. */ interface SectionData { /** - * Gets the body object of the section. This doesn't include the header/footer and other section metadata. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the body object of the section. This doesn't include the header/footer and other section metadata. + * + * @remarks + * [Api set: WordApi 1.1] + */ body?: Word.Interfaces.BodyData; } /** An interface describing the data returned by calling `sectionCollection.toJSON()`. */ @@ -114457,46 +114732,46 @@ declare namespace Word { /** An interface describing the data returned by calling `style.toJSON()`. */ interface StyleData { /** - * Specifies a BorderCollection object that represents all the borders for the specified style. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ + * Specifies a BorderCollection object that represents all the borders for the specified style. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ borders?: Word.Interfaces.BorderData[]; /** - * Gets a font object that represents the character formatting of the specified style. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * Gets a font object that represents the character formatting of the specified style. + * + * @remarks + * [Api set: WordApi 1.5] + */ font?: Word.Interfaces.FontData; /** - * Gets a ListTemplate object that represents the list formatting for the specified Style object. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ + * Gets a ListTemplate object that represents the list formatting for the specified Style object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ listTemplate?: Word.Interfaces.ListTemplateData; /** - * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. + * + * @remarks + * [Api set: WordApi 1.5] + */ paragraphFormat?: Word.Interfaces.ParagraphFormatData; /** - * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. - * - * @remarks - * [Api set: WordApi 1.6] - */ + * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. + * + * @remarks + * [Api set: WordApi 1.6] + */ shading?: Word.Interfaces.ShadingData; /** - * Gets a TableStyle object representing Style properties that can be applied to a table. - * - * @remarks - * [Api set: WordApi 1.6] - */ + * Gets a TableStyle object representing Style properties that can be applied to a table. + * + * @remarks + * [Api set: WordApi 1.6] + */ tableStyle?: Word.Interfaces.TableStyleData; /** * Specifies the name of an existing style to use as the base formatting of another style. @@ -114615,32 +114890,32 @@ declare namespace Word { /** An interface describing the data returned by calling `table.toJSON()`. */ interface TableData { /** - * Gets the collection of field objects in the table. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the collection of field objects in the table. + * + * @remarks + * [Api set: WordApi 1.4] + */ fields?: Word.Interfaces.FieldData[]; /** - * Gets the font. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the font. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.3] + */ font?: Word.Interfaces.FontData; /** - * Gets all of the table rows. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets all of the table rows. + * + * @remarks + * [Api set: WordApi 1.3] + */ rows?: Word.Interfaces.TableRowData[]; /** - * Gets the child tables nested one level deeper. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the child tables nested one level deeper. + * + * @remarks + * [Api set: WordApi 1.3] + */ tables?: Word.Interfaces.TableData[]; /** * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. @@ -114905,11 +115180,11 @@ declare namespace Word { /** An interface describing the data returned by calling `tableCell.toJSON()`. */ interface TableCellData { /** - * Gets the body object of the cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the body object of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ body?: Word.Interfaces.BodyData; /** * Gets the index of the cell in its row. @@ -115096,6 +115371,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ allowOverlap?: boolean; + /** + * Specifies a string that represents the alternative text associated with the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + altTextDescription?: string; /** * The geometric shape type of the shape. It will be null if isn't a geometric shape. * @@ -115110,6 +115392,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ height?: number; + /** + * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + heightRelative?: number; /** * Gets an integer that represents the shape identifier. * @@ -115131,6 +115420,20 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ left?: number; + /** + * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + leftRelative?: number; + /** + * Specifies if the aspect ratio of this shape is locked. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + lockAspectRatio?: boolean; /** * The name of the shape. * @@ -115145,6 +115448,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + /** + * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. * @@ -115152,6 +115462,20 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + /** + * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + relativeVerticalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + /** + * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + rotation?: number; /** * The distance, in points, from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * @@ -115159,6 +115483,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ top?: number; + /** + * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + topRelative?: number; /** * Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * @@ -115166,6 +115497,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ type?: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas"; + /** + * Specifies if the shape is visible. Not applicable to inline shapes. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + visible?: boolean; /** * The width, in points, of the shape. * @@ -115173,6 +115511,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ width?: number; + /** + * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + widthRelative?: number; } /** An interface describing the data returned by calling `shapeGroup.toJSON()`. */ interface ShapeGroupData { @@ -115387,11 +115732,11 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the range of text that is annotated. - * - * @remarks - * [Api set: WordApi 1.7] - */ + * Gets the range of text that is annotated. + * + * @remarks + * [Api set: WordApi 1.7] + */ range?: Word.Interfaces.RangeLoadOptions; /** * Gets the critique that was passed when the annotation was inserted. @@ -115413,11 +115758,11 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the critique annotation object. - * - * @remarks - * [Api set: WordApi 1.7] - */ + * Gets the critique annotation object. + * + * @remarks + * [Api set: WordApi 1.7] + */ critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions; /** * Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. @@ -115446,11 +115791,11 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the critique annotation object. - * - * @remarks - * [Api set: WordApi 1.7] - */ + * For EACH ITEM in the collection: Gets the critique annotation object. + * + * @remarks + * [Api set: WordApi 1.7] + */ critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions; /** * For EACH ITEM in the collection: Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. @@ -115479,53 +115824,53 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ font?: Word.Interfaces.FontLoadOptions; /** - * 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. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * 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. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentBody?: Word.Interfaces.BodyLoadOptions; /** - * 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}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * 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}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentBodyOrNullObject?: Word.Interfaces.BodyLoadOptions; /** - * Gets the content control that contains the body. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the content control that contains the body. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * 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}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * 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}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the parent section of the body. Throws an `ItemNotFound` error if there isn't a parent section. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the parent section of the body. Throws an `ItemNotFound` error if there isn't a parent section. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentSection?: Word.Interfaces.SectionLoadOptions; /** - * 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}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * 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}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentSectionOrNullObject?: Word.Interfaces.SectionLoadOptions; /** * 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. @@ -115681,11 +116026,11 @@ declare namespace Word { */ $all?: boolean; /** - * Specifies the comment's content range. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Specifies the comment's content range. + * + * @remarks + * [Api set: WordApi 1.4] + */ contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; /** * Gets the email of the comment's author. @@ -115742,11 +116087,11 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Specifies the comment's content range. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * For EACH ITEM in the collection: Specifies the comment's content range. + * + * @remarks + * [Api set: WordApi 1.4] + */ contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; /** * For EACH ITEM in the collection: Gets the email of the comment's author. @@ -115862,18 +116207,18 @@ declare namespace Word { */ $all?: boolean; /** - * Specifies the commentReply's content range. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Specifies the commentReply's content range. + * + * @remarks + * [Api set: WordApi 1.4] + */ contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; /** - * Gets the parent comment of this reply. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the parent comment of this reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentComment?: Word.Interfaces.CommentLoadOptions; /** * Gets the email of the comment reply's author. @@ -115923,18 +116268,18 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Specifies the commentReply's content range. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * For EACH ITEM in the collection: Specifies the commentReply's content range. + * + * @remarks + * [Api set: WordApi 1.4] + */ contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent comment of this reply. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * For EACH ITEM in the collection: Gets the parent comment of this reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentComment?: Word.Interfaces.CommentLoadOptions; /** * For EACH ITEM in the collection: Gets the email of the comment reply's author. @@ -115984,67 +116329,67 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the data of the content control when its type is 'CheckBox'. It's `null` otherwise. - * - * @remarks - * [Api set: WordApi 1.7] - */ + * Gets the data of the content control when its type is 'CheckBox'. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi 1.7] + */ checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions; /** - * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ font?: Word.Interfaces.FontLoadOptions; /** - * Gets the parent body of the content control. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the parent body of the content control. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Gets the content control that contains the content control. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the content control that contains the content control. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the content control that contains the content control. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the content control that contains the content control. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the table cell that contains the content control. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table cell that contains the content control. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the table that contains the content control. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table that contains the content control. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. @@ -116157,67 +116502,67 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the data of the content control when its type is 'CheckBox'. It's `null` otherwise. - * - * @remarks - * [Api set: WordApi 1.7] - */ + * For EACH ITEM in the collection: Gets the data of the content control when its type is 'CheckBox'. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi 1.7] + */ checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * For EACH ITEM in the collection: Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ font?: Word.Interfaces.FontLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent body of the content control. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the parent body of the content control. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentBody?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the content control. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * For EACH ITEM in the collection: Gets the content control that contains the content control. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the content control. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the content control that contains the content control. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the content control. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table cell that contains the content control. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains the content control. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table that contains the content control. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** * For EACH ITEM in the collection: Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. @@ -116540,18 +116885,18 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * + * @remarks + * [Api set: WordApi 1.1] + */ body?: Word.Interfaces.BodyLoadOptions; /** - * Gets the properties of the document. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the properties of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ properties?: Word.Interfaces.DocumentPropertiesLoadOptions; /** * Specifies the ChangeTracking mode. @@ -116580,18 +116925,18 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ + * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ body?: Word.Interfaces.BodyLoadOptions; /** - * Gets the properties of the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ + * Gets the properties of the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ properties?: Word.Interfaces.DocumentPropertiesLoadOptions; /** * 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. @@ -116750,60 +117095,60 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the parent body of the field. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the parent body of the field. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Gets the content control that contains the field. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the content control that contains the field. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * 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}. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * 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}. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * 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}. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * 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}. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * 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}. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * 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}. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Gets the field's result data. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the field's result data. + * + * @remarks + * [Api set: WordApi 1.4] + */ result?: Word.Interfaces.RangeLoadOptions; /** * Specifies the field's code instruction. @@ -116868,60 +117213,60 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the parent body of the field. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * For EACH ITEM in the collection: Gets the parent body of the field. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentBody?: Word.Interfaces.BodyLoadOptions; /** - * 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. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * 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. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * 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}. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * 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}. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * 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. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * 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. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * 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. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * 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. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * 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}. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * 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}. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * 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}. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * 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}. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the field's result data. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * For EACH ITEM in the collection: Gets the field's result data. + * + * @remarks + * [Api set: WordApi 1.4] + */ result?: Word.Interfaces.RangeLoadOptions; /** * For EACH ITEM in the collection: Specifies the field's code instruction. @@ -117077,53 +117422,53 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the parent paragraph that contains the inline image. - * - * @remarks - * [Api set: WordApi 1.2] - */ + * Gets the parent paragraph that contains the inline image. + * + * @remarks + * [Api set: WordApi 1.2] + */ paragraph?: Word.Interfaces.ParagraphLoadOptions; /** - * Gets the content control that contains the inline image. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the content control that contains the inline image. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the content control that contains the inline image. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the content control that contains the inline image. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the table cell that contains the inline image. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table cell that contains the inline image. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the table that contains the inline image. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table that contains the inline image. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** * Specifies a string that represents the alternative text associated with the inline image. @@ -117187,53 +117532,53 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the parent paragraph that contains the inline image. - * - * @remarks - * [Api set: WordApi 1.2] - */ + * For EACH ITEM in the collection: Gets the parent paragraph that contains the inline image. + * + * @remarks + * [Api set: WordApi 1.2] + */ paragraph?: Word.Interfaces.ParagraphLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the inline image. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * For EACH ITEM in the collection: Gets the content control that contains the inline image. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the inline image. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the content control that contains the inline image. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the inline image. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table cell that contains the inline image. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains the inline image. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table that contains the inline image. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** * For EACH ITEM in the collection: Specifies a string that represents the alternative text associated with the inline image. @@ -117396,11 +117741,11 @@ declare namespace Word { */ $all?: boolean; /** - * Gets a Font object that represents the character formatting of the specified object. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ + * Gets a Font object that represents the character formatting of the specified object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ font?: Word.Interfaces.FontLoadOptions; /** * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. @@ -117485,11 +117830,11 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets a Font object that represents the character formatting of the specified object. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ + * For EACH ITEM in the collection: Gets a Font object that represents the character formatting of the specified object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ font?: Word.Interfaces.FontLoadOptions; /** * For EACH ITEM in the collection: Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. @@ -117593,18 +117938,18 @@ declare namespace Word { */ $all?: boolean; /** - * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. + * + * @remarks + * [Api set: WordApi 1.5] + */ body?: Word.Interfaces.BodyLoadOptions; /** - * Represents a footnote or endnote reference in the main document. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * Represents a footnote or endnote reference in the main document. + * + * @remarks + * [Api set: WordApi 1.5] + */ reference?: Word.Interfaces.RangeLoadOptions; /** * Represents the note item type: footnote or endnote. @@ -117626,18 +117971,18 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Represents the body object of the note item. It's the portion of the text within the footnote or endnote. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * For EACH ITEM in the collection: Represents the body object of the note item. It's the portion of the text within the footnote or endnote. + * + * @remarks + * [Api set: WordApi 1.5] + */ body?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Represents a footnote or endnote reference in the main document. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * For EACH ITEM in the collection: Represents a footnote or endnote reference in the main document. + * + * @remarks + * [Api set: WordApi 1.5] + */ reference?: Word.Interfaces.RangeLoadOptions; /** * For EACH ITEM in the collection: Represents the note item type: footnote or endnote. @@ -117725,88 +118070,88 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ font?: Word.Interfaces.FontLoadOptions; /** - * Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list. + * + * @remarks + * [Api set: WordApi 1.3] + */ list?: Word.Interfaces.ListLoadOptions; /** - * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. + * + * @remarks + * [Api set: WordApi 1.3] + */ listItem?: Word.Interfaces.ListItemLoadOptions; /** - * 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}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * 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}. + * + * @remarks + * [Api set: WordApi 1.3] + */ listItemOrNullObject?: Word.Interfaces.ListItemLoadOptions; /** - * 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}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * 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}. + * + * @remarks + * [Api set: WordApi 1.3] + */ listOrNullObject?: Word.Interfaces.ListLoadOptions; /** - * Gets the parent body of the paragraph. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the parent body of the paragraph. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Gets the content control that contains the paragraph. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the content control that contains the paragraph. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * 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}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * 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}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * 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}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * 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}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * 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}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * 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}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. @@ -117940,88 +118285,88 @@ declare namespace Word { */ $all?: boolean; /** - * 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. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * 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. + * + * @remarks + * [Api set: WordApi 1.1] + */ font?: Word.Interfaces.FontLoadOptions; /** - * 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. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * 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. + * + * @remarks + * [Api set: WordApi 1.3] + */ list?: Word.Interfaces.ListLoadOptions; /** - * 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. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * 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. + * + * @remarks + * [Api set: WordApi 1.3] + */ listItem?: Word.Interfaces.ListItemLoadOptions; /** - * 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}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * 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}. + * + * @remarks + * [Api set: WordApi 1.3] + */ listItemOrNullObject?: Word.Interfaces.ListItemLoadOptions; /** - * 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}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * 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}. + * + * @remarks + * [Api set: WordApi 1.3] + */ listOrNullObject?: Word.Interfaces.ListLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent body of the paragraph. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the parent body of the paragraph. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentBody?: Word.Interfaces.BodyLoadOptions; /** - * 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. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * 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. + * + * @remarks + * [Api set: WordApi 1.1] + */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * 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}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * 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}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * 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. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * 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. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * 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. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * 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. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * 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}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * 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}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * 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}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * 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}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** * For EACH ITEM in the collection: Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. @@ -118265,60 +118610,60 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ font?: Word.Interfaces.FontLoadOptions; /** - * Gets the parent body of the range. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the parent body of the range. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the currently supported content control that contains the range. 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}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the currently supported content control that contains the range. 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}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the table cell that contains the range. 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}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table cell that contains the range. 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}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the table that contains the range. 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}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table that contains the range. 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}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** * 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. @@ -118533,11 +118878,11 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the body object of the section. This doesn't include the header/footer and other section metadata. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the body object of the section. This doesn't include the header/footer and other section metadata. + * + * @remarks + * [Api set: WordApi 1.1] + */ body?: Word.Interfaces.BodyLoadOptions; } /** @@ -118552,11 +118897,11 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the body object of the section. This doesn't include the header/footer and other section metadata. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * For EACH ITEM in the collection: Gets the body object of the section. This doesn't include the header/footer and other section metadata. + * + * @remarks + * [Api set: WordApi 1.1] + */ body?: Word.Interfaces.BodyLoadOptions; } /** @@ -118623,46 +118968,46 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Specifies a BorderCollection object that represents all the borders for the specified style. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ + * For EACH ITEM in the collection: Specifies a BorderCollection object that represents all the borders for the specified style. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ borders?: Word.Interfaces.BorderCollectionLoadOptions; /** - * For EACH ITEM in the collection: Gets a font object that represents the character formatting of the specified style. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * For EACH ITEM in the collection: Gets a font object that represents the character formatting of the specified style. + * + * @remarks + * [Api set: WordApi 1.5] + */ font?: Word.Interfaces.FontLoadOptions; /** - * For EACH ITEM in the collection: Gets a ListTemplate object that represents the list formatting for the specified Style object. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ + * For EACH ITEM in the collection: Gets a ListTemplate object that represents the list formatting for the specified Style object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ listTemplate?: Word.Interfaces.ListTemplateLoadOptions; /** - * For EACH ITEM in the collection: Gets a ParagraphFormat object that represents the paragraph settings for the specified style. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * For EACH ITEM in the collection: Gets a ParagraphFormat object that represents the paragraph settings for the specified style. + * + * @remarks + * [Api set: WordApi 1.5] + */ paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions; /** - * For EACH ITEM in the collection: Gets a Shading object that represents the shading for the specified style. Not applicable to List style. - * - * @remarks - * [Api set: WordApi 1.6] - */ + * For EACH ITEM in the collection: Gets a Shading object that represents the shading for the specified style. Not applicable to List style. + * + * @remarks + * [Api set: WordApi 1.6] + */ shading?: Word.Interfaces.ShadingLoadOptions; /** - * For EACH ITEM in the collection: Gets a TableStyle object representing Style properties that can be applied to a table. - * - * @remarks - * [Api set: WordApi 1.6] - */ + * For EACH ITEM in the collection: Gets a TableStyle object representing Style properties that can be applied to a table. + * + * @remarks + * [Api set: WordApi 1.6] + */ tableStyle?: Word.Interfaces.TableStyleLoadOptions; /** * For EACH ITEM in the collection: Specifies the name of an existing style to use as the base formatting of another style. @@ -118766,46 +119111,46 @@ declare namespace Word { */ $all?: boolean; /** - * Specifies a BorderCollection object that represents all the borders for the specified style. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ + * Specifies a BorderCollection object that represents all the borders for the specified style. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ borders?: Word.Interfaces.BorderCollectionLoadOptions; /** - * Gets a font object that represents the character formatting of the specified style. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * Gets a font object that represents the character formatting of the specified style. + * + * @remarks + * [Api set: WordApi 1.5] + */ font?: Word.Interfaces.FontLoadOptions; /** - * Gets a ListTemplate object that represents the list formatting for the specified Style object. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ + * Gets a ListTemplate object that represents the list formatting for the specified Style object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ listTemplate?: Word.Interfaces.ListTemplateLoadOptions; /** - * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. + * + * @remarks + * [Api set: WordApi 1.5] + */ paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions; /** - * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. - * - * @remarks - * [Api set: WordApi 1.6] - */ + * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. + * + * @remarks + * [Api set: WordApi 1.6] + */ shading?: Word.Interfaces.ShadingLoadOptions; /** - * Gets a TableStyle object representing Style properties that can be applied to a table. - * - * @remarks - * [Api set: WordApi 1.6] - */ + * Gets a TableStyle object representing Style properties that can be applied to a table. + * + * @remarks + * [Api set: WordApi 1.6] + */ tableStyle?: Word.Interfaces.TableStyleLoadOptions; /** * Specifies the name of an existing style to use as the base formatting of another style. @@ -118942,60 +119287,60 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the font. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the font. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.3] + */ font?: Word.Interfaces.FontLoadOptions; /** - * Gets the parent body of the table. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the parent body of the table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the content control that contains the table. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the content control that contains the table. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the table cell that contains this table. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table cell that contains this table. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the table that contains this table. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table that contains this table. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. @@ -119190,60 +119535,60 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the font. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the font. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.3] + */ font?: Word.Interfaces.FontLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent body of the table. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the parent body of the table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentBody?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the table. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the content control that contains the table. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains this table. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table cell that contains this table. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains this table. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table that contains this table. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** * For EACH ITEM in the collection: Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. @@ -119377,18 +119722,18 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the font. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the font. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.3] + */ font?: Word.Interfaces.FontLoadOptions; /** - * Gets parent table. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets parent table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** * Gets the number of cells in the row. @@ -119459,18 +119804,18 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the font. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the font. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.3] + */ font?: Word.Interfaces.FontLoadOptions; /** - * For EACH ITEM in the collection: Gets parent table. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets parent table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** * For EACH ITEM in the collection: Gets the number of cells in the row. @@ -119541,25 +119886,25 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the body object of the cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the body object of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ body?: Word.Interfaces.BodyLoadOptions; /** - * Gets the parent row of the cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the parent row of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentRow?: Word.Interfaces.TableRowLoadOptions; /** - * Gets the parent table of the cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the parent table of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** * Gets the index of the cell in its row. @@ -119630,25 +119975,25 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the body object of the cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the body object of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ body?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent row of the cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the parent row of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentRow?: Word.Interfaces.TableRowLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent table of the cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the parent table of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** * For EACH ITEM in the collection: Gets the index of the cell in its row. @@ -119894,6 +120239,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ allowOverlap?: boolean; + /** + * Specifies a string that represents the alternative text associated with the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + altTextDescription?: boolean; /** * The geometric shape type of the shape. It will be null if isn't a geometric shape. * @@ -119908,6 +120260,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ height?: boolean; + /** + * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + heightRelative?: boolean; /** * Gets an integer that represents the shape identifier. * @@ -119929,6 +120288,20 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ left?: boolean; + /** + * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + leftRelative?: boolean; + /** + * Specifies if the aspect ratio of this shape is locked. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + lockAspectRatio?: boolean; /** * The name of the shape. * @@ -119943,6 +120316,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ relativeHorizontalPosition?: boolean; + /** + * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + relativeHorizontalSize?: boolean; /** * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. * @@ -119950,6 +120330,20 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ relativeVerticalPosition?: boolean; + /** + * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + relativeVerticalSize?: boolean; + /** + * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + rotation?: boolean; /** * The distance, in points, from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * @@ -119957,6 +120351,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ top?: boolean; + /** + * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + topRelative?: boolean; /** * Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * @@ -119964,6 +120365,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ type?: boolean; + /** + * Specifies if the shape is visible. Not applicable to inline shapes. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + visible?: boolean; /** * The width, in points, of the shape. * @@ -119971,6 +120379,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ width?: boolean; + /** + * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + widthRelative?: boolean; } /** * Represents a shape group in the document. To get the corresponding Shape object, use ShapeGroup.shape. @@ -120098,6 +120513,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ allowOverlap?: boolean; + /** + * For EACH ITEM in the collection: Specifies a string that represents the alternative text associated with the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + altTextDescription?: boolean; /** * For EACH ITEM in the collection: The geometric shape type of the shape. It will be null if isn't a geometric shape. * @@ -120112,6 +120534,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ height?: boolean; + /** + * For EACH ITEM in the collection: The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + heightRelative?: boolean; /** * For EACH ITEM in the collection: Gets an integer that represents the shape identifier. * @@ -120133,6 +120562,20 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ left?: boolean; + /** + * For EACH ITEM in the collection: The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + leftRelative?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the aspect ratio of this shape is locked. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + lockAspectRatio?: boolean; /** * For EACH ITEM in the collection: The name of the shape. * @@ -120147,6 +120590,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ relativeHorizontalPosition?: boolean; + /** + * For EACH ITEM in the collection: The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + relativeHorizontalSize?: boolean; /** * For EACH ITEM in the collection: The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. * @@ -120154,6 +120604,20 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ relativeVerticalPosition?: boolean; + /** + * For EACH ITEM in the collection: The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + relativeVerticalSize?: boolean; + /** + * For EACH ITEM in the collection: Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + rotation?: boolean; /** * For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * @@ -120161,6 +120625,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ top?: boolean; + /** + * For EACH ITEM in the collection: The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + topRelative?: boolean; /** * For EACH ITEM in the collection: Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * @@ -120168,6 +120639,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ type?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the shape is visible. Not applicable to inline shapes. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + visible?: boolean; /** * For EACH ITEM in the collection: The width, in points, of the shape. * @@ -120175,6 +120653,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ width?: boolean; + /** + * For EACH ITEM in the collection: The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + widthRelative?: boolean; } /** * Represents the fill formatting of a shape object. @@ -131376,9 +131861,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.PlaceholderFormat; /** - * 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's passed to it.) - * Whereas the original `PowerPoint.PlaceholderFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.PlaceholderFormatData`) that contains shallow copies of any loaded child properties from the original object. - */ + * 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's passed to it.) + * Whereas the original `PowerPoint.PlaceholderFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.PlaceholderFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.PlaceholderFormatData; } /** @@ -134287,9 +134772,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.ShapeGroup; /** - * 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's passed to it.) - * Whereas the original `PowerPoint.ShapeGroup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeGroupData`) that contains shallow copies of any loaded child properties from the original object. - */ + * 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's passed to it.) + * Whereas the original `PowerPoint.ShapeGroup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeGroupData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.ShapeGroupData; } /** diff --git a/types/office-js/index.d.ts b/types/office-js/index.d.ts index 7e23cff1370345..32372ec1b8f791 100644 --- a/types/office-js/index.d.ts +++ b/types/office-js/index.d.ts @@ -96415,7 +96415,7 @@ declare namespace Word { toJSON(): Word.Interfaces.TrackedChangeCollectionData; } /** - * Represents a shape in the header, footer or document body. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures and canvases. + * Represents a shape in the header, footer, or document body. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -96571,7 +96571,7 @@ declare namespace Word { */ relativeHorizontalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * The relative vertical position of the shape. For an inline shape, it can't be set. For details, See {@link Word.RelativeVerticalPosition}. + * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -96592,7 +96592,7 @@ declare namespace Word { */ rotation: number; /** - * The distance, in points, from the top edge of the shape to the vertical relative position, See {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * The distance, in points, from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -96829,9 +96829,9 @@ declare namespace Word { */ untrack(): Word.ShapeGroup; /** - * 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's passed to it.) - * Whereas the original `Word.ShapeGroup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeGroupData`) that contains shallow copies of any loaded child properties from the original object. - */ + * 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's passed to it.) + * Whereas the original `Word.ShapeGroup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeGroupData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ShapeGroupData; } /** @@ -96908,7 +96908,7 @@ declare namespace Word { toJSON(): Word.Interfaces.CanvasData; } /** - * Contains a collection of {@link Word.Shape} objects. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures and canvases. + * Contains a collection of {@link Word.Shape} objects. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -104336,7 +104336,7 @@ declare namespace Word { */ relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * The relative vertical position of the shape. For an inline shape, it can't be set. For details, See {@link Word.RelativeVerticalPosition}. + * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -104357,7 +104357,7 @@ declare namespace Word { */ rotation?: number; /** - * The distance, in points, from the top edge of the shape to the vertical relative position, See {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * The distance, in points, from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -104395,11 +104395,11 @@ declare namespace Word { /** An interface for updating data on the `ShapeGroup` object, for use in `shapeGroup.set({ ... })`. */ interface ShapeGroupUpdateData { /** - * Gets the Shape object associated with the group. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the Shape object associated with the group. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ shape?: Word.Interfaces.ShapeUpdateData; } /** An interface for updating data on the `Canvas` object, for use in `canvas.set({ ... })`. */ @@ -105888,7 +105888,7 @@ declare namespace Word { */ listItemOrNullObject?: Word.Interfaces.ListItemData; /** - * Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures and canvases. + * Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -107006,7 +107006,7 @@ declare namespace Word { */ relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * The relative vertical position of the shape. For an inline shape, it can't be set. For details, See {@link Word.RelativeVerticalPosition}. + * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -107027,7 +107027,7 @@ declare namespace Word { */ rotation?: number; /** - * The distance, in points, from the top edge of the shape to the vertical relative position, See {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * The distance, in points, from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -107072,18 +107072,18 @@ declare namespace Word { /** An interface describing the data returned by calling `shapeGroup.toJSON()`. */ interface ShapeGroupData { /** - * Gets the Shape object associated with the group. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the Shape object associated with the group. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ shape?: Word.Interfaces.ShapeData; /** - * Gets the collection of Shape objects. Currently, only text boxes, geometric shapes, and pictures are supported. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the collection of Shape objects. Currently, only text boxes, geometric shapes, and pictures are supported. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ shapes?: Word.Interfaces.ShapeData[]; /** * Gets an integer that represents the shape group identifier. @@ -107096,18 +107096,18 @@ declare namespace Word { /** An interface describing the data returned by calling `canvas.toJSON()`. */ interface CanvasData { /** - * Gets the Shape object associated with the canvas. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the Shape object associated with the canvas. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ shape?: Word.Interfaces.ShapeData; /** - * Gets the collection of Shape objects. Currently, only text boxes, pictures, and geometric shapes are supported. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the collection of Shape objects. Currently, only text boxes, pictures, and geometric shapes are supported. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ shapes?: Word.Interfaces.ShapeData[]; /** * Gets an integer that represents the canvas identifier. @@ -111692,7 +111692,7 @@ declare namespace Word { type?: boolean; } /** - * Represents a shape in the header, footer or document body. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures and canvases. + * Represents a shape in the header, footer, or document body. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -111759,11 +111759,11 @@ declare namespace Word { */ textWrap?: Word.Interfaces.ShapeTextWrapLoadOptions; /** - * Specifies whether a given shape can overlap other shapes. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Specifies whether a given shape can overlap other shapes. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ allowOverlap?: boolean; /** * Specifies a string that represents the alternative text associated with the shape. @@ -111850,7 +111850,7 @@ declare namespace Word { */ relativeHorizontalSize?: boolean; /** - * The relative vertical position of the shape. For an inline shape, it can't be set. For details, See {@link Word.RelativeVerticalPosition}. + * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -111871,7 +111871,7 @@ declare namespace Word { */ rotation?: boolean; /** - * The distance, in points, from the top edge of the shape to the vertical relative position, See {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * The distance, in points, from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -112124,7 +112124,7 @@ declare namespace Word { */ relativeHorizontalSize?: boolean; /** - * For EACH ITEM in the collection: The relative vertical position of the shape. For an inline shape, it can't be set. For details, See {@link Word.RelativeVerticalPosition}. + * For EACH ITEM in the collection: The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -112145,7 +112145,7 @@ declare namespace Word { */ rotation?: boolean; /** - * For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the vertical relative position, See {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -124775,7 +124775,13 @@ declare namespace PowerPoint { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Specifies the bold status of font. Returns `null` if the `TextRange` contains both bold and non-bold text fragments. + * Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows: + * + * - `true`: All the text is bold. + * + * - `false`: None of the text is bold. + * + * - `null`: Returned if some, but not all, of the text is bold. * * @remarks * [Api set: PowerPointApi 1.4] @@ -124789,7 +124795,13 @@ declare namespace PowerPoint { */ color: string | null; /** - * Specifies the italic status of font. Returns 'null' if the 'TextRange' contains both italic and non-italic text fragments. + * Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows: + * + * - `true`: All the text is italicized. + * + * - `false`: None of the text is italicized. + * + * - `null`: Returned if some, but not all, of the text is italicized. * * @remarks * [Api set: PowerPointApi 1.4] @@ -126816,7 +126828,13 @@ declare namespace PowerPoint { /** An interface for updating data on the `ShapeFont` object, for use in `shapeFont.set({ ... })`. */ interface ShapeFontUpdateData { /** - * Specifies the bold status of font. Returns `null` if the `TextRange` contains both bold and non-bold text fragments. + * Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows: + * + * - `true`: All the text is bold. + * + * - `false`: None of the text is bold. + * + * - `null`: Returned if some, but not all, of the text is bold. * * @remarks * [Api set: PowerPointApi 1.4] @@ -126830,7 +126848,13 @@ declare namespace PowerPoint { */ color?: string | null; /** - * Specifies the italic status of font. Returns 'null' if the 'TextRange' contains both italic and non-italic text fragments. + * Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows: + * + * - `true`: All the text is italicized. + * + * - `false`: None of the text is italicized. + * + * - `null`: Returned if some, but not all, of the text is italicized. * * @remarks * [Api set: PowerPointApi 1.4] @@ -127242,7 +127266,13 @@ declare namespace PowerPoint { /** An interface describing the data returned by calling `shapeFont.toJSON()`. */ interface ShapeFontData { /** - * Specifies the bold status of font. Returns `null` if the `TextRange` contains both bold and non-bold text fragments. + * Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows: + * + * - `true`: All the text is bold. + * + * - `false`: None of the text is bold. + * + * - `null`: Returned if some, but not all, of the text is bold. * * @remarks * [Api set: PowerPointApi 1.4] @@ -127256,7 +127286,13 @@ declare namespace PowerPoint { */ color?: string | null; /** - * Specifies the italic status of font. Returns 'null' if the 'TextRange' contains both italic and non-italic text fragments. + * Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows: + * + * - `true`: All the text is italicized. + * + * - `false`: None of the text is italicized. + * + * - `null`: Returned if some, but not all, of the text is italicized. * * @remarks * [Api set: PowerPointApi 1.4] @@ -127886,7 +127922,13 @@ declare namespace PowerPoint { */ $all?: boolean; /** - * Specifies the bold status of font. Returns `null` if the `TextRange` contains both bold and non-bold text fragments. + * Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows: + * + * - `true`: All the text is bold. + * + * - `false`: None of the text is bold. + * + * - `null`: Returned if some, but not all, of the text is bold. * * @remarks * [Api set: PowerPointApi 1.4] @@ -127900,7 +127942,13 @@ declare namespace PowerPoint { */ color?: boolean; /** - * Specifies the italic status of font. Returns 'null' if the 'TextRange' contains both italic and non-italic text fragments. + * Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows: + * + * - `true`: All the text is italicized. + * + * - `false`: None of the text is italicized. + * + * - `null`: Returned if some, but not all, of the text is italicized. * * @remarks * [Api set: PowerPointApi 1.4] @@ -127940,25 +127988,25 @@ declare namespace PowerPoint { */ $all?: boolean; /** - * For EACH ITEM in the collection: Returns the fill formatting of this shape. - * - * @remarks - * [Api set: PowerPointApi 1.4] - */ + * For EACH ITEM in the collection: Returns the fill formatting of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ fill?: PowerPoint.Interfaces.ShapeFillLoadOptions; /** - * For EACH ITEM in the collection: Returns the line formatting of this shape. - * - * @remarks - * [Api set: PowerPointApi 1.4] - */ + * For EACH ITEM in the collection: Returns the line formatting of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions; /** - * For EACH ITEM in the collection: Returns the text frame object of this shape. - * - * @remarks - * [Api set: PowerPointApi 1.4] - */ + * For EACH ITEM in the collection: Returns the text frame object of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions; /** * For EACH ITEM in the collection: Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value. @@ -128185,25 +128233,25 @@ declare namespace PowerPoint { */ $all?: boolean; /** - * For EACH ITEM in the collection: Returns the fill formatting of this shape. - * - * @remarks - * [Api set: PowerPointApi 1.5] - */ + * For EACH ITEM in the collection: Returns the fill formatting of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ fill?: PowerPoint.Interfaces.ShapeFillLoadOptions; /** - * For EACH ITEM in the collection: Returns the line formatting of this shape. - * - * @remarks - * [Api set: PowerPointApi 1.5] - */ + * For EACH ITEM in the collection: Returns the line formatting of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions; /** - * For EACH ITEM in the collection: Returns the text frame object of this shape. - * - * @remarks - * [Api set: PowerPointApi 1.5] - */ + * For EACH ITEM in the collection: Returns the text frame object of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions; /** * For EACH ITEM in the collection: Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value. @@ -128490,25 +128538,25 @@ declare namespace PowerPoint { */ $all?: boolean; /** - * Returns the fill formatting of this shape. - * - * @remarks - * [Api set: PowerPointApi 1.4] - */ + * Returns the fill formatting of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ fill?: PowerPoint.Interfaces.ShapeFillLoadOptions; /** - * Returns the line formatting of this shape. - * - * @remarks - * [Api set: PowerPointApi 1.4] - */ + * Returns the line formatting of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions; /** - * Returns the text frame object of this shape. - * - * @remarks - * [Api set: PowerPointApi 1.4] - */ + * Returns the text frame object of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions; /** * Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.