From 1755f9568d54f09bebf2b6e3d207c2769a9fadb6 Mon Sep 17 00:00:00 2001 From: Alex Jerabek <38896772+AlexJerabek@users.noreply.github.com> Date: Fri, 10 Jan 2025 10:59:51 -0800 Subject: [PATCH] Update Word reference with the latest (#2174) --- docs/docs-ref-autogen/word/toc.yml | 12 + docs/docs-ref-autogen/word/word.yml | 12 + docs/docs-ref-autogen/word/word/word.body.yml | 22 +- .../word/word/word.bodytype.yml | 55 +- .../word/word/word.commenteventargs.yml | 12 +- .../word/word/word.contentcontrol.yml | 7 +- .../word.contentcontroladdedeventargs.yml | 14 +- .../word/word.contentcontrolcollection.yml | 2 +- ...ord.contentcontroldatachangedeventargs.yml | 14 +- .../word.contentcontroldeletedeventargs.yml | 14 +- .../word.contentcontrolenteredeventargs.yml | 14 +- .../word.contentcontrolexitedeventargs.yml | 14 +- ...ontentcontrolselectionchangedeventargs.yml | 14 +- .../word/word/word.document.yml | 4 +- .../word/word/word.documentcreated.yml | 4 +- .../word/word/word.eventtype.yml | 34 + .../word/word/word.inlinepicture.yml | 4 +- .../word/word/word.insertshapeoptions.yml | 59 + .../word/word/word.interfaces.bodydata.yml | 18 +- ...es.contentcontrolcollectionloadoptions.yml | 2 +- ...d.interfaces.contentcontrolloadoptions.yml | 3 +- .../word/word.interfaces.paragraphdata.yml | 14 + .../word/word/word.interfaces.rangedata.yml | 14 + .../word.interfaces.shapecollectiondata.yml | 23 + ....interfaces.shapecollectionloadoptions.yml | 143 + ...d.interfaces.shapecollectionupdatedata.yml | 23 + .../word/word/word.interfaces.shapedata.yml | 131 + .../word/word.interfaces.shapeloadoptions.yml | 137 + .../word/word.interfaces.shapeupdatedata.yml | 107 + .../word/word/word.paragraph.yml | 38 +- .../word/word.paragraphaddedeventargs.yml | 12 +- .../word/word.paragraphchangedeventargs.yml | 12 +- .../word/word.paragraphdeletedeventargs.yml | 12 +- .../docs-ref-autogen/word/word/word.range.yml | 40 +- .../word/word.relativehorizontalposition.yml | 76 + .../word/word.relativeverticalposition.yml | 76 + .../docs-ref-autogen/word/word/word.shape.yml | 340 ++ .../word/word/word.shapecollection.yml | 247 ++ .../word/word/word.shapetype.yml | 26 + docs/includes/word-preview.md | 31 +- generate-docs/API Coverage Report.csv | 73 +- .../api-extractor-inputs-word/word.d.ts | 3767 ++++++++++------- .../script-inputs/office_preview.d.ts | 3551 ++++++++++------ 43 files changed, 6329 insertions(+), 2898 deletions(-) create mode 100644 docs/docs-ref-autogen/word/word/word.insertshapeoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.shapecollectiondata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.shapecollectionloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.shapecollectionupdatedata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.shapedata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.shapeloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.shapeupdatedata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.relativehorizontalposition.yml create mode 100644 docs/docs-ref-autogen/word/word/word.relativeverticalposition.yml create mode 100644 docs/docs-ref-autogen/word/word/word.shape.yml create mode 100644 docs/docs-ref-autogen/word/word/word.shapecollection.yml create mode 100644 docs/docs-ref-autogen/word/word/word.shapetype.yml diff --git a/docs/docs-ref-autogen/word/toc.yml b/docs/docs-ref-autogen/word/toc.yml index c0b1a1d896..1eb3cd7f89 100644 --- a/docs/docs-ref-autogen/word/toc.yml +++ b/docs/docs-ref-autogen/word/toc.yml @@ -93,12 +93,18 @@ items: uid: 'word!Word.OutlineLevel:enum' - name: RangeLocation uid: 'word!Word.RangeLocation:enum' + - name: RelativeHorizontalPosition + uid: 'word!Word.RelativeHorizontalPosition:enum' + - name: RelativeVerticalPosition + uid: 'word!Word.RelativeVerticalPosition:enum' - name: SaveBehavior uid: 'word!Word.SaveBehavior:enum' - name: SelectionMode uid: 'word!Word.SelectionMode:enum' - name: ShadingTextureType uid: 'word!Word.ShadingTextureType:enum' + - name: ShapeType + uid: 'word!Word.ShapeType:enum' - name: StyleType uid: 'word!Word.StyleType:enum' - name: TrackedChangeType @@ -213,6 +219,8 @@ items: uid: 'word!Word.InlinePictureCollection:class' - name: InsertFileOptions uid: 'word!Word.InsertFileOptions:interface' + - name: InsertShapeOptions + uid: 'word!Word.InsertShapeOptions:interface' - name: List uid: 'word!Word.List:class' - name: ListCollection @@ -259,6 +267,10 @@ items: uid: 'word!Word.SettingCollection:class' - name: Shading uid: 'word!Word.Shading:class' + - name: Shape + uid: 'word!Word.Shape:class' + - name: ShapeCollection + uid: 'word!Word.ShapeCollection:class' - name: Style uid: 'word!Word.Style:class' - name: StyleCollection diff --git a/docs/docs-ref-autogen/word/word.yml b/docs/docs-ref-autogen/word/word.yml index b7fd9b0eb9..e0f6c0f57f 100644 --- a/docs/docs-ref-autogen/word/word.yml +++ b/docs/docs-ref-autogen/word/word.yml @@ -41,9 +41,12 @@ enums: - 'word!Word.NoteItemType:enum' - 'word!Word.OutlineLevel:enum' - 'word!Word.RangeLocation:enum' + - 'word!Word.RelativeHorizontalPosition:enum' + - 'word!Word.RelativeVerticalPosition:enum' - 'word!Word.SaveBehavior:enum' - 'word!Word.SelectionMode:enum' - 'word!Word.ShadingTextureType:enum' + - 'word!Word.ShapeType:enum' - 'word!Word.StyleType:enum' - 'word!Word.TrackedChangeType:enum' - 'word!Word.TrailingCharacter:enum' @@ -102,6 +105,8 @@ classes: - 'word!Word.Setting:class' - 'word!Word.SettingCollection:class' - 'word!Word.Shading:class' + - 'word!Word.Shape:class' + - 'word!Word.ShapeCollection:class' - 'word!Word.Style:class' - 'word!Word.StyleCollection:class' - 'word!Word.Table:class' @@ -135,6 +140,7 @@ interfaces: - 'word!Word.DocumentCompareOptions:interface' - 'word!Word.GetTextOptions:interface' - 'word!Word.InsertFileOptions:interface' + - 'word!Word.InsertShapeOptions:interface' - 'word!Word.Interfaces.AnnotationCollectionData:interface' - 'word!Word.Interfaces.AnnotationCollectionLoadOptions:interface' - 'word!Word.Interfaces.AnnotationCollectionUpdateData:interface' @@ -278,6 +284,12 @@ interfaces: - 'word!Word.Interfaces.ShadingData:interface' - 'word!Word.Interfaces.ShadingLoadOptions:interface' - 'word!Word.Interfaces.ShadingUpdateData:interface' + - 'word!Word.Interfaces.ShapeCollectionData:interface' + - 'word!Word.Interfaces.ShapeCollectionLoadOptions:interface' + - 'word!Word.Interfaces.ShapeCollectionUpdateData:interface' + - 'word!Word.Interfaces.ShapeData:interface' + - 'word!Word.Interfaces.ShapeLoadOptions:interface' + - 'word!Word.Interfaces.ShapeUpdateData:interface' - 'word!Word.Interfaces.StyleCollectionData:interface' - 'word!Word.Interfaces.StyleCollectionLoadOptions:interface' - 'word!Word.Interfaces.StyleCollectionUpdateData:interface' diff --git a/docs/docs-ref-autogen/word/word/word.body.yml b/docs/docs-ref-autogen/word/word/word.body.yml index e9327219c1..51bfdd2c6b 100644 --- a/docs/docs-ref-autogen/word/word/word.body.yml +++ b/docs/docs-ref-autogen/word/word/word.body.yml @@ -460,6 +460,20 @@ properties: content: 'readonly parentSectionOrNullObject: Word.Section;' return: type: '' + - name: shapes + uid: 'word!Word.Body#shapes:member' + package: word! + fullName: shapes + summary: >- + Gets the collection of shape objects in the body, including both inline and floating shapes. Currently, only + TextBox shapes are supported. + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'readonly shapes: Word.ShapeCollection;' + return: + type: '' - name: style uid: 'word!Word.Body#style:member' package: word! @@ -672,11 +686,11 @@ properties: syntax: content: >- readonly type: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" | - "Footnote" | "Endnote" | "NoteItem"; + "Footnote" | "Endnote" | "NoteItem" | "Shape"; return: type: >- | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" - | "Footnote" | "Endnote" | "NoteItem" + | "Footnote" | "Endnote" | "NoteItem" | "Shape" methods: - name: clear() uid: 'word!Word.Body#clear:member(1)' @@ -1098,8 +1112,8 @@ methods: \[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - 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. + 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. #### Examples diff --git a/docs/docs-ref-autogen/word/word/word.bodytype.yml b/docs/docs-ref-autogen/word/word/word.bodytype.yml index d598ce00ba..78509a693c 100644 --- a/docs/docs-ref-autogen/word/word/word.bodytype.yml +++ b/docs/docs-ref-autogen/word/word/word.bodytype.yml @@ -3,7 +3,7 @@ name: Word.BodyType uid: 'word!Word.BodyType:enum' package: word! fullName: Word.BodyType -summary: '' +summary: Represents the types of body objects. remarks: >- \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -42,45 +42,80 @@ fields: - name: endnote uid: 'word!Word.BodyType.endnote:member' package: word! - summary: '* \[ [API set: WordApi 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + summary: |- + Endnote body. + + * \[ [API set: WordApi 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] value: '"Endnote"' - name: footer uid: 'word!Word.BodyType.footer:member' package: word! - summary: '* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + summary: |- + Footer body. + + * \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] value: '"Footer"' - name: footnote uid: 'word!Word.BodyType.footnote:member' package: word! - summary: '* \[ [API set: WordApi 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + summary: |- + Footnote body. + + * \[ [API set: WordApi 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] value: '"Footnote"' - name: header uid: 'word!Word.BodyType.header:member' package: word! - summary: '* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + summary: |- + Header body. + + * \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] value: '"Header"' - name: mainDoc uid: 'word!Word.BodyType.mainDoc:member' package: word! - summary: '* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + summary: |- + Main document body. + + * \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] value: '"MainDoc"' - name: noteItem uid: 'word!Word.BodyType.noteItem:member' package: word! - summary: '* \[ [API set: WordApi 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + summary: |- + Note body e.g., endnote, footnote. + + * \[ [API set: WordApi 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] value: '"NoteItem"' - name: section uid: 'word!Word.BodyType.section:member' package: word! - summary: '* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + summary: |- + Section body. + + * \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] value: '"Section"' + - name: shape + uid: 'word!Word.BodyType.shape:member' + package: word! + summary: |- + Shape body. + + * \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Shape"' - name: tableCell uid: 'word!Word.BodyType.tableCell:member' package: word! - summary: '* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + summary: |- + Table cell body. + + * \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] value: '"TableCell"' - name: unknown uid: 'word!Word.BodyType.unknown:member' package: word! - summary: '* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + summary: |- + Unknown body type. + + * \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] value: '"Unknown"' diff --git a/docs/docs-ref-autogen/word/word/word.commenteventargs.yml b/docs/docs-ref-autogen/word/word/word.commenteventargs.yml index a75cef2239..0c852cd502 100644 --- a/docs/docs-ref-autogen/word/word/word.commenteventargs.yml +++ b/docs/docs-ref-autogen/word/word/word.commenteventargs.yml @@ -102,14 +102,16 @@ properties: syntax: content: >- type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" - | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | - "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | - "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | + | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" | + "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | + "ContentControlExited" | "DocumentWordCountChanged" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" + | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; return: type: >- | "ContentControlDeleted" | "ContentControlSelectionChanged" | - "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | - "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | + "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | + "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | + "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction" diff --git a/docs/docs-ref-autogen/word/word/word.contentcontrol.yml b/docs/docs-ref-autogen/word/word/word.contentcontrol.yml index 10fa8a9b25..9af297d4b1 100644 --- a/docs/docs-ref-autogen/word/word/word.contentcontrol.yml +++ b/docs/docs-ref-autogen/word/word/word.contentcontrol.yml @@ -6,7 +6,8 @@ fullName: Word.ContentControl summary: >- Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or - paragraphs of formatted text. Currently, only rich text, plain text, and checkbox content controls are supported. + paragraphs of formatted text. Currently, only rich text, plain text, checkbox, dropdown list, and combo box content + controls are supported. remarks: |- \[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -1196,8 +1197,8 @@ methods: \[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - 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. + 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. isPreview: false isDeprecated: false syntax: diff --git a/docs/docs-ref-autogen/word/word/word.contentcontroladdedeventargs.yml b/docs/docs-ref-autogen/word/word/word.contentcontroladdedeventargs.yml index f1c58b909d..6b5c2cb46e 100644 --- a/docs/docs-ref-autogen/word/word/word.contentcontroladdedeventargs.yml +++ b/docs/docs-ref-autogen/word/word/word.contentcontroladdedeventargs.yml @@ -52,15 +52,17 @@ properties: syntax: content: >- eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | - "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" - | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | - "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | - "AnnotationRemoved" | "AnnotationPopupAction"; + "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | + "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | + "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" | + "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | + "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; return: type: >- | "ContentControlDeleted" | "ContentControlSelectionChanged" | - "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | - "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | + "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | + "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | + "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction" - name: ids diff --git a/docs/docs-ref-autogen/word/word/word.contentcontrolcollection.yml b/docs/docs-ref-autogen/word/word/word.contentcontrolcollection.yml index 018942a2fa..4d514bacb7 100644 --- a/docs/docs-ref-autogen/word/word/word.contentcontrolcollection.yml +++ b/docs/docs-ref-autogen/word/word/word.contentcontrolcollection.yml @@ -7,7 +7,7 @@ summary: >- Contains a collection of [Word.ContentControl](xref:word!Word.ContentControl:class) objects. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, - only rich text and plain text content controls are supported. + only rich text, plain text, checkbox, dropdown list, and combo box content controls are supported. remarks: >- \[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] diff --git a/docs/docs-ref-autogen/word/word/word.contentcontroldatachangedeventargs.yml b/docs/docs-ref-autogen/word/word/word.contentcontroldatachangedeventargs.yml index 54965bfba8..c80d7a511b 100644 --- a/docs/docs-ref-autogen/word/word/word.contentcontroldatachangedeventargs.yml +++ b/docs/docs-ref-autogen/word/word/word.contentcontroldatachangedeventargs.yml @@ -63,15 +63,17 @@ properties: syntax: content: >- eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | - "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" - | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | - "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | - "AnnotationRemoved" | "AnnotationPopupAction"; + "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | + "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | + "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" | + "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | + "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; return: type: >- | "ContentControlDeleted" | "ContentControlSelectionChanged" | - "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | - "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | + "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | + "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | + "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction" - name: ids diff --git a/docs/docs-ref-autogen/word/word/word.contentcontroldeletedeventargs.yml b/docs/docs-ref-autogen/word/word/word.contentcontroldeletedeventargs.yml index 088591abd0..0d468d33fe 100644 --- a/docs/docs-ref-autogen/word/word/word.contentcontroldeletedeventargs.yml +++ b/docs/docs-ref-autogen/word/word/word.contentcontroldeletedeventargs.yml @@ -63,15 +63,17 @@ properties: syntax: content: >- eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | - "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" - | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | - "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | - "AnnotationRemoved" | "AnnotationPopupAction"; + "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | + "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | + "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" | + "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | + "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; return: type: >- | "ContentControlDeleted" | "ContentControlSelectionChanged" | - "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | - "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | + "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | + "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | + "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction" - name: ids diff --git a/docs/docs-ref-autogen/word/word/word.contentcontrolenteredeventargs.yml b/docs/docs-ref-autogen/word/word/word.contentcontrolenteredeventargs.yml index cee49ca178..488252768a 100644 --- a/docs/docs-ref-autogen/word/word/word.contentcontrolenteredeventargs.yml +++ b/docs/docs-ref-autogen/word/word/word.contentcontrolenteredeventargs.yml @@ -63,15 +63,17 @@ properties: syntax: content: >- eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | - "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" - | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | - "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | - "AnnotationRemoved" | "AnnotationPopupAction"; + "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | + "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | + "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" | + "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | + "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; return: type: >- | "ContentControlDeleted" | "ContentControlSelectionChanged" | - "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | - "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | + "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | + "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | + "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction" - name: ids diff --git a/docs/docs-ref-autogen/word/word/word.contentcontrolexitedeventargs.yml b/docs/docs-ref-autogen/word/word/word.contentcontrolexitedeventargs.yml index 7a0312fe66..2259748594 100644 --- a/docs/docs-ref-autogen/word/word/word.contentcontrolexitedeventargs.yml +++ b/docs/docs-ref-autogen/word/word/word.contentcontrolexitedeventargs.yml @@ -63,15 +63,17 @@ properties: syntax: content: >- eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | - "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" - | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | - "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | - "AnnotationRemoved" | "AnnotationPopupAction"; + "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | + "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | + "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" | + "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | + "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; return: type: >- | "ContentControlDeleted" | "ContentControlSelectionChanged" | - "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | - "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | + "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | + "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | + "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction" - name: ids diff --git a/docs/docs-ref-autogen/word/word/word.contentcontrolselectionchangedeventargs.yml b/docs/docs-ref-autogen/word/word/word.contentcontrolselectionchangedeventargs.yml index e49415be9c..cb294530ff 100644 --- a/docs/docs-ref-autogen/word/word/word.contentcontrolselectionchangedeventargs.yml +++ b/docs/docs-ref-autogen/word/word/word.contentcontrolselectionchangedeventargs.yml @@ -62,15 +62,17 @@ properties: syntax: content: >- eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | - "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" - | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | - "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | - "AnnotationRemoved" | "AnnotationPopupAction"; + "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | + "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | + "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" | + "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | + "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; return: type: >- | "ContentControlDeleted" | "ContentControlSelectionChanged" | - "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | - "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | + "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | + "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | + "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction" - name: ids diff --git a/docs/docs-ref-autogen/word/word/word.document.yml b/docs/docs-ref-autogen/word/word/word.document.yml index 19a39ec1c3..1124e2302c 100644 --- a/docs/docs-ref-autogen/word/word/word.document.yml +++ b/docs/docs-ref-autogen/word/word/word.document.yml @@ -841,8 +841,8 @@ methods: \[ [API set: WordApi 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - 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. + 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. #### Examples diff --git a/docs/docs-ref-autogen/word/word/word.documentcreated.yml b/docs/docs-ref-autogen/word/word/word.documentcreated.yml index 7a7a116dc2..f8687304b7 100644 --- a/docs/docs-ref-autogen/word/word/word.documentcreated.yml +++ b/docs/docs-ref-autogen/word/word/word.documentcreated.yml @@ -299,8 +299,8 @@ methods: \[ [API set: WordApiHiddenDocument 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - 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. + 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. isPreview: false isDeprecated: false syntax: diff --git a/docs/docs-ref-autogen/word/word/word.eventtype.yml b/docs/docs-ref-autogen/word/word/word.eventtype.yml index 8b0697f59c..f09e702c00 100644 --- a/docs/docs-ref-autogen/word/word/word.eventtype.yml +++ b/docs/docs-ref-autogen/word/word/word.eventtype.yml @@ -27,6 +27,22 @@ remarks: >- isPreview: false isDeprecated: false fields: + - name: annotationAdded + uid: 'word!Word.EventType.annotationAdded:member' + package: word! + summary: |- + AnnotationAdded represents the event an annotation has been added to the document. + + * \[ [API set: WordApiOnline 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"AnnotationAdded"' + - name: annotationChanged + uid: 'word!Word.EventType.annotationChanged:member' + package: word! + summary: |- + AnnotationChanged represents the event an annotation has been updated in the document. + + * \[ [API set: WordApiOnline 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"AnnotationChanged"' - name: annotationClicked uid: 'word!Word.EventType.annotationClicked:member' package: word! @@ -35,6 +51,14 @@ fields: * \[ [API set: WordApi 1.7](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] value: '"AnnotationClicked"' + - name: annotationDeleted + uid: 'word!Word.EventType.annotationDeleted:member' + package: word! + summary: |- + AnnotationDeleted represents the event an annotation has been deleted from the document. + + * \[ [API set: WordApiOnline 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"AnnotationDeleted"' - name: annotationHovered uid: 'word!Word.EventType.annotationHovered:member' package: word! @@ -155,6 +179,16 @@ fields: * \[ [API set: WordApi 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] value: '"ContentControlSelectionChanged"' + - name: documentWordCountChanged + uid: 'word!Word.EventType.documentWordCountChanged:member' + package: word! + summary: >- + Represents that a word count has been changed. + + + * \[ [API set: WordApi Unknown Version, this API may or may not work on a client. This API may not be released to + 3rd parties.](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"DocumentWordCountChanged"' - name: paragraphAdded uid: 'word!Word.EventType.paragraphAdded:member' package: word! diff --git a/docs/docs-ref-autogen/word/word/word.inlinepicture.yml b/docs/docs-ref-autogen/word/word/word.inlinepicture.yml index fc37b6d3ed..25aca7a6e8 100644 --- a/docs/docs-ref-autogen/word/word/word.inlinepicture.yml +++ b/docs/docs-ref-autogen/word/word/word.inlinepicture.yml @@ -471,8 +471,8 @@ methods: \[ [API set: WordApi 1.2](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - 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. + 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. isPreview: false isDeprecated: false syntax: diff --git a/docs/docs-ref-autogen/word/word/word.insertshapeoptions.yml b/docs/docs-ref-autogen/word/word/word.insertshapeoptions.yml new file mode 100644 index 0000000000..131177f45f --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.insertshapeoptions.yml @@ -0,0 +1,59 @@ +### YamlMime:TSType +name: Word.InsertShapeOptions +uid: 'word!Word.InsertShapeOptions:interface' +package: word! +fullName: Word.InsertShapeOptions +summary: Specifies the options to determine size and location when inserting a shape. +remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' +isPreview: true +isDeprecated: false +type: interface +properties: + - name: height + uid: 'word!Word.InsertShapeOptions#height:member' + package: word! + fullName: height + summary: Represents the height of the shape being inserted. + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'height?: number;' + return: + type: number + - name: left + uid: 'word!Word.InsertShapeOptions#left:member' + package: word! + fullName: left + summary: Represents the left position of the shape being inserted. + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'left?: number;' + return: + type: number + - name: top + uid: 'word!Word.InsertShapeOptions#top:member' + package: word! + fullName: top + summary: Represents the top position of the shape being inserted. + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'top?: number;' + return: + type: number + - name: width + uid: 'word!Word.InsertShapeOptions#width:member' + package: word! + fullName: width + summary: Represents the width of the shape being inserted. + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'width?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.bodydata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.bodydata.yml index cf21fbd5d2..1181a25f37 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.bodydata.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.bodydata.yml @@ -86,6 +86,20 @@ properties: content: 'paragraphs?: Word.Interfaces.ParagraphData[];' return: type: '[]' + - name: shapes + uid: 'word!Word.Interfaces.BodyData#shapes:member' + package: word! + fullName: shapes + summary: >- + Gets the collection of shape objects in the body, including both inline and floating shapes. Currently, only + TextBox shapes are supported. + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'shapes?: Word.Interfaces.ShapeData[];' + return: + type: '[]' - name: style uid: 'word!Word.Interfaces.BodyData#style:member' package: word! @@ -214,8 +228,8 @@ properties: syntax: content: >- type?: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" | "Footnote" | - "Endnote" | "NoteItem"; + "Endnote" | "NoteItem" | "Shape"; return: type: >- | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" - | "Footnote" | "Endnote" | "NoteItem" + | "Footnote" | "Endnote" | "NoteItem" | "Shape" diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.contentcontrolcollectionloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.contentcontrolcollectionloadoptions.yml index 91ad1b9984..b994be4367 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.contentcontrolcollectionloadoptions.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.contentcontrolcollectionloadoptions.yml @@ -7,7 +7,7 @@ summary: >- Contains a collection of [Word.ContentControl](xref:word!Word.ContentControl:class) objects. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, - only rich text and plain text content controls are supported. + only rich text, plain text, checkbox, dropdown list, and combo box content controls are supported. remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.contentcontrolloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.contentcontrolloadoptions.yml index 2b497a9074..612c30ab80 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.contentcontrolloadoptions.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.contentcontrolloadoptions.yml @@ -6,7 +6,8 @@ fullName: Word.Interfaces.ContentControlLoadOptions summary: >- Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or - paragraphs of formatted text. Currently, only rich text, plain text, and checkbox content controls are supported. + paragraphs of formatted text. Currently, only rich text, plain text, checkbox, dropdown list, and combo box content + controls are supported. remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.paragraphdata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.paragraphdata.yml index 4fd5f1f902..39874b48b1 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.paragraphdata.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.paragraphdata.yml @@ -195,6 +195,20 @@ properties: content: 'rightIndent?: number;' return: type: number + - name: shapes + uid: 'word!Word.Interfaces.ParagraphData#shapes:member' + package: word! + fullName: shapes + summary: >- + Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes. + Currently, only TextBox shapes are supported. + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'shapes?: Word.Interfaces.ShapeData[];' + return: + type: '[]' - name: spaceAfter uid: 'word!Word.Interfaces.ParagraphData#spaceAfter:member' package: word! diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.rangedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.rangedata.yml index 4d624e959d..05370c758e 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.rangedata.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.rangedata.yml @@ -72,6 +72,20 @@ properties: content: 'isEmpty?: boolean;' return: type: boolean + - name: shapes + uid: 'word!Word.Interfaces.RangeData#shapes:member' + package: word! + fullName: shapes + summary: >- + Gets the collection of shape objects anchored in the range, including both inline and floating shapes. Currently, + only TextBox shapes are supported. + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'shapes?: Word.Interfaces.ShapeData[];' + return: + type: '[]' - name: style uid: 'word!Word.Interfaces.RangeData#style:member' package: word! diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.shapecollectiondata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.shapecollectiondata.yml new file mode 100644 index 0000000000..4831994c1f --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.shapecollectiondata.yml @@ -0,0 +1,23 @@ +### YamlMime:TSType +name: Word.Interfaces.ShapeCollectionData +uid: 'word!Word.Interfaces.ShapeCollectionData:interface' +package: word! +fullName: Word.Interfaces.ShapeCollectionData +summary: An interface describing the data returned by calling `shapeCollection.toJSON()`. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: 'word!Word.Interfaces.ShapeCollectionData#items:member' + package: word! + fullName: items + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Word.Interfaces.ShapeData[];' + return: + type: '[]' diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.shapecollectionloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.shapecollectionloadoptions.yml new file mode 100644 index 0000000000..20af0dbb3d --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.shapecollectionloadoptions.yml @@ -0,0 +1,143 @@ +### YamlMime:TSType +name: Word.Interfaces.ShapeCollectionLoadOptions +uid: 'word!Word.Interfaces.ShapeCollectionLoadOptions:interface' +package: word! +fullName: Word.Interfaces.ShapeCollectionLoadOptions +summary: >- + Contains a collection of [Word.Shape](xref:word!Word.Shape:class) objects. Currently, only TextBox shapes are + supported. +remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' +isPreview: true +isDeprecated: false +type: interface +properties: + - name: $all + uid: 'word!Word.Interfaces.ShapeCollectionLoadOptions#$all:member' + package: word! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not + the navigational properties (such as `Range.format.fill.color`). + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: body + uid: 'word!Word.Interfaces.ShapeCollectionLoadOptions#body:member' + package: word! + fullName: body + summary: 'For EACH ITEM in the collection: Represents the body object of the shape. Only applies to TextBox shapes.' + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'body?: Word.Interfaces.BodyLoadOptions;' + return: + type: '' + - name: height + uid: 'word!Word.Interfaces.ShapeCollectionLoadOptions#height:member' + package: word! + fullName: height + summary: 'For EACH ITEM in the collection: The height, in points, of the shape.' + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'height?: boolean;' + return: + type: boolean + - name: id + uid: 'word!Word.Interfaces.ShapeCollectionLoadOptions#id:member' + package: word! + fullName: id + summary: 'For EACH ITEM in the collection: Gets an integer that represents the shape identifier.' + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: left + uid: 'word!Word.Interfaces.ShapeCollectionLoadOptions#left:member' + package: word! + fullName: left + summary: >- + For EACH ITEM in the collection: The distance, in points, from the left side of the shape to the horizontal + relative position. For a floating shape, it will return 0 and can't be set. + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'left?: boolean;' + return: + type: boolean + - name: relativeHorizontalPosition + uid: 'word!Word.Interfaces.ShapeCollectionLoadOptions#relativeHorizontalPosition:member' + package: word! + fullName: relativeHorizontalPosition + summary: >- + For EACH ITEM in the collection: The relative horizontal position of the shape. For a floating shape, it can't be + set. + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'relativeHorizontalPosition?: boolean;' + return: + type: boolean + - name: relativeVerticalPosition + uid: 'word!Word.Interfaces.ShapeCollectionLoadOptions#relativeVerticalPosition:member' + package: word! + fullName: relativeVerticalPosition + summary: >- + For EACH ITEM in the collection: The relative vertical position of the shape. For a floating shape, it can't be + set. + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'relativeVerticalPosition?: boolean;' + return: + type: boolean + - name: top + uid: 'word!Word.Interfaces.ShapeCollectionLoadOptions#top:member' + package: word! + fullName: top + summary: >- + For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the vertical relative + position. For a floating shape, it will return 0 and can't be set. + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'top?: boolean;' + return: + type: boolean + - name: type + uid: 'word!Word.Interfaces.ShapeCollectionLoadOptions#type:member' + package: word! + fullName: type + summary: 'For EACH ITEM in the collection: Gets the shape type. Currently, only TextBox shapes are supported.' + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'type?: boolean;' + return: + type: boolean + - name: width + uid: 'word!Word.Interfaces.ShapeCollectionLoadOptions#width:member' + package: word! + fullName: width + summary: 'For EACH ITEM in the collection: The width, in points, of the shape.' + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'width?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.shapecollectionupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.shapecollectionupdatedata.yml new file mode 100644 index 0000000000..264482ecd4 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.shapecollectionupdatedata.yml @@ -0,0 +1,23 @@ +### YamlMime:TSType +name: Word.Interfaces.ShapeCollectionUpdateData +uid: 'word!Word.Interfaces.ShapeCollectionUpdateData:interface' +package: word! +fullName: Word.Interfaces.ShapeCollectionUpdateData +summary: 'An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`.' +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: 'word!Word.Interfaces.ShapeCollectionUpdateData#items:member' + package: word! + fullName: items + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Word.Interfaces.ShapeData[];' + return: + type: '[]' diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.shapedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.shapedata.yml new file mode 100644 index 0000000000..4cca2fcfc0 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.shapedata.yml @@ -0,0 +1,131 @@ +### YamlMime:TSType +name: Word.Interfaces.ShapeData +uid: 'word!Word.Interfaces.ShapeData:interface' +package: word! +fullName: Word.Interfaces.ShapeData +summary: An interface describing the data returned by calling `shape.toJSON()`. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: body + uid: 'word!Word.Interfaces.ShapeData#body:member' + package: word! + fullName: body + summary: Represents the body object of the shape. Only applies to TextBox shapes. + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'body?: Word.Interfaces.BodyData;' + return: + type: '' + - name: height + uid: 'word!Word.Interfaces.ShapeData#height:member' + package: word! + fullName: height + summary: 'The height, in points, of the shape.' + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'height?: number;' + return: + type: number + - name: id + uid: 'word!Word.Interfaces.ShapeData#id:member' + package: word! + fullName: id + summary: Gets an integer that represents the shape identifier. + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'id?: number;' + return: + type: number + - name: left + uid: 'word!Word.Interfaces.ShapeData#left:member' + package: word! + fullName: left + summary: >- + The distance, in points, from the left side of the shape to the horizontal relative position. For a floating + shape, it will return 0 and can't be set. + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'left?: number;' + return: + type: number + - name: relativeHorizontalPosition + uid: 'word!Word.Interfaces.ShapeData#relativeHorizontalPosition:member' + package: word! + fullName: relativeHorizontalPosition + summary: 'The relative horizontal position of the shape. For a floating shape, it can''t be set.' + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: >- + relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | + "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + return: + type: >- + | "Margin" | "Page" | "Column" | "Character" | + "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin" + - name: relativeVerticalPosition + uid: 'word!Word.Interfaces.ShapeData#relativeVerticalPosition:member' + package: word! + fullName: relativeVerticalPosition + summary: 'The relative vertical position of the shape. For a floating shape, it can''t be set.' + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: >- + relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | + "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + return: + type: >- + | "Margin" | "Page" | "Paragraph" | "Line" | + "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin" + - name: top + uid: 'word!Word.Interfaces.ShapeData#top:member' + package: word! + fullName: top + summary: >- + The distance, in points, from the top edge of the shape to the vertical relative position. For a floating shape, + it will return 0 and can't be set. + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'top?: number;' + return: + type: number + - name: type + uid: 'word!Word.Interfaces.ShapeData#type:member' + package: word! + fullName: type + summary: 'Gets the shape type. Currently, only TextBox shapes are supported.' + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'type?: Word.ShapeType | "Unsupported" | "TextBox";' + return: + type: ' | "Unsupported" | "TextBox"' + - name: width + uid: 'word!Word.Interfaces.ShapeData#width:member' + package: word! + fullName: width + summary: 'The width, in points, of the shape.' + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'width?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.shapeloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.shapeloadoptions.yml new file mode 100644 index 0000000000..c081448f1b --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.shapeloadoptions.yml @@ -0,0 +1,137 @@ +### YamlMime:TSType +name: Word.Interfaces.ShapeLoadOptions +uid: 'word!Word.Interfaces.ShapeLoadOptions:interface' +package: word! +fullName: Word.Interfaces.ShapeLoadOptions +summary: 'Represents a shape in the header footer or document body. Currently, only TextBox shapes are supported.' +remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' +isPreview: true +isDeprecated: false +type: interface +properties: + - name: $all + uid: 'word!Word.Interfaces.ShapeLoadOptions#$all:member' + package: word! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not + the navigational properties (such as `Range.format.fill.color`). + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: body + uid: 'word!Word.Interfaces.ShapeLoadOptions#body:member' + package: word! + fullName: body + summary: Represents the body object of the shape. Only applies to TextBox shapes. + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'body?: Word.Interfaces.BodyLoadOptions;' + return: + type: '' + - name: height + uid: 'word!Word.Interfaces.ShapeLoadOptions#height:member' + package: word! + fullName: height + summary: 'The height, in points, of the shape.' + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'height?: boolean;' + return: + type: boolean + - name: id + uid: 'word!Word.Interfaces.ShapeLoadOptions#id:member' + package: word! + fullName: id + summary: Gets an integer that represents the shape identifier. + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: left + uid: 'word!Word.Interfaces.ShapeLoadOptions#left:member' + package: word! + fullName: left + summary: >- + The distance, in points, from the left side of the shape to the horizontal relative position. For a floating + shape, it will return 0 and can't be set. + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'left?: boolean;' + return: + type: boolean + - name: relativeHorizontalPosition + uid: 'word!Word.Interfaces.ShapeLoadOptions#relativeHorizontalPosition:member' + package: word! + fullName: relativeHorizontalPosition + summary: 'The relative horizontal position of the shape. For a floating shape, it can''t be set.' + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'relativeHorizontalPosition?: boolean;' + return: + type: boolean + - name: relativeVerticalPosition + uid: 'word!Word.Interfaces.ShapeLoadOptions#relativeVerticalPosition:member' + package: word! + fullName: relativeVerticalPosition + summary: 'The relative vertical position of the shape. For a floating shape, it can''t be set.' + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'relativeVerticalPosition?: boolean;' + return: + type: boolean + - name: top + uid: 'word!Word.Interfaces.ShapeLoadOptions#top:member' + package: word! + fullName: top + summary: >- + The distance, in points, from the top edge of the shape to the vertical relative position. For a floating shape, + it will return 0 and can't be set. + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'top?: boolean;' + return: + type: boolean + - name: type + uid: 'word!Word.Interfaces.ShapeLoadOptions#type:member' + package: word! + fullName: type + summary: 'Gets the shape type. Currently, only TextBox shapes are supported.' + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'type?: boolean;' + return: + type: boolean + - name: width + uid: 'word!Word.Interfaces.ShapeLoadOptions#width:member' + package: word! + fullName: width + summary: 'The width, in points, of the shape.' + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'width?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.shapeupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.shapeupdatedata.yml new file mode 100644 index 0000000000..7076840482 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.shapeupdatedata.yml @@ -0,0 +1,107 @@ +### YamlMime:TSType +name: Word.Interfaces.ShapeUpdateData +uid: 'word!Word.Interfaces.ShapeUpdateData:interface' +package: word! +fullName: Word.Interfaces.ShapeUpdateData +summary: 'An interface for updating data on the `Shape` object, for use in `shape.set({ ... })`.' +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: body + uid: 'word!Word.Interfaces.ShapeUpdateData#body:member' + package: word! + fullName: body + summary: Represents the body object of the shape. Only applies to TextBox shapes. + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'body?: Word.Interfaces.BodyUpdateData;' + return: + type: '' + - name: height + uid: 'word!Word.Interfaces.ShapeUpdateData#height:member' + package: word! + fullName: height + summary: 'The height, in points, of the shape.' + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'height?: number;' + return: + type: number + - name: left + uid: 'word!Word.Interfaces.ShapeUpdateData#left:member' + package: word! + fullName: left + summary: >- + The distance, in points, from the left side of the shape to the horizontal relative position. For a floating + shape, it will return 0 and can't be set. + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'left?: number;' + return: + type: number + - name: relativeHorizontalPosition + uid: 'word!Word.Interfaces.ShapeUpdateData#relativeHorizontalPosition:member' + package: word! + fullName: relativeHorizontalPosition + summary: 'The relative horizontal position of the shape. For a floating shape, it can''t be set.' + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: >- + relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | + "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + return: + type: >- + | "Margin" | "Page" | "Column" | "Character" | + "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin" + - name: relativeVerticalPosition + uid: 'word!Word.Interfaces.ShapeUpdateData#relativeVerticalPosition:member' + package: word! + fullName: relativeVerticalPosition + summary: 'The relative vertical position of the shape. For a floating shape, it can''t be set.' + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: >- + relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | + "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + return: + type: >- + | "Margin" | "Page" | "Paragraph" | "Line" | + "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin" + - name: top + uid: 'word!Word.Interfaces.ShapeUpdateData#top:member' + package: word! + fullName: top + summary: >- + The distance, in points, from the top edge of the shape to the vertical relative position. For a floating shape, + it will return 0 and can't be set. + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'top?: number;' + return: + type: number + - name: width + uid: 'word!Word.Interfaces.ShapeUpdateData#width:member' + package: word! + fullName: width + summary: 'The width, in points, of the shape.' + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'width?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/word/word/word.paragraph.yml b/docs/docs-ref-autogen/word/word/word.paragraph.yml index df3b5c0ecf..3d680a1e7b 100644 --- a/docs/docs-ref-autogen/word/word/word.paragraph.yml +++ b/docs/docs-ref-autogen/word/word/word.paragraph.yml @@ -499,6 +499,20 @@ properties: content: 'rightIndent: number;' return: type: number + - name: shapes + uid: 'word!Word.Paragraph#shapes:member' + package: word! + fullName: shapes + summary: >- + Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes. + Currently, only TextBox shapes are supported. + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'readonly shapes: Word.ShapeCollection;' + return: + type: '' - name: spaceAfter uid: 'word!Word.Paragraph#spaceAfter:member' package: word! @@ -1606,8 +1620,8 @@ methods: \[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - 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. + 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. isPreview: false isDeprecated: false syntax: @@ -1861,6 +1875,26 @@ methods: return: type: '' description: '' + - name: 'insertTextBox(text, insertShapeOptions)' + uid: 'word!Word.Paragraph#insertTextBox:member(1)' + package: word! + fullName: 'insertTextBox(text, insertShapeOptions)' + summary: Inserts a floating text box with its anchor at the beginning of the paragraph. + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'insertTextBox(text?: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;' + parameters: + - id: text + description: Optional. The text to insert into the text box. + type: string + - id: insertShapeOptions + description: 'Optional. The size and location of the text box. The default location and size is (0, 0, 100, 100).' + type: '' + return: + type: '' + description: '' - name: load(options) uid: 'word!Word.Paragraph#load:member(1)' package: word! diff --git a/docs/docs-ref-autogen/word/word/word.paragraphaddedeventargs.yml b/docs/docs-ref-autogen/word/word/word.paragraphaddedeventargs.yml index 5926b69f02..38bd2233e5 100644 --- a/docs/docs-ref-autogen/word/word/word.paragraphaddedeventargs.yml +++ b/docs/docs-ref-autogen/word/word/word.paragraphaddedeventargs.yml @@ -64,15 +64,17 @@ properties: syntax: content: >- type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" - | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | - "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | - "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | + | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" | + "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | + "ContentControlExited" | "DocumentWordCountChanged" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" + | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; return: type: >- | "ContentControlDeleted" | "ContentControlSelectionChanged" | - "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | - "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | + "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | + "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | + "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction" - name: uniqueLocalIds diff --git a/docs/docs-ref-autogen/word/word/word.paragraphchangedeventargs.yml b/docs/docs-ref-autogen/word/word/word.paragraphchangedeventargs.yml index d9e5784f7d..5f67a5755e 100644 --- a/docs/docs-ref-autogen/word/word/word.paragraphchangedeventargs.yml +++ b/docs/docs-ref-autogen/word/word/word.paragraphchangedeventargs.yml @@ -64,15 +64,17 @@ properties: syntax: content: >- type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" - | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | - "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | - "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | + | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" | + "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | + "ContentControlExited" | "DocumentWordCountChanged" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" + | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; return: type: >- | "ContentControlDeleted" | "ContentControlSelectionChanged" | - "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | - "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | + "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | + "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | + "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction" - name: uniqueLocalIds diff --git a/docs/docs-ref-autogen/word/word/word.paragraphdeletedeventargs.yml b/docs/docs-ref-autogen/word/word/word.paragraphdeletedeventargs.yml index b5fd5144d8..00ee470db1 100644 --- a/docs/docs-ref-autogen/word/word/word.paragraphdeletedeventargs.yml +++ b/docs/docs-ref-autogen/word/word/word.paragraphdeletedeventargs.yml @@ -64,15 +64,17 @@ properties: syntax: content: >- type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" - | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | - "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | - "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | + | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" | + "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | + "ContentControlExited" | "DocumentWordCountChanged" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" + | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; return: type: >- | "ContentControlDeleted" | "ContentControlSelectionChanged" | - "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | - "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | + "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | + "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | + "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction" - name: uniqueLocalIds diff --git a/docs/docs-ref-autogen/word/word/word.range.yml b/docs/docs-ref-autogen/word/word/word.range.yml index ed8c714b26..e65e725901 100644 --- a/docs/docs-ref-autogen/word/word/word.range.yml +++ b/docs/docs-ref-autogen/word/word/word.range.yml @@ -357,6 +357,20 @@ properties: content: 'readonly parentTableOrNullObject: Word.Table;' return: type: '' + - name: shapes + uid: 'word!Word.Range#shapes:member' + package: word! + fullName: shapes + summary: >- + Gets the collection of shape objects anchored in the range, including both inline and floating shapes. Currently, + only TextBox shapes are supported. + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'readonly shapes: Word.ShapeCollection;' + return: + type: '' - name: style uid: 'word!Word.Range#style:member' package: word! @@ -617,7 +631,7 @@ methods: fullName: expandTo(range) summary: >- Returns a new range that extends from this range in either direction to cover another range. This range isn't - changed. Throws an `ItemNotFound` error if the two ranges do not have a union. + changed. Throws an `ItemNotFound` error if the two ranges don't have a union. remarks: >- \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -1556,8 +1570,8 @@ methods: \[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - 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. + 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. #### Examples @@ -1871,6 +1885,26 @@ methods: return: type: '' description: '' + - name: 'insertTextBox(text, insertShapeOptions)' + uid: 'word!Word.Range#insertTextBox:member(1)' + package: word! + fullName: 'insertTextBox(text, insertShapeOptions)' + summary: Inserts a floating text box with its anchor at the beginning of the range. + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'insertTextBox(text?: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;' + parameters: + - id: text + description: Optional. The text to insert into the text box. + type: string + - id: insertShapeOptions + description: 'Optional. The size and location of the text box. The default location and size is (0, 0, 100, 100).' + type: '' + return: + type: '' + description: '' - name: intersectWith(range) uid: 'word!Word.Range#intersectWith:member(1)' package: word! diff --git a/docs/docs-ref-autogen/word/word/word.relativehorizontalposition.yml b/docs/docs-ref-autogen/word/word/word.relativehorizontalposition.yml new file mode 100644 index 0000000000..ec63d4024d --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.relativehorizontalposition.yml @@ -0,0 +1,76 @@ +### YamlMime:TSEnum +name: Word.RelativeHorizontalPosition +uid: 'word!Word.RelativeHorizontalPosition:enum' +package: word! +fullName: Word.RelativeHorizontalPosition +summary: >- + Represents what the horizontal position of a shape is relative to. For more information about margins, see [Change the + margins in your Word document](https://support.microsoft.com/office/c95c1ea1-70b1-4dde-a1da-f5aa2042c829). +remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' +isPreview: true +isDeprecated: false +fields: + - name: character + uid: 'word!Word.RelativeHorizontalPosition.character:member' + package: word! + summary: |- + Relative to character. + + * \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Character"' + - name: column + uid: 'word!Word.RelativeHorizontalPosition.column:member' + package: word! + summary: |- + Relative to column. + + * \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Column"' + - name: insideMargin + uid: 'word!Word.RelativeHorizontalPosition.insideMargin:member' + package: word! + summary: |- + Relative to inside margin. + + * \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"InsideMargin"' + - name: leftMargin + uid: 'word!Word.RelativeHorizontalPosition.leftMargin:member' + package: word! + summary: |- + Relative to left margin. + + * \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"LeftMargin"' + - name: margin + uid: 'word!Word.RelativeHorizontalPosition.margin:member' + package: word! + summary: |- + Relative to margin. + + * \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Margin"' + - name: outsideMargin + uid: 'word!Word.RelativeHorizontalPosition.outsideMargin:member' + package: word! + summary: |- + Relative to outside margin. + + * \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"OutsideMargin"' + - name: page + uid: 'word!Word.RelativeHorizontalPosition.page:member' + package: word! + summary: |- + Relative to page. + + * \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Page"' + - name: rightMargin + uid: 'word!Word.RelativeHorizontalPosition.rightMargin:member' + package: word! + summary: |- + Relative to right margin. + + * \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"RightMargin"' diff --git a/docs/docs-ref-autogen/word/word/word.relativeverticalposition.yml b/docs/docs-ref-autogen/word/word/word.relativeverticalposition.yml new file mode 100644 index 0000000000..0dcf38fa82 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.relativeverticalposition.yml @@ -0,0 +1,76 @@ +### YamlMime:TSEnum +name: Word.RelativeVerticalPosition +uid: 'word!Word.RelativeVerticalPosition:enum' +package: word! +fullName: Word.RelativeVerticalPosition +summary: >- + Represents what the vertical position of a shape is relative to. For more information about margins, see [Change the + margins in your Word document](https://support.microsoft.com/office/c95c1ea1-70b1-4dde-a1da-f5aa2042c829). +remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' +isPreview: true +isDeprecated: false +fields: + - name: bottomMargin + uid: 'word!Word.RelativeVerticalPosition.bottomMargin:member' + package: word! + summary: |- + Relative to bottom margin. + + * \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"BottomMargin"' + - name: insideMargin + uid: 'word!Word.RelativeVerticalPosition.insideMargin:member' + package: word! + summary: |- + Relative to inside margin. + + * \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"InsideMargin"' + - name: line + uid: 'word!Word.RelativeVerticalPosition.line:member' + package: word! + summary: |- + Relative to line. + + * \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Line"' + - name: margin + uid: 'word!Word.RelativeVerticalPosition.margin:member' + package: word! + summary: |- + Relative to margin. + + * \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Margin"' + - name: outsideMargin + uid: 'word!Word.RelativeVerticalPosition.outsideMargin:member' + package: word! + summary: |- + Relative to outside margin. + + * \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"OutsideMargin"' + - name: page + uid: 'word!Word.RelativeVerticalPosition.page:member' + package: word! + summary: |- + Relative to page. + + * \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Page"' + - name: paragraph + uid: 'word!Word.RelativeVerticalPosition.paragraph:member' + package: word! + summary: |- + Relative to paragraph. + + * \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Paragraph"' + - name: topMargin + uid: 'word!Word.RelativeVerticalPosition.topMargin:member' + package: word! + summary: |- + Relative to top margin. + + * \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"TopMargin"' diff --git a/docs/docs-ref-autogen/word/word/word.shape.yml b/docs/docs-ref-autogen/word/word/word.shape.yml new file mode 100644 index 0000000000..9a38f6ffa3 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.shape.yml @@ -0,0 +1,340 @@ +### YamlMime:TSType +name: Word.Shape +uid: 'word!Word.Shape:class' +package: word! +fullName: Word.Shape +summary: 'Represents a shape in the header footer or document body. Currently, only TextBox shapes are supported.' +remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' +isPreview: true +isDeprecated: false +type: class +properties: + - name: body + uid: 'word!Word.Shape#body:member' + package: word! + fullName: body + summary: Represents the body object of the shape. Only applies to TextBox shapes. + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'readonly body: Word.Body;' + return: + type: '' + - name: context + uid: 'word!Word.Shape#context:member' + package: word! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's process to the Office host + application's process. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: '' + - name: height + uid: 'word!Word.Shape#height:member' + package: word! + fullName: height + summary: 'The height, in points, of the shape.' + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'height: number;' + return: + type: number + - name: id + uid: 'word!Word.Shape#id:member' + package: word! + fullName: id + summary: Gets an integer that represents the shape identifier. + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'readonly id: number;' + return: + type: number + - name: left + uid: 'word!Word.Shape#left:member' + package: word! + fullName: left + summary: >- + The distance, in points, from the left side of the shape to the horizontal relative position. For a floating + shape, it will return 0 and can't be set. + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'left: number;' + return: + type: number + - name: relativeHorizontalPosition + uid: 'word!Word.Shape#relativeHorizontalPosition:member' + package: word! + fullName: relativeHorizontalPosition + summary: 'The relative horizontal position of the shape. For a floating shape, it can''t be set.' + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: >- + relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | + "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + return: + type: >- + | "Margin" | "Page" | "Column" | "Character" | + "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin" + - name: relativeVerticalPosition + uid: 'word!Word.Shape#relativeVerticalPosition:member' + package: word! + fullName: relativeVerticalPosition + summary: 'The relative vertical position of the shape. For a floating shape, it can''t be set.' + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: >- + relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" + | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + return: + type: >- + | "Margin" | "Page" | "Paragraph" | "Line" | + "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin" + - name: top + uid: 'word!Word.Shape#top:member' + package: word! + fullName: top + summary: >- + The distance, in points, from the top edge of the shape to the vertical relative position. For a floating shape, + it will return 0 and can't be set. + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'top: number;' + return: + type: number + - name: type + uid: 'word!Word.Shape#type:member' + package: word! + fullName: type + summary: 'Gets the shape type. Currently, only TextBox shapes are supported.' + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'readonly type: Word.ShapeType | "Unsupported" | "TextBox";' + return: + type: ' | "Unsupported" | "TextBox"' + - name: width + uid: 'word!Word.Shape#width:member' + package: word! + fullName: width + summary: 'The width, in points, of the shape.' + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'width: number;' + return: + type: number +methods: + - name: delete() + uid: 'word!Word.Shape#delete:member(1)' + package: word! + fullName: delete() + summary: Deletes the shape and its content. + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'delete(): void;' + return: + type: void + description: '' + - name: load(options) + uid: 'word!Word.Shape#load:member(1)' + package: word! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading + the properties. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'load(options?: Word.Interfaces.ShapeLoadOptions): Word.Shape;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: '' + return: + type: '' + description: '' + - name: load(propertyNames) + uid: 'word!Word.Shape#load:member(2)' + package: word! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading + the properties. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Word.Shape;' + parameters: + - id: propertyNames + description: A comma-delimited string or an array of strings that specify the properties to load. + type: 'string | string[]' + return: + type: '' + description: '' + - name: load(propertyNamesAndPaths) + uid: 'word!Word.Shape#load:member(3)' + package: word! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading + the properties. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Shape; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and + `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: '' + description: '' + - name: select(selectMultipleShapes) + uid: 'word!Word.Shape#select:member(1)' + package: word! + fullName: select(selectMultipleShapes) + summary: Selects the shape. + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'select(selectMultipleShapes?: boolean): void;' + parameters: + - id: selectMultipleShapes + description: Optional. Whether to select multiple floating shapes. The default value is false. + type: boolean + return: + type: void + description: '' + - name: 'set(properties, options)' + uid: 'word!Word.Shape#set:member(1)' + package: word! + fullName: 'set(properties, options)' + summary: >- + 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. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'set(properties: Interfaces.ShapeUpdateData, options?: OfficeExtension.UpdateOptions): void;' + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured isomorphically to the properties of the object on + which the method is called. + type: '' + - id: options + description: Provides an option to suppress errors if the properties object tries to set any read-only properties. + type: '' + return: + type: void + description: '' + - name: set(properties) + uid: 'word!Word.Shape#set:member(2)' + package: word! + fullName: set(properties) + summary: 'Sets multiple properties on the object at the same time, based on an existing loaded object.' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'set(properties: Word.Shape): void;' + parameters: + - id: properties + description: '' + type: '' + return: + type: void + description: '' + - name: toJSON() + uid: 'word!Word.Shape#toJSON:member(1)' + package: word! + fullName: toJSON() + summary: >- + 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. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.ShapeData;' + return: + type: '' + description: '' + - name: track() + uid: 'word!Word.Shape#track:member(1)' + package: word! + fullName: track() + summary: >- + Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand + for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and + get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the + object to the tracked object collection when the object was first created. If this object is part of a collection, + you should also track the parent collection. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'track(): Word.Shape;' + return: + type: '' + description: '' + - name: untrack() + uid: 'word!Word.Shape#untrack:member(1)' + package: word! + fullName: untrack() + summary: >- + Release the memory associated with this object, if it has previously been tracked. This call is shorthand for + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so please remember to free any objects you add, + once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'untrack(): Word.Shape;' + return: + type: '' + description: '' +extends: '' diff --git a/docs/docs-ref-autogen/word/word/word.shapecollection.yml b/docs/docs-ref-autogen/word/word/word.shapecollection.yml new file mode 100644 index 0000000000..ad0597a276 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.shapecollection.yml @@ -0,0 +1,247 @@ +### YamlMime:TSType +name: Word.ShapeCollection +uid: 'word!Word.ShapeCollection:class' +package: word! +fullName: Word.ShapeCollection +summary: >- + Contains a collection of [Word.Shape](xref:word!Word.Shape:class) objects. Currently, only TextBox shapes are + supported. +remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' +isPreview: true +isDeprecated: false +type: class +properties: + - name: context + uid: 'word!Word.ShapeCollection#context:member' + package: word! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's process to the Office host + application's process. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: '' + - name: items + uid: 'word!Word.ShapeCollection#items:member' + package: word! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'readonly items: Word.Shape[];' + return: + type: '[]' +methods: + - name: getById(id) + uid: 'word!Word.ShapeCollection#getById:member(1)' + package: word! + fullName: getById(id) + summary: >- + Gets a shape by its identifier. Throws an `ItemNotFound` error if there isn't a shape with the identifier in this + collection. + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'getById(id: number): Word.Shape;' + parameters: + - id: id + description: Required. A shape identifier. + type: number + return: + type: '' + description: '' + - name: getByIdOrNullObject(id) + uid: 'word!Word.ShapeCollection#getByIdOrNullObject:member(1)' + package: word! + fullName: getByIdOrNullObject(id) + summary: >- + Gets a shape by its identifier. If there isn't a shape with the identifier in this collection, then this method + will return an object with its `isNullObject` property set to `true`. For further information, see + [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'getByIdOrNullObject(id: number): Word.Shape;' + parameters: + - id: id + description: Required. A shape identifier. + type: number + return: + type: '' + description: '' + - name: getByTypes(types) + uid: 'word!Word.ShapeCollection#getByTypes:member(1)' + package: word! + fullName: getByTypes(types) + summary: Gets the shapes that have the specified types. + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'getByTypes(types: Word.ShapeType[]): Word.ShapeCollection;' + parameters: + - id: types + description: Required. An array of shape types. + type: '[]' + return: + type: '' + description: '' + - name: getFirst() + uid: 'word!Word.ShapeCollection#getFirst:member(1)' + package: word! + fullName: getFirst() + summary: Gets the first shape in this collection. Throws an `ItemNotFound` error if this collection is empty. + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'getFirst(): Word.Shape;' + return: + type: '' + description: '' + - name: getFirstOrNullObject() + uid: 'word!Word.ShapeCollection#getFirstOrNullObject:member(1)' + package: word! + fullName: getFirstOrNullObject() + summary: >- + Gets the first shape in this collection. If this collection is empty, then this method will return an object with + its `isNullObject` property set to `true`. For further information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'getFirstOrNullObject(): Word.Shape;' + return: + type: '' + description: '' + - name: load(options) + uid: 'word!Word.ShapeCollection#load:member(1)' + package: word! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading + the properties. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: >- + load(options?: Word.Interfaces.ShapeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): + Word.ShapeCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: '' + description: '' + - name: load(propertyNames) + uid: 'word!Word.ShapeCollection#load:member(2)' + package: word! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading + the properties. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Word.ShapeCollection;' + parameters: + - id: propertyNames + description: A comma-delimited string or an array of strings that specify the properties to load. + type: 'string | string[]' + return: + type: '' + description: '' + - name: load(propertyNamesAndPaths) + uid: 'word!Word.ShapeCollection#load:member(3)' + package: word! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading + the properties. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ShapeCollection;' + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and + `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + type: '' + return: + type: '' + description: '' + - name: toJSON() + uid: 'word!Word.ShapeCollection#toJSON:member(1)' + package: word! + fullName: toJSON() + summary: >- + 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. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.ShapeCollectionData;' + return: + type: '' + description: '' + - name: track() + uid: 'word!Word.ShapeCollection#track:member(1)' + package: word! + fullName: track() + summary: >- + Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand + for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and + get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the + object to the tracked object collection when the object was first created. If this object is part of a collection, + you should also track the parent collection. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'track(): Word.ShapeCollection;' + return: + type: '' + description: '' + - name: untrack() + uid: 'word!Word.ShapeCollection#untrack:member(1)' + package: word! + fullName: untrack() + summary: >- + Release the memory associated with this object, if it has previously been tracked. This call is shorthand for + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so please remember to free any objects you add, + once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'untrack(): Word.ShapeCollection;' + return: + type: '' + description: '' +extends: '' diff --git a/docs/docs-ref-autogen/word/word/word.shapetype.yml b/docs/docs-ref-autogen/word/word/word.shapetype.yml new file mode 100644 index 0000000000..24cf78e8ef --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.shapetype.yml @@ -0,0 +1,26 @@ +### YamlMime:TSEnum +name: Word.ShapeType +uid: 'word!Word.ShapeType:enum' +package: word! +fullName: Word.ShapeType +summary: Represents the shape type. +remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' +isPreview: true +isDeprecated: false +fields: + - name: textBox + uid: 'word!Word.ShapeType.textBox:member' + package: word! + summary: |- + Text box shape. + + * \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"TextBox"' + - name: unsupported + uid: 'word!Word.ShapeType.unsupported:member' + package: word! + summary: |- + Unsupported shape type. + + * \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Unsupported"' diff --git a/docs/includes/word-preview.md b/docs/includes/word-preview.md index 23b7cb5237..58fdd4e602 100644 --- a/docs/includes/word-preview.md +++ b/docs/includes/word-preview.md @@ -5,6 +5,8 @@ ||[onCommentDeleted](/javascript/api/word/word.body#word-word-body-oncommentdeleted-member)|Occurs when comments are deleted.| ||[onCommentDeselected](/javascript/api/word/word.body#word-word-body-oncommentdeselected-member)|Occurs when a comment is deselected.| ||[onCommentSelected](/javascript/api/word/word.body#word-word-body-oncommentselected-member)|Occurs when a comment is selected.| +||[shapes](/javascript/api/word/word.body#word-word-body-shapes-member)|Gets the collection of shape objects in the body, including both inline and floating shapes.| +||[type](/javascript/api/word/word.body#word-word-body-type-member)|Gets the type of the body.| |[CommentDetail](/javascript/api/word/word.commentdetail)|[id](/javascript/api/word/word.commentdetail#word-word-commentdetail-id-member)|Represents the ID of this comment.| ||[replyIds](/javascript/api/word/word.commentdetail#word-word-commentdetail-replyids-member)|Represents the IDs of the replies to this comment.| |[CommentEventArgs](/javascript/api/word/word.commenteventargs)|[changeType](/javascript/api/word/word.commenteventargs#word-word-commenteventargs-changetype-member)|Represents how the comment changed event is triggered.| @@ -25,16 +27,41 @@ |[ContentControlSelectionChangedEventArgs](/javascript/api/word/word.contentcontrolselectionchangedeventargs)|[eventType](/javascript/api/word/word.contentcontrolselectionchangedeventargs#word-word-contentcontrolselectionchangedeventargs-eventtype-member)|The event type.| |[Document](/javascript/api/word/word.document)|[compareFromBase64(base64File: string, documentCompareOptions?: Word.DocumentCompareOptions)](/javascript/api/word/word.document#word-word-document-comparefrombase64-member(1))|Displays revision marks that indicate where the specified document differs from another document.| |[Font](/javascript/api/word/word.font)|[hidden](/javascript/api/word/word.font#word-word-font-hidden-member)|Specifies a value that indicates whether the font is tagged as hidden.| -|[Paragraph](/javascript/api/word/word.paragraph)|[onCommentAdded](/javascript/api/word/word.paragraph#word-word-paragraph-oncommentadded-member)|Occurs when new comments are added.| +|[InsertShapeOptions](/javascript/api/word/word.insertshapeoptions)|[height](/javascript/api/word/word.insertshapeoptions#word-word-insertshapeoptions-height-member)|Represents the height of the shape being inserted.| +||[left](/javascript/api/word/word.insertshapeoptions#word-word-insertshapeoptions-left-member)|Represents the left position of the shape being inserted.| +||[top](/javascript/api/word/word.insertshapeoptions#word-word-insertshapeoptions-top-member)|Represents the top position of the shape being inserted.| +||[width](/javascript/api/word/word.insertshapeoptions#word-word-insertshapeoptions-width-member)|Represents the width of the shape being inserted.| +|[Paragraph](/javascript/api/word/word.paragraph)|[insertTextBox(text?: string, insertShapeOptions?: Word.InsertShapeOptions)](/javascript/api/word/word.paragraph#word-word-paragraph-inserttextbox-member(1))|Inserts a floating text box with its anchor at the beginning of the paragraph.| +||[onCommentAdded](/javascript/api/word/word.paragraph#word-word-paragraph-oncommentadded-member)|Occurs when new comments are added.| ||[onCommentChanged](/javascript/api/word/word.paragraph#word-word-paragraph-oncommentchanged-member)|Occurs when a comment or its reply is changed.| ||[onCommentDeleted](/javascript/api/word/word.paragraph#word-word-paragraph-oncommentdeleted-member)|Occurs when comments are deleted.| ||[onCommentDeselected](/javascript/api/word/word.paragraph#word-word-paragraph-oncommentdeselected-member)|Occurs when a comment is deselected.| ||[onCommentSelected](/javascript/api/word/word.paragraph#word-word-paragraph-oncommentselected-member)|Occurs when a comment is selected.| +||[shapes](/javascript/api/word/word.paragraph#word-word-paragraph-shapes-member)|Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes.| |[ParagraphAddedEventArgs](/javascript/api/word/word.paragraphaddedeventargs)|[type](/javascript/api/word/word.paragraphaddedeventargs#word-word-paragraphaddedeventargs-type-member)|The event type.| |[ParagraphChangedEventArgs](/javascript/api/word/word.paragraphchangedeventargs)|[type](/javascript/api/word/word.paragraphchangedeventargs#word-word-paragraphchangedeventargs-type-member)|The event type.| |[ParagraphDeletedEventArgs](/javascript/api/word/word.paragraphdeletedeventargs)|[type](/javascript/api/word/word.paragraphdeletedeventargs#word-word-paragraphdeletedeventargs-type-member)|The event type.| -|[Range](/javascript/api/word/word.range)|[onCommentAdded](/javascript/api/word/word.range#word-word-range-oncommentadded-member)|Occurs when new comments are added.| +|[Range](/javascript/api/word/word.range)|[insertTextBox(text?: string, insertShapeOptions?: Word.InsertShapeOptions)](/javascript/api/word/word.range#word-word-range-inserttextbox-member(1))|Inserts a floating text box with its anchor at the beginning of the range.| +||[onCommentAdded](/javascript/api/word/word.range#word-word-range-oncommentadded-member)|Occurs when new comments are added.| ||[onCommentChanged](/javascript/api/word/word.range#word-word-range-oncommentchanged-member)|Occurs when a comment or its reply is changed.| ||[onCommentDeselected](/javascript/api/word/word.range#word-word-range-oncommentdeselected-member)|Occurs when a comment is deselected.| ||[onCommentSelected](/javascript/api/word/word.range#word-word-range-oncommentselected-member)|Occurs when a comment is selected.| +||[shapes](/javascript/api/word/word.range#word-word-range-shapes-member)|Gets the collection of shape objects anchored in the range, including both inline and floating shapes.| +|[Shape](/javascript/api/word/word.shape)|[body](/javascript/api/word/word.shape#word-word-shape-body-member)|Represents the body object of the shape.| +||[delete()](/javascript/api/word/word.shape#word-word-shape-delete-member(1))|Deletes the shape and its content.| +||[height](/javascript/api/word/word.shape#word-word-shape-height-member)|The height, in points, of the shape.| +||[id](/javascript/api/word/word.shape#word-word-shape-id-member)|Gets an integer that represents the shape identifier.| +||[left](/javascript/api/word/word.shape#word-word-shape-left-member)|The distance, in points, from the left side of the shape to the horizontal relative position.| +||[relativeHorizontalPosition](/javascript/api/word/word.shape#word-word-shape-relativehorizontalposition-member)|The relative horizontal position of the shape.| +||[relativeVerticalPosition](/javascript/api/word/word.shape#word-word-shape-relativeverticalposition-member)|The relative vertical position of the shape.| +||[select(selectMultipleShapes?: boolean)](/javascript/api/word/word.shape#word-word-shape-select-member(1))|Selects the shape.| +||[top](/javascript/api/word/word.shape#word-word-shape-top-member)|The distance, in points, from the top edge of the shape to the vertical relative position.| +||[type](/javascript/api/word/word.shape#word-word-shape-type-member)|Gets the shape type.| +||[width](/javascript/api/word/word.shape#word-word-shape-width-member)|The width, in points, of the shape.| +|[ShapeCollection](/javascript/api/word/word.shapecollection)|[getById(id: number)](/javascript/api/word/word.shapecollection#word-word-shapecollection-getbyid-member(1))|Gets a shape by its identifier.| +||[getByIdOrNullObject(id: number)](/javascript/api/word/word.shapecollection#word-word-shapecollection-getbyidornullobject-member(1))|Gets a shape by its identifier.| +||[getByTypes(types: Word.ShapeType[])](/javascript/api/word/word.shapecollection#word-word-shapecollection-getbytypes-member(1))|Gets the shapes that have the specified types.| +||[getFirst()](/javascript/api/word/word.shapecollection#word-word-shapecollection-getfirst-member(1))|Gets the first shape in this collection.| +||[getFirstOrNullObject()](/javascript/api/word/word.shapecollection#word-word-shapecollection-getfirstornullobject-member(1))|Gets the first shape in this collection.| +||[items](/javascript/api/word/word.shapecollection#word-word-shapecollection-items-member)|Gets the loaded child items in this collection.| |[Style](/javascript/api/word/word.style)|[description](/javascript/api/word/word.style#word-word-style-description-member)|Gets the description of the specified style.| diff --git a/generate-docs/API Coverage Report.csv b/generate-docs/API Coverage Report.csv index 3b694c0505..fe502f769f 100644 --- a/generate-docs/API Coverage Report.csv +++ b/generate-docs/API Coverage Report.csv @@ -10670,6 +10670,7 @@ Word.Body,"parentContentControl",Property,Good,false Word.Body,"parentContentControlOrNullObject",Property,Good,false Word.Body,"parentSection",Property,Good,false Word.Body,"parentSectionOrNullObject",Property,Good,false +Word.Body,"shapes",Property,Good,false Word.Body,"style",Property,Good,false Word.Body,"styleBuiltIn",Property,Good,false Word.Body,"tables",Property,Good,true @@ -10704,7 +10705,7 @@ Word.Body,"set(properties)",Method,Poor,false Word.Body,"toJSON()",Method,Poor,false Word.Body,"track()",Method,Poor,false Word.Body,"untrack()",Method,Poor,false -Word.BodyType,N/A,Enum,Fine,true +Word.BodyType,N/A,Enum,Good,true Word.BodyType,"endnote",EnumField,Fine,false Word.BodyType,"footer",EnumField,Fine,false Word.BodyType,"footnote",EnumField,Fine,false @@ -10712,6 +10713,7 @@ Word.BodyType,"header",EnumField,Fine,false Word.BodyType,"mainDoc",EnumField,Fine,false Word.BodyType,"noteItem",EnumField,Fine,false Word.BodyType,"section",EnumField,Fine,false +Word.BodyType,"shape",EnumField,Fine,false Word.BodyType,"tableCell",EnumField,Fine,false Word.BodyType,"unknown",EnumField,Fine,false Word.Border,N/A,Class,Good,true @@ -11492,7 +11494,10 @@ Word.EventSource,N/A,Enum,Good,true Word.EventSource,"local",EnumField,Fine,false Word.EventSource,"remote",EnumField,Fine,false Word.EventType,N/A,Enum,Good,true +Word.EventType,"annotationAdded",EnumField,Fine,false +Word.EventType,"annotationChanged",EnumField,Fine,false Word.EventType,"annotationClicked",EnumField,Fine,false +Word.EventType,"annotationDeleted",EnumField,Fine,false Word.EventType,"annotationHovered",EnumField,Fine,false Word.EventType,"annotationInserted",EnumField,Fine,false Word.EventType,"annotationPopupAction",EnumField,Fine,false @@ -11508,6 +11513,7 @@ Word.EventType,"contentControlDeleted",EnumField,Fine,false Word.EventType,"contentControlEntered",EnumField,Fine,false Word.EventType,"contentControlExited",EnumField,Fine,false Word.EventType,"contentControlSelectionChanged",EnumField,Fine,false +Word.EventType,"documentWordCountChanged",EnumField,Good,false Word.EventType,"paragraphAdded",EnumField,Fine,false Word.EventType,"paragraphChanged",EnumField,Fine,false Word.EventType,"paragraphDeleted",EnumField,Fine,false @@ -11762,6 +11768,11 @@ Word.InsertLocation,"before",EnumField,Fine,false Word.InsertLocation,"end",EnumField,Fine,false Word.InsertLocation,"replace",EnumField,Fine,false Word.InsertLocation,"start",EnumField,Fine,false +Word.InsertShapeOptions,N/A,Class,Good,false +Word.InsertShapeOptions,"height",Property,Good,false +Word.InsertShapeOptions,"left",Property,Good,false +Word.InsertShapeOptions,"top",Property,Good,false +Word.InsertShapeOptions,"width",Property,Good,false Word.List,N/A,Class,Good,true Word.List,"context",Property,Good,false Word.List,"id",Property,Good,false @@ -12036,6 +12047,7 @@ Word.Paragraph,"parentTableCell",Property,Good,false Word.Paragraph,"parentTableCellOrNullObject",Property,Good,false Word.Paragraph,"parentTableOrNullObject",Property,Good,false Word.Paragraph,"rightIndent",Property,Good,false +Word.Paragraph,"shapes",Property,Good,false Word.Paragraph,"spaceAfter",Property,Good,true Word.Paragraph,"spaceBefore",Property,Good,false Word.Paragraph,"style",Property,Good,true @@ -12072,6 +12084,7 @@ Word.Paragraph,"insertOoxml(ooxml, insertLocation)",Method,Fine,false Word.Paragraph,"insertParagraph(paragraphText, insertLocation)",Method,Fine,false Word.Paragraph,"insertTable(rowCount, columnCount, insertLocation, values)",Method,Fine,false Word.Paragraph,"insertText(text, insertLocation)",Method,Poor,true +Word.Paragraph,"insertTextBox(text, insertShapeOptions)",Method,Fine,false Word.Paragraph,"load(options)",Method,Poor,false Word.Paragraph,"load(propertyNames)",Method,Poor,false Word.Paragraph,"load(propertyNamesAndPaths)",Method,Poor,false @@ -12153,6 +12166,7 @@ Word.Range,"parentTable",Property,Good,false Word.Range,"parentTableCell",Property,Good,false Word.Range,"parentTableCellOrNullObject",Property,Good,false Word.Range,"parentTableOrNullObject",Property,Good,false +Word.Range,"shapes",Property,Good,false Word.Range,"style",Property,Good,false Word.Range,"styleBuiltIn",Property,Good,true Word.Range,"tables",Property,Good,false @@ -12191,6 +12205,7 @@ Word.Range,"insertOoxml(ooxml, insertLocation)",Method,Fine,true Word.Range,"insertParagraph(paragraphText, insertLocation)",Method,Fine,true Word.Range,"insertTable(rowCount, columnCount, insertLocation, values)",Method,Fine,false Word.Range,"insertText(text, insertLocation)",Method,Poor,true +Word.Range,"insertTextBox(text, insertShapeOptions)",Method,Fine,false Word.Range,"intersectWith(range)",Method,Poor,false Word.Range,"intersectWithOrNullObject(range)",Method,Poor,false Word.Range,"load(options)",Method,Poor,false @@ -12224,6 +12239,24 @@ Word.RangeLocation,"content",EnumField,Fine,false Word.RangeLocation,"end",EnumField,Good,false Word.RangeLocation,"start",EnumField,Good,false Word.RangeLocation,"whole",EnumField,Good,false +Word.RelativeHorizontalPosition,N/A,Enum,Good,false +Word.RelativeHorizontalPosition,"character",EnumField,Fine,false +Word.RelativeHorizontalPosition,"column",EnumField,Fine,false +Word.RelativeHorizontalPosition,"insideMargin",EnumField,Fine,false +Word.RelativeHorizontalPosition,"leftMargin",EnumField,Fine,false +Word.RelativeHorizontalPosition,"margin",EnumField,Fine,false +Word.RelativeHorizontalPosition,"outsideMargin",EnumField,Fine,false +Word.RelativeHorizontalPosition,"page",EnumField,Fine,false +Word.RelativeHorizontalPosition,"rightMargin",EnumField,Fine,false +Word.RelativeVerticalPosition,N/A,Enum,Good,false +Word.RelativeVerticalPosition,"bottomMargin",EnumField,Fine,false +Word.RelativeVerticalPosition,"insideMargin",EnumField,Fine,false +Word.RelativeVerticalPosition,"line",EnumField,Fine,false +Word.RelativeVerticalPosition,"margin",EnumField,Fine,false +Word.RelativeVerticalPosition,"outsideMargin",EnumField,Fine,false +Word.RelativeVerticalPosition,"page",EnumField,Fine,false +Word.RelativeVerticalPosition,"paragraph",EnumField,Fine,false +Word.RelativeVerticalPosition,"topMargin",EnumField,Fine,false Word.RequestContext,N/A,Class,Good,true Word.RequestContext,"application",Property,Fine,false Word.RequestContext,"document",Property,Missing,false @@ -12356,6 +12389,44 @@ Word.ShadingTextureType,"percent87Pt5",EnumField,Fine,false Word.ShadingTextureType,"percent90",EnumField,Fine,false Word.ShadingTextureType,"percent95",EnumField,Fine,false Word.ShadingTextureType,"solid",EnumField,Fine,false +Word.Shape,N/A,Class,Good,false +Word.Shape,"body",Property,Good,false +Word.Shape,"context",Property,Good,false +Word.Shape,"height",Property,Good,false +Word.Shape,"id",Property,Good,false +Word.Shape,"left",Property,Good,false +Word.Shape,"relativeHorizontalPosition",Property,Good,false +Word.Shape,"relativeVerticalPosition",Property,Good,false +Word.Shape,"top",Property,Good,false +Word.Shape,"type",Property,Good,false +Word.Shape,"width",Property,Good,false +Word.Shape,"delete()",Method,Poor,false +Word.Shape,"load(options)",Method,Poor,false +Word.Shape,"load(propertyNames)",Method,Poor,false +Word.Shape,"load(propertyNamesAndPaths)",Method,Poor,false +Word.Shape,"select(selectMultipleShapes)",Method,Poor,false +Word.Shape,"set(properties, options)",Method,Poor,false +Word.Shape,"set(properties)",Method,Poor,false +Word.Shape,"toJSON()",Method,Poor,false +Word.Shape,"track()",Method,Poor,false +Word.Shape,"untrack()",Method,Poor,false +Word.ShapeCollection,N/A,Class,Good,false +Word.ShapeCollection,"context",Property,Good,false +Word.ShapeCollection,"items",Property,Fine,false +Word.ShapeCollection,"getById(id)",Method,Poor,false +Word.ShapeCollection,"getByIdOrNullObject(id)",Method,Poor,false +Word.ShapeCollection,"getByTypes(types)",Method,Poor,false +Word.ShapeCollection,"getFirst()",Method,Poor,false +Word.ShapeCollection,"getFirstOrNullObject()",Method,Poor,false +Word.ShapeCollection,"load(options)",Method,Poor,false +Word.ShapeCollection,"load(propertyNames)",Method,Poor,false +Word.ShapeCollection,"load(propertyNamesAndPaths)",Method,Poor,false +Word.ShapeCollection,"toJSON()",Method,Poor,false +Word.ShapeCollection,"track()",Method,Poor,false +Word.ShapeCollection,"untrack()",Method,Poor,false +Word.ShapeType,N/A,Enum,Good,false +Word.ShapeType,"textBox",EnumField,Fine,false +Word.ShapeType,"unsupported",EnumField,Fine,false Word.Style,N/A,Class,Good,true Word.Style,"baseStyle",Property,Good,false Word.Style,"borders",Property,Good,true diff --git a/generate-docs/api-extractor-inputs-word/word.d.ts b/generate-docs/api-extractor-inputs-word/word.d.ts index 0d59e81729..8421d80796 100644 --- a/generate-docs/api-extractor-inputs-word/word.d.ts +++ b/generate-docs/api-extractor-inputs-word/word.d.ts @@ -182,9 +182,9 @@ export 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; } /** @@ -295,9 +295,9 @@ export 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; } /** @@ -443,9 +443,9 @@ export 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; } /** @@ -496,9 +496,9 @@ export 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; }; @@ -612,6 +612,14 @@ export declare namespace Word { * [Api set: WordApi 1.3] */ readonly parentSectionOrNullObject: Word.Section; + /** + * Gets the collection of shape objects in the body, including both inline and floating shapes. Currently, only TextBox shapes are supported. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly shapes: Word.ShapeCollection; /** * Gets the collection of table objects in the body. * @@ -646,7 +654,7 @@ export declare namespace Word { * @remarks * [Api set: WordApi 1.3] */ - readonly type: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" | "Footnote" | "Endnote" | "NoteItem"; + readonly type: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" | "Footnote" | "Endnote" | "NoteItem" | "Shape"; /** * 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. @@ -758,7 +766,7 @@ export declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * 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. + * 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'. @@ -942,9 +950,9 @@ export 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; } /** @@ -1029,9 +1037,9 @@ export 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; } /** @@ -1144,9 +1152,9 @@ export 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; } /** @@ -1203,9 +1211,9 @@ export 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; } /** @@ -1334,9 +1342,9 @@ export 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; } /** @@ -1391,9 +1399,9 @@ export 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; } /** @@ -1500,9 +1508,9 @@ export 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; } /** @@ -1608,9 +1616,9 @@ export 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; } /** @@ -1665,13 +1673,13 @@ export 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; } /** - * Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, and checkbox content controls are supported. + * Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, checkbox, dropdown list, and combo box content controls are supported. * * @remarks * [Api set: WordApi 1.1] @@ -2030,7 +2038,7 @@ export declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * 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. + * 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. @@ -2289,13 +2297,13 @@ export 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; } /** - * Contains a collection of {@link Word.ContentControl} objects. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text and plain text content controls are supported. + * Contains a collection of {@link Word.ContentControl} objects. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, checkbox, dropdown list, and combo box content controls are supported. * * @remarks * [Api set: WordApi 1.1] @@ -2409,9 +2417,9 @@ export 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; } /** @@ -2496,9 +2504,9 @@ export declare namespace Word { */ untrack(): Word.ContentControlListItem; /** - * 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.ContentControlListItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ContentControlListItemData`) 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.ContentControlListItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ContentControlListItemData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ContentControlListItemData; } /** @@ -2555,9 +2563,9 @@ export declare namespace Word { */ untrack(): Word.ContentControlListItemCollection; /** - * 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.ContentControlListItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ContentControlListItemCollectionData`) 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.ContentControlListItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ContentControlListItemCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.ContentControlListItemCollectionData; } /** @@ -2653,9 +2661,9 @@ export 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; } /** @@ -2738,9 +2746,9 @@ export 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; } /** @@ -3017,9 +3025,9 @@ export 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; } /** @@ -3103,9 +3111,9 @@ export 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; } /** @@ -3185,9 +3193,9 @@ export 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; } /** @@ -3443,7 +3451,7 @@ export declare namespace Word { * @remarks * [Api set: WordApi 1.5] * - * 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. + * 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'. @@ -3600,9 +3608,9 @@ export 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; } /** @@ -3745,7 +3753,7 @@ export declare namespace Word { * @remarks * [Api set: WordApiHiddenDocument 1.5] * - * 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. + * 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'. @@ -3813,9 +3821,9 @@ export 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; } /** @@ -3991,9 +3999,9 @@ export 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; } /** @@ -4054,9 +4062,9 @@ export declare namespace Word { */ untrack(): Word.DropDownListContentControl; /** - * 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.DropDownListContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DropDownListContentControlData`) 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.DropDownListContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DropDownListContentControlData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.DropDownListContentControlData; } /** @@ -4117,9 +4125,9 @@ export declare namespace Word { */ untrack(): Word.ComboBoxContentControl; /** - * 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.ComboBoxContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ComboBoxContentControlData`) 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.ComboBoxContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ComboBoxContentControlData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ComboBoxContentControlData; } /** @@ -4321,9 +4329,9 @@ export 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; } /** @@ -4393,9 +4401,9 @@ export 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; } /** @@ -4530,9 +4538,9 @@ export 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; } /** @@ -4710,7 +4718,7 @@ export declare namespace Word { * @remarks * [Api set: WordApi 1.2] * - * 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. + * 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'. @@ -4814,9 +4822,9 @@ export 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; } /** @@ -4871,9 +4879,9 @@ export 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; } /** @@ -5096,9 +5104,9 @@ export 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; } /** @@ -5180,9 +5188,9 @@ export 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; } /** @@ -5280,9 +5288,9 @@ export 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; } /** @@ -5409,9 +5417,9 @@ export 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; } /** @@ -5466,9 +5474,9 @@ export 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; } /** @@ -5532,9 +5540,9 @@ export 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; } /** @@ -5626,9 +5634,9 @@ export 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; } /** @@ -5683,9 +5691,9 @@ export 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; } /** @@ -5816,6 +5824,14 @@ export declare namespace Word { * [Api set: WordApi 1.3] */ readonly parentTableOrNullObject: Word.Table; + /** + * Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes. Currently, only TextBox shapes are supported. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly shapes: Word.ShapeCollection; /** * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. * @@ -6138,7 +6154,7 @@ export declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * 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. + * 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'. @@ -6206,6 +6222,17 @@ export declare namespace Word { * @param insertLocation - Required. The value must be 'Replace', 'Start', or 'End'. */ insertText(text: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; + /** + * Inserts a floating text box with its anchor at the beginning of the paragraph. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param text - Optional. The text to insert into the text box. + * @param insertShapeOptions - Optional. The size and location of the text box. The default location and size is (0, 0, 100, 100). + */ + insertTextBox(text?: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; /** * Performs a search with the specified SearchOptions on the scope of the paragraph object. The search results are a collection of range objects. * @@ -6340,9 +6367,9 @@ export 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; } /** @@ -6411,9 +6438,9 @@ export 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; } /** @@ -6561,9 +6588,9 @@ export 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; } /** @@ -6682,6 +6709,14 @@ export declare namespace Word { * [Api set: WordApi 1.3] */ readonly parentTableOrNullObject: Word.Table; + /** + * Gets the collection of shape objects anchored in the range, including both inline and floating shapes. Currently, only TextBox shapes are supported. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly shapes: Word.ShapeCollection; /** * Gets the collection of table objects in the range. * @@ -6756,7 +6791,7 @@ export declare namespace Word { */ delete(): void; /** - * Returns a new range that extends from this range in either direction to cover another range. This range isn't changed. Throws an `ItemNotFound` error if the two ranges do not have a union. + * Returns a new range that extends from this range in either direction to cover another range. This range isn't changed. Throws an `ItemNotFound` error if the two ranges don't have a union. * * @remarks * [Api set: WordApi 1.3] @@ -7007,7 +7042,7 @@ export declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * 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. + * 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'. @@ -7084,6 +7119,17 @@ export declare namespace Word { * @param insertLocation - Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. */ insertText(text: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range; + /** + * Inserts a floating text box with its anchor at the beginning of the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param text - Optional. The text to insert into the text box. + * @param insertShapeOptions - Optional. The size and location of the text box. The default location and size is (0, 0, 100, 100). + */ + insertTextBox(text?: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; /** * Returns a new range as the intersection of this range with another range. This range isn't changed. Throws an `ItemNotFound` error if the two ranges aren't overlapped or adjacent. * @@ -7227,9 +7273,9 @@ export 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; } /** @@ -7284,11 +7330,52 @@ export 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; } + /** + * Specifies the options to determine size and location when inserting a shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface InsertShapeOptions { + /** + * Represents the height of the shape being inserted. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + height?: number; + /** + * Represents the left position of the shape being inserted. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + left?: number; + /** + * Represents the top position of the shape being inserted. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + top?: number; + /** + * Represents the width of the shape being inserted. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + width?: number; + } /** * Specifies the options to determine what to copy when inserting a file. * @@ -7446,9 +7533,9 @@ export 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; } /** @@ -7635,9 +7722,9 @@ export 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; } /** @@ -7692,9 +7779,9 @@ export 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; } /** @@ -7765,9 +7852,9 @@ export 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; } /** @@ -7850,9 +7937,9 @@ export 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; } /** @@ -7927,9 +8014,9 @@ export 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; } /** @@ -8117,9 +8204,9 @@ export 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; } /** @@ -8190,9 +8277,9 @@ export 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; } /** @@ -8726,9 +8813,9 @@ export 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; } /** @@ -8827,9 +8914,9 @@ export 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; } /** @@ -8884,9 +8971,9 @@ export 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; } /** @@ -9179,9 +9266,9 @@ export 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; } /** @@ -9236,9 +9323,9 @@ export 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; } /** @@ -9481,9 +9568,9 @@ export 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; } /** @@ -9538,9 +9625,9 @@ export 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; } /** @@ -9611,9 +9698,9 @@ export 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; } /** @@ -9718,9 +9805,9 @@ export 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; } /** @@ -9789,132 +9876,365 @@ export 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; } /** - * ChangeTracking mode. + * Represents a shape in the header footer or document body. Currently, only TextBox shapes are supported. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum ChangeTrackingMode { + export class Shape extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * ChangeTracking is turned off. + * Represents the body object of the shape. Only applies to TextBox shapes. + * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - off = "Off", + readonly body: Word.Body; /** - * ChangeTracking is turned on for everyone. + * The height, in points, of the shape. + * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - trackAll = "TrackAll", + height: number; /** - * Tracking is turned on for my changes only. + * Gets an integer that represents the shape identifier. + * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - trackMineOnly = "TrackMineOnly", - } - /** - * Specify the current version or the original version of the text. - * - * @remarks - * [Api set: WordApi 1.4] - */ - enum ChangeTrackingVersion { + readonly id: number; /** + * The distance, in points, from the left side of the shape to the horizontal relative position. For a floating shape, it will return 0 and can't be set. + * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - original = "Original", + left: number; /** + * The relative horizontal position of the shape. For a floating shape, it can't be set. + * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - current = "Current", - } - /** - * Specify the track state when ChangeTracking is on. - * - * @remarks - * [Api set: WordApi 1.5] - */ - enum ChangeTrackingState { + relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** + * The relative vertical position of the shape. For a floating shape, it can't be set. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - unknown = "Unknown", + relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** + * The distance, in points, from the top edge of the shape to the vertical relative position. For a floating shape, it will return 0 and can't be set. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - normal = "Normal", + top: number; /** + * Gets the shape type. Currently, only TextBox shapes are supported. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - added = "Added", + readonly type: Word.ShapeType | "Unsupported" | "TextBox"; /** + * The width, in points, of the shape. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - deleted = "Deleted", - } - /** - * TrackedChange type. - * - * @remarks - * [Api set: WordApi 1.6] - */ - enum TrackedChangeType { + width: number; /** - * No revision. - * @remarks - * [Api set: WordApi 1.6] + * 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. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - none = "None", + set(properties: Interfaces.ShapeUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Shape): void; /** - * Add change. + * Deletes the shape and its content. + * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - added = "Added", + delete(): void; /** - * Delete change. + * Selects the shape. + * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param selectMultipleShapes - Optional. Whether to select multiple floating shapes. The default value is false. */ - deleted = "Deleted", + select(selectMultipleShapes?: boolean): void; /** - * Format change. - * @remarks - * [Api set: WordApi 1.6] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. */ - formatted = "Formatted", - } - /** - * Note item type - * - * @remarks - * [Api set: WordApi 1.5] - */ - enum NoteItemType { + load(options?: Word.Interfaces.ShapeLoadOptions): Word.Shape; /** - * @remarks - * [Api set: WordApi 1.5] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - footnote = "Footnote", + load(propertyNames?: string | string[]): Word.Shape; /** - * @remarks - * [Api set: WordApi 1.5] - */ - endnote = "Endnote", + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Shape; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.Shape; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + 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. + */ + toJSON(): Word.Interfaces.ShapeData; + } + /** + * Contains a collection of {@link Word.Shape} objects. Currently, only TextBox shapes are supported. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class ShapeCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.Shape[]; + /** + * Gets a shape by its identifier. Throws an `ItemNotFound` error if there isn't a shape with the identifier in this collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param id - Required. A shape identifier. + */ + getById(id: number): Word.Shape; + /** + * Gets a shape by its identifier. If there isn't a shape with the identifier in this collection, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param id - Required. A shape identifier. + */ + getByIdOrNullObject(id: number): Word.Shape; + /** + * Gets the shapes that have the specified types. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param types - Required. An array of shape types. + */ + getByTypes(types: Word.ShapeType[]): Word.ShapeCollection; + /** + * Gets the first shape in this collection. Throws an `ItemNotFound` error if this collection is empty. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + getFirst(): Word.Shape; + /** + * Gets the first shape in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + getFirstOrNullObject(): Word.Shape; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.ShapeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ShapeCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.ShapeCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ShapeCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.ShapeCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + 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. + */ + toJSON(): Word.Interfaces.ShapeCollectionData; + } + /** + * ChangeTracking mode. + * + * @remarks + * [Api set: WordApi 1.4] + */ + enum ChangeTrackingMode { + /** + * ChangeTracking is turned off. + * @remarks + * [Api set: WordApi 1.4] + */ + off = "Off", + /** + * ChangeTracking is turned on for everyone. + * @remarks + * [Api set: WordApi 1.4] + */ + trackAll = "TrackAll", + /** + * Tracking is turned on for my changes only. + * @remarks + * [Api set: WordApi 1.4] + */ + trackMineOnly = "TrackMineOnly", + } + /** + * Specify the current version or the original version of the text. + * + * @remarks + * [Api set: WordApi 1.4] + */ + enum ChangeTrackingVersion { + /** + * @remarks + * [Api set: WordApi 1.4] + */ + original = "Original", + /** + * @remarks + * [Api set: WordApi 1.4] + */ + current = "Current", + } + /** + * Specify the track state when ChangeTracking is on. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum ChangeTrackingState { + /** + * @remarks + * [Api set: WordApi 1.5] + */ + unknown = "Unknown", + /** + * @remarks + * [Api set: WordApi 1.5] + */ + normal = "Normal", + /** + * @remarks + * [Api set: WordApi 1.5] + */ + added = "Added", + /** + * @remarks + * [Api set: WordApi 1.5] + */ + deleted = "Deleted", + } + /** + * TrackedChange type. + * + * @remarks + * [Api set: WordApi 1.6] + */ + enum TrackedChangeType { + /** + * No revision. + * @remarks + * [Api set: WordApi 1.6] + */ + none = "None", + /** + * Add change. + * @remarks + * [Api set: WordApi 1.6] + */ + added = "Added", + /** + * Delete change. + * @remarks + * [Api set: WordApi 1.6] + */ + deleted = "Deleted", + /** + * Format change. + * @remarks + * [Api set: WordApi 1.6] + */ + formatted = "Formatted", + } + /** + * Note item type + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum NoteItemType { + /** + * @remarks + * [Api set: WordApi 1.5] + */ + footnote = "Footnote", + /** + * @remarks + * [Api set: WordApi 1.5] + */ + endnote = "Endnote", } /** * Provides information about the type of a raised event. @@ -9947,6 +10267,24 @@ export declare namespace Word { * [Api set: WordApi 1.5] */ contentControlAdded = "ContentControlAdded", + /** + * AnnotationAdded represents the event an annotation has been added to the document. + * @remarks + * [Api set: WordApiOnline 1.1] + */ + annotationAdded = "AnnotationAdded", + /** + * AnnotationChanged represents the event an annotation has been updated in the document. + * @remarks + * [Api set: WordApiOnline 1.1] + */ + annotationChanged = "AnnotationChanged", + /** + * AnnotationDeleted represents the event an annotation has been deleted from the document. + * @remarks + * [Api set: WordApiOnline 1.1] + */ + annotationDeleted = "AnnotationDeleted", /** * Represents that one or more comments were deleted. * @remarks @@ -9994,6 +10332,12 @@ export declare namespace Word { * [Api set: WordApi 1.5] */ contentControlExited = "ContentControlExited", + /** + * Represents that a word count has been changed. + * @remarks + * [Api set: WordApi Unknown Version, this API may or may not work on a client. This API may not be released to 3rd parties.] + */ + documentWordCountChanged = "DocumentWordCountChanged", /** * Represents that one or more new paragraphs were added. * @remarks @@ -10074,7 +10418,7 @@ export declare namespace Word { * @remarks * [Api set: WordApi 1.5] */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** * Gets the content control IDs. * @@ -10103,7 +10447,7 @@ export declare namespace Word { * @remarks * [Api set: WordApi 1.5] */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** * Gets the content control IDs. * @@ -10132,7 +10476,7 @@ export declare namespace Word { * @remarks * [Api set: WordApi 1.5] */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** * Gets the content control IDs. * @@ -10161,7 +10505,7 @@ export declare namespace Word { * @remarks * [Api set: WordApi 1.5] */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** * Gets the content control IDs. * @@ -10190,7 +10534,7 @@ export declare namespace Word { * @remarks * [Api set: WordApi 1.5] */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** * Gets the content control IDs. * @@ -10219,7 +10563,7 @@ export declare namespace Word { * @remarks * [Api set: WordApi 1.5] */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** * Gets the content control IDs. * @@ -10255,7 +10599,7 @@ export declare namespace Word { * @remarks * [Api set: WordApi 1.6] */ - type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** * Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors. * @@ -10284,7 +10628,7 @@ export declare namespace Word { * @remarks * [Api set: WordApi 1.6] */ - type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** * Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors. * @@ -10313,7 +10657,7 @@ export declare namespace Word { * @remarks * [Api set: WordApi 1.6] */ - type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** * Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors. * @@ -10361,7 +10705,7 @@ export declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; } /** * A structure for the ID and reply IDs of this comment. @@ -10880,55 +11224,73 @@ export declare namespace Word { evenPages = "EvenPages", } /** + * Represents the types of body objects. + * * @remarks * [Api set: WordApi 1.3] */ enum BodyType { /** + * Unknown body type. * @remarks * [Api set: WordApi 1.3] */ unknown = "Unknown", /** + * Main document body. * @remarks * [Api set: WordApi 1.3] */ mainDoc = "MainDoc", /** + * Section body. * @remarks * [Api set: WordApi 1.3] */ section = "Section", /** + * Header body. * @remarks * [Api set: WordApi 1.3] */ header = "Header", /** + * Footer body. * @remarks * [Api set: WordApi 1.3] */ footer = "Footer", /** + * Table cell body. * @remarks * [Api set: WordApi 1.3] */ tableCell = "TableCell", /** + * Footnote body. * @remarks * [Api set: WordApi 1.5] */ footnote = "Footnote", /** + * Endnote body. * @remarks * [Api set: WordApi 1.5] */ endnote = "Endnote", /** + * Note body e.g., endnote, footnote. * @remarks * [Api set: WordApi 1.5] */ noteItem = "NoteItem", + /** + * Shape body. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shape = "Shape", } /** * This enum sets where the cursor (insertion point) in the document is after a selection. @@ -13729,28 +14091,183 @@ export declare namespace Word { */ createNew = "CreateNew", } - enum ErrorCodes { - accessDenied = "AccessDenied", - generalException = "GeneralException", - invalidArgument = "InvalidArgument", - itemNotFound = "ItemNotFound", - notAllowed = "NotAllowed", - notImplemented = "NotImplemented", - searchDialogIsOpen = "SearchDialogIsOpen", - searchStringInvalidOrTooLong = "SearchStringInvalidOrTooLong", + /** + * Represents the shape type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ShapeType { + /** + * Unsupported shape type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + unsupported = "Unsupported", + /** + * Text box shape. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textBox = "TextBox", } - export namespace Interfaces { + /** + * Represents what the horizontal position 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum RelativeHorizontalPosition { /** - * Provides ways to load properties of only a subset of members of a collection. + * Relative to margin. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ + margin = "Margin", + /** + * Relative to page. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + page = "Page", + /** + * Relative to column. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + column = "Column", + /** + * Relative to character. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + character = "Character", + /** + * Relative to left margin. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + leftMargin = "LeftMargin", + /** + * Relative to right margin. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rightMargin = "RightMargin", + /** + * Relative to inside margin. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insideMargin = "InsideMargin", + /** + * Relative to outside margin. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + outsideMargin = "OutsideMargin", + } + /** + * Represents what the vertical position 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum RelativeVerticalPosition { + /** + * Relative to margin. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + margin = "Margin", + /** + * Relative to page. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + page = "Page", + /** + * Relative to paragraph. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + paragraph = "Paragraph", + /** + * Relative to line. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + line = "Line", + /** + * Relative to top margin. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + topMargin = "TopMargin", + /** + * Relative to bottom margin. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bottomMargin = "BottomMargin", + /** + * Relative to inside margin. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insideMargin = "InsideMargin", + /** + * Relative to outside margin. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + outsideMargin = "OutsideMargin", + } + enum ErrorCodes { + accessDenied = "AccessDenied", + generalException = "GeneralException", + invalidArgument = "InvalidArgument", + itemNotFound = "ItemNotFound", + notAllowed = "NotAllowed", + notImplemented = "NotImplemented", + searchDialogIsOpen = "SearchDialogIsOpen", + searchStringInvalidOrTooLong = "SearchStringInvalidOrTooLong", + } + export namespace Interfaces { + /** + * Provides ways to load properties of only a subset of members of a collection. + */ export 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({ ... })`. */ @@ -13760,11 +14277,11 @@ export declare namespace Word { /** An interface for updating data on the `Body` object, for use in `body.set({ ... })`. */ export 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. @@ -13871,11 +14388,11 @@ export declare namespace Word { /** An interface for updating data on the `Comment` object, for use in `comment.set({ ... })`. */ export 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. @@ -13937,18 +14454,18 @@ export declare namespace Word { /** An interface for updating data on the `CommentReply` object, for use in `commentReply.set({ ... })`. */ export 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. @@ -13965,18 +14482,18 @@ export declare namespace Word { /** An interface for updating data on the `ContentControl` object, for use in `contentControl.set({ ... })`. */ export 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'. @@ -14106,18 +14623,18 @@ export declare namespace Word { /** An interface for updating data on the `Document` object, for use in `document.set({ ... })`. */ export 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. @@ -14130,18 +14647,18 @@ export declare namespace Word { /** An interface for updating data on the `DocumentCreated` object, for use in `documentCreated.set({ ... })`. */ export 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({ ... })`. */ @@ -14213,11 +14730,11 @@ export declare namespace Word { /** An interface for updating data on the `Field` object, for use in `field.set({ ... })`. */ export 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. @@ -14408,11 +14925,11 @@ export declare namespace Word { /** An interface for updating data on the `ListLevel` object, for use in `listLevel.set({ ... })`. */ export 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'. @@ -14502,18 +15019,18 @@ export declare namespace Word { /** An interface for updating data on the `NoteItem` object, for use in `noteItem.set({ ... })`. */ export 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({ ... })`. */ @@ -14523,25 +15040,25 @@ export declare namespace Word { /** An interface for updating data on the `Paragraph` object, for use in `paragraph.set({ ... })`. */ export interface ParagraphUpdateData { /** - * 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.FontUpdateData; /** - * 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.ListItemUpdateData; /** - * 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.ListItemUpdateData; /** * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. @@ -14736,11 +15253,11 @@ export declare namespace Word { /** An interface for updating data on the `Range` object, for use in `range.set({ ... })`. */ export 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. @@ -14823,11 +15340,11 @@ export declare namespace Word { /** An interface for updating data on the `Section` object, for use in `section.set({ ... })`. */ export 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({ ... })`. */ @@ -14855,46 +15372,46 @@ export declare namespace Word { /** An interface for updating data on the `Style` object, for use in `style.set({ ... })`. */ export 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. @@ -14970,11 +15487,11 @@ export declare namespace Word { /** An interface for updating data on the `Table` object, for use in `table.set({ ... })`. */ export 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'. @@ -15134,11 +15651,11 @@ export declare namespace Word { /** An interface for updating data on the `TableRow` object, for use in `tableRow.set({ ... })`. */ export 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'. @@ -15183,11 +15700,11 @@ export declare namespace Word { /** An interface for updating data on the `TableCell` object, for use in `tableCell.set({ ... })`. */ export 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. @@ -15257,6 +15774,69 @@ export declare namespace Word { export interface TrackedChangeCollectionUpdateData { items?: Word.Interfaces.TrackedChangeData[]; } + /** An interface for updating data on the `Shape` object, for use in `shape.set({ ... })`. */ + export interface ShapeUpdateData { + /** + * Represents the body object of the shape. Only applies to TextBox shapes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + body?: Word.Interfaces.BodyUpdateData; + /** + * The height, in points, of the shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + height?: number; + /** + * The distance, in points, from the left side of the shape to the horizontal relative position. For a floating shape, it will return 0 and can't be set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + left?: number; + /** + * The relative horizontal position of the shape. For a floating shape, it can't be set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + /** + * The relative vertical position of the shape. For a floating shape, it can't be set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + /** + * The distance, in points, from the top edge of the shape to the vertical relative position. For a floating shape, it will return 0 and can't be set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + top?: number; + /** + * The width, in points, of the shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + width?: number; + } + /** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */ + export interface ShapeCollectionUpdateData { + items?: Word.Interfaces.ShapeData[]; + } /** An interface describing the data returned by calling `critiqueAnnotation.toJSON()`. */ export interface CritiqueAnnotationData { /** @@ -15291,55 +15871,63 @@ export declare namespace Word { /** An interface describing the data returned by calling `body.toJSON()`. */ export 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 table objects in the body. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the collection of shape objects in the body, including both inline and floating shapes. Currently, only TextBox shapes are supported. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shapes?: Word.Interfaces.ShapeData[]; + /** + * 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. @@ -15368,7 +15956,7 @@ export declare namespace Word { * @remarks * [Api set: WordApi 1.3] */ - type?: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" | "Footnote" | "Endnote" | "NoteItem"; + type?: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" | "Footnote" | "Endnote" | "NoteItem" | "Shape"; } /** An interface describing the data returned by calling `border.toJSON()`. */ export interface BorderData { @@ -15596,96 +16184,96 @@ export declare namespace Word { /** An interface describing the data returned by calling `contentControl.toJSON()`. */ export 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. + * 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] + */ + inlinePictures?: Word.Interfaces.InlinePictureData[]; + /** + * 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. + */ + paragraphs?: Word.Interfaces.ParagraphData[]; + /** + * 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'. * * @remarks * [Api set: WordApi 1.1] */ - font?: Word.Interfaces.FontData; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Gets the collection of InlinePicture objects in the content control. The collection doesn't include floating images. + * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. * * @remarks * [Api set: WordApi 1.1] */ - inlinePictures?: Word.Interfaces.InlinePictureData[]; + cannotDelete?: boolean; /** - * Gets the collection of list objects in the content control. + * Specifies a value that indicates whether the user can edit the contents of 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. - */ - paragraphs?: Word.Interfaces.ParagraphData[]; - /** - * 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'. - * - * @remarks - * [Api set: WordApi 1.1] - */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; - /** - * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. - * - * @remarks - * [Api set: WordApi 1.1] - */ - cannotDelete?: boolean; - /** - * Specifies a value that indicates whether the user can edit the contents of the content control. - * - * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.1] */ cannotEdit?: boolean; /** @@ -16361,11 +16949,11 @@ export declare namespace Word { /** An interface describing the data returned by calling `listLevel.toJSON()`. */ export 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'. @@ -16445,11 +17033,11 @@ export declare namespace Word { /** An interface describing the data returned by calling `listTemplate.toJSON()`. */ export 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. @@ -16462,18 +17050,18 @@ export declare namespace Word { /** An interface describing the data returned by calling `noteItem.toJSON()`. */ export 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. @@ -16490,40 +17078,48 @@ export declare namespace Word { /** An interface describing the data returned by calling `paragraph.toJSON()`. */ export 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}. - * - * @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.ListItemData; + /** + * Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes. Currently, only TextBox shapes are supported. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shapes?: Word.Interfaces.ShapeData[]; /** * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. * @@ -16752,26 +17348,34 @@ export declare namespace Word { /** An interface describing the data returned by calling `range.toJSON()`. */ export interface RangeData { /** - * Gets the collection of field objects in the range. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the collection of field objects in the range. + * + * @remarks + * [Api set: WordApi 1.4] + */ fields?: Word.Interfaces.FieldData[]; /** - * 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.FontData; /** - * Gets the collection of inline picture objects in the range. - * - * @remarks - * [Api set: WordApi 1.2] - */ + * Gets the collection of inline picture objects in the range. + * + * @remarks + * [Api set: WordApi 1.2] + */ inlinePictures?: Word.Interfaces.InlinePictureData[]; + /** + * Gets the collection of shape objects anchored in the range, including both inline and floating shapes. Currently, only TextBox shapes are supported. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shapes?: Word.Interfaces.ShapeData[]; /** * 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. * @@ -16867,11 +17471,11 @@ export declare namespace Word { /** An interface describing the data returned by calling `section.toJSON()`. */ export 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()`. */ @@ -16906,46 +17510,46 @@ export declare namespace Word { /** An interface describing the data returned by calling `style.toJSON()`. */ export 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. @@ -17064,32 +17668,32 @@ export declare namespace Word { /** An interface describing the data returned by calling `table.toJSON()`. */ export 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'. @@ -17354,11 +17958,11 @@ export declare namespace Word { /** An interface describing the data returned by calling `tableCell.toJSON()`. */ export 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. @@ -17480,49 +18084,128 @@ export declare namespace Word { export interface TrackedChangeCollectionData { items?: Word.Interfaces.TrackedChangeData[]; } - /** - * Represents an annotation wrapper around critique displayed in the document. - * - * @remarks - * [Api set: WordApi 1.7] - */ - export interface CritiqueAnnotationLoadOptions { + /** An interface describing the data returned by calling `shape.toJSON()`. */ + export interface ShapeData { /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). - */ - $all?: boolean; + * Represents the body object of the shape. Only applies to TextBox shapes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + body?: Word.Interfaces.BodyData; /** - * Gets the range of text that is annotated. + * The height, in points, of the shape. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + height?: number; /** - * Gets the critique that was passed when the annotation was inserted. + * Gets an integer that represents the shape identifier. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - critique?: boolean; - } - /** - * Represents an annotation attached to a paragraph. - * - * @remarks - * [Api set: WordApi 1.7] - */ - export interface AnnotationLoadOptions { + id?: number; + /** + * The distance, in points, from the left side of the shape to the horizontal relative position. For a floating shape, it will return 0 and can't be set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + left?: number; + /** + * The relative horizontal position of the shape. For a floating shape, it can't be set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + /** + * The relative vertical position of the shape. For a floating shape, it can't be set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + /** + * The distance, in points, from the top edge of the shape to the vertical relative position. For a floating shape, it will return 0 and can't be set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + top?: number; + /** + * Gets the shape type. Currently, only TextBox shapes are supported. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type?: Word.ShapeType | "Unsupported" | "TextBox"; + /** + * The width, in points, of the shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + width?: number; + } + /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */ + export interface ShapeCollectionData { + items?: Word.Interfaces.ShapeData[]; + } + /** + * Represents an annotation wrapper around critique displayed in the document. + * + * @remarks + * [Api set: WordApi 1.7] + */ + export interface CritiqueAnnotationLoadOptions { /** Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ $all?: boolean; /** - * Gets the critique annotation object. + * 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. * * @remarks * [Api set: WordApi 1.7] */ + critique?: boolean; + } + /** + * Represents an annotation attached to a paragraph. + * + * @remarks + * [Api set: WordApi 1.7] + */ + export interface AnnotationLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * 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. @@ -17551,11 +18234,11 @@ export 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. @@ -17584,53 +18267,53 @@ export 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. @@ -17786,11 +18469,11 @@ export 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. @@ -17847,11 +18530,11 @@ export 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. @@ -17967,18 +18650,18 @@ export 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. @@ -18028,18 +18711,18 @@ export 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. @@ -18078,7 +18761,7 @@ export declare namespace Word { id?: boolean; } /** - * Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, and checkbox content controls are supported. + * Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, checkbox, dropdown list, and combo box content controls are supported. * * @remarks * [Api set: WordApi 1.1] @@ -18089,67 +18772,67 @@ export 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'. @@ -18251,7 +18934,7 @@ export declare namespace Word { type?: boolean; } /** - * Contains a collection of {@link Word.ContentControl} objects. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text and plain text content controls are supported. + * Contains a collection of {@link Word.ContentControl} objects. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, checkbox, dropdown list, and combo box content controls are supported. * * @remarks * [Api set: WordApi 1.1] @@ -18262,67 +18945,67 @@ export 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'. @@ -18645,18 +19328,18 @@ export 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. @@ -18685,18 +19368,18 @@ export 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. @@ -18855,60 +19538,60 @@ export 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. @@ -18973,60 +19656,60 @@ export 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. @@ -19182,53 +19865,53 @@ export 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. @@ -19292,53 +19975,53 @@ export 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. @@ -19501,11 +20184,11 @@ export 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'. @@ -19590,11 +20273,11 @@ export 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'. @@ -19698,18 +20381,18 @@ export 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. @@ -19731,18 +20414,18 @@ export 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. @@ -19764,88 +20447,88 @@ export 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'. @@ -19979,88 +20662,88 @@ export 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'. @@ -20304,60 +20987,60 @@ export 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. @@ -20407,60 +21090,60 @@ export declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: 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] - */ + * For EACH ITEM in the collection: 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; /** - * For EACH ITEM in the collection: Gets the parent body of the range. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the parent body of the range. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentBody?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: 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] - */ + * For EACH ITEM in the collection: 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; /** - * For EACH ITEM in the collection: 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] - */ + * For EACH ITEM in the collection: 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; /** - * For EACH ITEM in the collection: Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: 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] - */ + * For EACH ITEM in the collection: 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; /** - * For EACH ITEM in the collection: 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] - */ + * For EACH ITEM in the collection: 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; /** * For EACH ITEM in the collection: 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. @@ -20572,11 +21255,11 @@ export 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; } /** @@ -20591,11 +21274,11 @@ export 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; } /** @@ -20662,46 +21345,46 @@ export 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. @@ -20805,46 +21488,46 @@ export declare namespace Word { */ $all?: boolean; /** - * 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] - */ + * 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] + */ 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. @@ -20981,60 +21664,60 @@ export 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'. @@ -21229,60 +21912,60 @@ export 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'. @@ -21416,18 +22099,18 @@ export 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. @@ -21498,18 +22181,18 @@ export 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. @@ -21580,25 +22263,25 @@ export 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. @@ -21669,25 +22352,25 @@ export 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. @@ -21859,6 +22542,176 @@ export declare namespace Word { */ type?: boolean; } + /** + * Represents a shape in the header footer or document body. Currently, only TextBox shapes are supported. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface ShapeLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the body object of the shape. Only applies to TextBox shapes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + body?: Word.Interfaces.BodyLoadOptions; + /** + * The height, in points, of the shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + height?: boolean; + /** + * Gets an integer that represents the shape identifier. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + id?: boolean; + /** + * The distance, in points, from the left side of the shape to the horizontal relative position. For a floating shape, it will return 0 and can't be set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + left?: boolean; + /** + * The relative horizontal position of the shape. For a floating shape, it can't be set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + relativeHorizontalPosition?: boolean; + /** + * The relative vertical position of the shape. For a floating shape, it can't be set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + relativeVerticalPosition?: boolean; + /** + * The distance, in points, from the top edge of the shape to the vertical relative position. For a floating shape, it will return 0 and can't be set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + top?: boolean; + /** + * Gets the shape type. Currently, only TextBox shapes are supported. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type?: boolean; + /** + * The width, in points, of the shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + width?: boolean; + } + /** + * Contains a collection of {@link Word.Shape} objects. Currently, only TextBox shapes are supported. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface ShapeCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Represents the body object of the shape. Only applies to TextBox shapes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + body?: Word.Interfaces.BodyLoadOptions; + /** + * For EACH ITEM in the collection: The height, in points, of the shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + height?: boolean; + /** + * For EACH ITEM in the collection: Gets an integer that represents the shape identifier. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + id?: boolean; + /** + * For EACH ITEM in the collection: The distance, in points, from the left side of the shape to the horizontal relative position. For a floating shape, it will return 0 and can't be set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + left?: boolean; + /** + * For EACH ITEM in the collection: The relative horizontal position of the shape. For a floating shape, it can't be set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + relativeHorizontalPosition?: boolean; + /** + * For EACH ITEM in the collection: The relative vertical position of the shape. For a floating shape, it can't be set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + relativeVerticalPosition?: boolean; + /** + * For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the vertical relative position. For a floating shape, it will return 0 and can't be set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + top?: boolean; + /** + * For EACH ITEM in the collection: Gets the shape type. Currently, only TextBox shapes are supported. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type?: boolean; + /** + * For EACH ITEM in the collection: The width, in points, of the shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + width?: boolean; + } } } export declare namespace Word { diff --git a/generate-docs/script-inputs/office_preview.d.ts b/generate-docs/script-inputs/office_preview.d.ts index 1d3f3eccad..7222786dcb 100644 --- a/generate-docs/script-inputs/office_preview.d.ts +++ b/generate-docs/script-inputs/office_preview.d.ts @@ -94354,9 +94354,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; } /** @@ -94467,9 +94467,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; } /** @@ -94615,9 +94615,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; } /** @@ -94668,9 +94668,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; }; @@ -94784,6 +94784,14 @@ declare namespace Word { * [Api set: WordApi 1.3] */ readonly parentSectionOrNullObject: Word.Section; + /** + * Gets the collection of shape objects in the body, including both inline and floating shapes. Currently, only TextBox shapes are supported. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly shapes: Word.ShapeCollection; /** * Gets the collection of table objects in the body. * @@ -94818,7 +94826,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] */ - readonly type: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" | "Footnote" | "Endnote" | "NoteItem"; + readonly type: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" | "Footnote" | "Endnote" | "NoteItem" | "Shape"; /** * 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. @@ -94930,7 +94938,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * 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. + * 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'. @@ -95114,9 +95122,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; } /** @@ -95201,9 +95209,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; } /** @@ -95316,9 +95324,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; } /** @@ -95375,9 +95383,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; } /** @@ -95506,9 +95514,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; } /** @@ -95563,9 +95571,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; } /** @@ -95672,9 +95680,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; } /** @@ -95780,9 +95788,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; } /** @@ -95837,13 +95845,13 @@ 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; } /** - * Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, and checkbox content controls are supported. + * Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, checkbox, dropdown list, and combo box content controls are supported. * * @remarks * [Api set: WordApi 1.1] @@ -96202,7 +96210,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * 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. + * 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. @@ -96461,13 +96469,13 @@ 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; } /** - * Contains a collection of {@link Word.ContentControl} objects. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text and plain text content controls are supported. + * Contains a collection of {@link Word.ContentControl} objects. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, checkbox, dropdown list, and combo box content controls are supported. * * @remarks * [Api set: WordApi 1.1] @@ -96581,9 +96589,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; } /** @@ -96668,9 +96676,9 @@ declare namespace Word { */ untrack(): Word.ContentControlListItem; /** - * 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.ContentControlListItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ContentControlListItemData`) 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.ContentControlListItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ContentControlListItemData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ContentControlListItemData; } /** @@ -96727,9 +96735,9 @@ declare namespace Word { */ untrack(): Word.ContentControlListItemCollection; /** - * 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.ContentControlListItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ContentControlListItemCollectionData`) 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.ContentControlListItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ContentControlListItemCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.ContentControlListItemCollectionData; } /** @@ -96825,9 +96833,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; } /** @@ -96910,9 +96918,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; } /** @@ -97189,9 +97197,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; } /** @@ -97275,9 +97283,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; } /** @@ -97357,9 +97365,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; } /** @@ -97615,7 +97623,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.5] * - * 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. + * 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'. @@ -97772,9 +97780,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; } /** @@ -97917,7 +97925,7 @@ declare namespace Word { * @remarks * [Api set: WordApiHiddenDocument 1.5] * - * 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. + * 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'. @@ -97985,9 +97993,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; } /** @@ -98163,9 +98171,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; } /** @@ -98226,9 +98234,9 @@ declare namespace Word { */ untrack(): Word.DropDownListContentControl; /** - * 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.DropDownListContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DropDownListContentControlData`) 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.DropDownListContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DropDownListContentControlData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.DropDownListContentControlData; } /** @@ -98289,9 +98297,9 @@ declare namespace Word { */ untrack(): Word.ComboBoxContentControl; /** - * 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.ComboBoxContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ComboBoxContentControlData`) 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.ComboBoxContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ComboBoxContentControlData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ComboBoxContentControlData; } /** @@ -98493,9 +98501,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; } /** @@ -98565,9 +98573,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; } /** @@ -98702,9 +98710,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; } /** @@ -98882,7 +98890,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.2] * - * 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. + * 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'. @@ -98986,9 +98994,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; } /** @@ -99043,9 +99051,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; } /** @@ -99268,9 +99276,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; } /** @@ -99352,9 +99360,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; } /** @@ -99452,9 +99460,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; } /** @@ -99581,9 +99589,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; } /** @@ -99638,9 +99646,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; } /** @@ -99704,9 +99712,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; } /** @@ -99798,9 +99806,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; } /** @@ -99855,9 +99863,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; } /** @@ -99988,6 +99996,14 @@ declare namespace Word { * [Api set: WordApi 1.3] */ readonly parentTableOrNullObject: Word.Table; + /** + * Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes. Currently, only TextBox shapes are supported. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly shapes: Word.ShapeCollection; /** * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. * @@ -100310,7 +100326,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * 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. + * 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'. @@ -100378,6 +100394,17 @@ declare namespace Word { * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. */ insertText(text: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; + /** + * Inserts a floating text box with its anchor at the beginning of the paragraph. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param text Optional. The text to insert into the text box. + * @param insertShapeOptions Optional. The size and location of the text box. The default location and size is (0, 0, 100, 100). + */ + insertTextBox(text?: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; /** * Performs a search with the specified SearchOptions on the scope of the paragraph object. The search results are a collection of range objects. * @@ -100512,9 +100539,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; } /** @@ -100583,9 +100610,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; } /** @@ -100733,9 +100760,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; } /** @@ -100854,6 +100881,14 @@ declare namespace Word { * [Api set: WordApi 1.3] */ readonly parentTableOrNullObject: Word.Table; + /** + * Gets the collection of shape objects anchored in the range, including both inline and floating shapes. Currently, only TextBox shapes are supported. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly shapes: Word.ShapeCollection; /** * Gets the collection of table objects in the range. * @@ -100928,7 +100963,7 @@ declare namespace Word { */ delete(): void; /** - * Returns a new range that extends from this range in either direction to cover another range. This range isn't changed. Throws an `ItemNotFound` error if the two ranges do not have a union. + * Returns a new range that extends from this range in either direction to cover another range. This range isn't changed. Throws an `ItemNotFound` error if the two ranges don't have a union. * * @remarks * [Api set: WordApi 1.3] @@ -101179,7 +101214,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * 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. + * 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'. @@ -101256,6 +101291,17 @@ declare namespace Word { * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. */ insertText(text: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range; + /** + * Inserts a floating text box with its anchor at the beginning of the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param text Optional. The text to insert into the text box. + * @param insertShapeOptions Optional. The size and location of the text box. The default location and size is (0, 0, 100, 100). + */ + insertTextBox(text?: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; /** * Returns a new range as the intersection of this range with another range. This range isn't changed. Throws an `ItemNotFound` error if the two ranges aren't overlapped or adjacent. * @@ -101399,9 +101445,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; } /** @@ -101456,11 +101502,52 @@ 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; } + /** + * Specifies the options to determine size and location when inserting a shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface InsertShapeOptions { + /** + * Represents the height of the shape being inserted. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + height?: number; + /** + * Represents the left position of the shape being inserted. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + left?: number; + /** + * Represents the top position of the shape being inserted. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + top?: number; + /** + * Represents the width of the shape being inserted. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + width?: number; + } /** * Specifies the options to determine what to copy when inserting a file. * @@ -101618,9 +101705,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; } /** @@ -101807,9 +101894,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; } /** @@ -101864,9 +101951,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; } /** @@ -101937,9 +102024,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; } /** @@ -102022,9 +102109,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; } /** @@ -102099,9 +102186,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; } /** @@ -102289,9 +102376,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; } /** @@ -102362,9 +102449,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; } /** @@ -102898,9 +102985,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; } /** @@ -102999,9 +103086,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; } /** @@ -103056,9 +103143,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; } /** @@ -103351,9 +103438,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; } /** @@ -103408,9 +103495,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; } /** @@ -103653,9 +103740,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; } /** @@ -103710,9 +103797,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; } /** @@ -103783,9 +103870,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; } /** @@ -103890,9 +103977,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; } /** @@ -103961,11 +104048,244 @@ 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; } + /** + * Represents a shape in the header footer or document body. Currently, only TextBox shapes are supported. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class Shape extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the body object of the shape. Only applies to TextBox shapes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly body: Word.Body; + /** + * The height, in points, of the shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + height: number; + /** + * Gets an integer that represents the shape identifier. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly id: number; + /** + * The distance, in points, from the left side of the shape to the horizontal relative position. For a floating shape, it will return 0 and can't be set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + left: number; + /** + * The relative horizontal position of the shape. For a floating shape, it can't be set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + /** + * The relative vertical position of the shape. For a floating shape, it can't be set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + /** + * The distance, in points, from the top edge of the shape to the vertical relative position. For a floating shape, it will return 0 and can't be set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + top: number; + /** + * Gets the shape type. Currently, only TextBox shapes are supported. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly type: Word.ShapeType | "Unsupported" | "TextBox"; + /** + * The width, in points, of the shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + width: 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. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ShapeUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Shape): void; + /** + * Deletes the shape and its content. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + delete(): void; + /** + * Selects the shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param selectMultipleShapes Optional. Whether to select multiple floating shapes. The default value is false. + */ + select(selectMultipleShapes?: boolean): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.ShapeLoadOptions): Word.Shape; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.Shape; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Shape; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.Shape; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + 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. + */ + toJSON(): Word.Interfaces.ShapeData; + } + /** + * Contains a collection of {@link Word.Shape} objects. Currently, only TextBox shapes are supported. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class ShapeCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.Shape[]; + /** + * Gets a shape by its identifier. Throws an `ItemNotFound` error if there isn't a shape with the identifier in this collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param id Required. A shape identifier. + */ + getById(id: number): Word.Shape; + /** + * Gets a shape by its identifier. If there isn't a shape with the identifier in this collection, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param id Required. A shape identifier. + */ + getByIdOrNullObject(id: number): Word.Shape; + /** + * Gets the shapes that have the specified types. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param types Required. An array of shape types. + */ + getByTypes(types: Word.ShapeType[]): Word.ShapeCollection; + /** + * Gets the first shape in this collection. Throws an `ItemNotFound` error if this collection is empty. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + getFirst(): Word.Shape; + /** + * Gets the first shape in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + getFirstOrNullObject(): Word.Shape; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.ShapeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ShapeCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.ShapeCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ShapeCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.ShapeCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + 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. + */ + toJSON(): Word.Interfaces.ShapeCollectionData; + } /** * ChangeTracking mode. * @@ -104120,16 +104440,34 @@ declare namespace Word { */ contentControlAdded = "ContentControlAdded", /** - * Represents that one or more comments were deleted. + * AnnotationAdded represents the event an annotation has been added to the document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiOnline 1.1] */ - commentDeleted = "CommentDeleted", + annotationAdded = "AnnotationAdded", /** - * Represents that a comment was selected. + * AnnotationChanged represents the event an annotation has been updated in the document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] + * [Api set: WordApiOnline 1.1] + */ + annotationChanged = "AnnotationChanged", + /** + * AnnotationDeleted represents the event an annotation has been deleted from the document. + * @remarks + * [Api set: WordApiOnline 1.1] + */ + annotationDeleted = "AnnotationDeleted", + /** + * Represents that one or more comments were deleted. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + commentDeleted = "CommentDeleted", + /** + * Represents that a comment was selected. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ commentSelected = "CommentSelected", @@ -104166,6 +104504,12 @@ declare namespace Word { * [Api set: WordApi 1.5] */ contentControlExited = "ContentControlExited", + /** + * Represents that a word count has been changed. + * @remarks + * [Api set: WordApi Unknown Version, this API may or may not work on a client. This API may not be released to 3rd parties.] + */ + documentWordCountChanged = "DocumentWordCountChanged", /** * Represents that one or more new paragraphs were added. * @remarks @@ -104246,7 +104590,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.5] */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** * Gets the content control IDs. * @@ -104275,7 +104619,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.5] */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** * Gets the content control IDs. * @@ -104304,7 +104648,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.5] */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** * Gets the content control IDs. * @@ -104333,7 +104677,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.5] */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** * Gets the content control IDs. * @@ -104362,7 +104706,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.5] */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** * Gets the content control IDs. * @@ -104391,7 +104735,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.5] */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** * Gets the content control IDs. * @@ -104427,7 +104771,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.6] */ - type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** * Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors. * @@ -104456,7 +104800,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.6] */ - type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** * Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors. * @@ -104485,7 +104829,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.6] */ - type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** * Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors. * @@ -104533,7 +104877,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; } /** * A structure for the ID and reply IDs of this comment. @@ -105052,55 +105396,73 @@ declare namespace Word { evenPages = "EvenPages", } /** + * Represents the types of body objects. + * * @remarks * [Api set: WordApi 1.3] */ enum BodyType { /** + * Unknown body type. * @remarks * [Api set: WordApi 1.3] */ unknown = "Unknown", /** + * Main document body. * @remarks * [Api set: WordApi 1.3] */ mainDoc = "MainDoc", /** + * Section body. * @remarks * [Api set: WordApi 1.3] */ section = "Section", /** + * Header body. * @remarks * [Api set: WordApi 1.3] */ header = "Header", /** + * Footer body. * @remarks * [Api set: WordApi 1.3] */ footer = "Footer", /** + * Table cell body. * @remarks * [Api set: WordApi 1.3] */ tableCell = "TableCell", /** + * Footnote body. * @remarks * [Api set: WordApi 1.5] */ footnote = "Footnote", /** + * Endnote body. * @remarks * [Api set: WordApi 1.5] */ endnote = "Endnote", /** + * Note body e.g., endnote, footnote. * @remarks * [Api set: WordApi 1.5] */ noteItem = "NoteItem", + /** + * Shape body. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shape = "Shape", } /** * This enum sets where the cursor (insertion point) in the document is after a selection. @@ -107901,6 +108263,161 @@ declare namespace Word { */ createNew = "CreateNew", } + /** + * Represents the shape type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ShapeType { + /** + * Unsupported shape type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + unsupported = "Unsupported", + /** + * Text box shape. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textBox = "TextBox", + } + /** + * Represents what the horizontal position 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum RelativeHorizontalPosition { + /** + * Relative to margin. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + margin = "Margin", + /** + * Relative to page. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + page = "Page", + /** + * Relative to column. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + column = "Column", + /** + * Relative to character. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + character = "Character", + /** + * Relative to left margin. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + leftMargin = "LeftMargin", + /** + * Relative to right margin. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rightMargin = "RightMargin", + /** + * Relative to inside margin. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insideMargin = "InsideMargin", + /** + * Relative to outside margin. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + outsideMargin = "OutsideMargin", + } + /** + * Represents what the vertical position 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum RelativeVerticalPosition { + /** + * Relative to margin. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + margin = "Margin", + /** + * Relative to page. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + page = "Page", + /** + * Relative to paragraph. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + paragraph = "Paragraph", + /** + * Relative to line. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + line = "Line", + /** + * Relative to top margin. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + topMargin = "TopMargin", + /** + * Relative to bottom margin. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bottomMargin = "BottomMargin", + /** + * Relative to inside margin. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insideMargin = "InsideMargin", + /** + * Relative to outside margin. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + outsideMargin = "OutsideMargin", + } enum ErrorCodes { accessDenied = "AccessDenied", generalException = "GeneralException", @@ -107913,16 +108430,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({ ... })`. */ @@ -107932,11 +108449,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. @@ -108043,11 +108560,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. @@ -108109,18 +108626,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. @@ -108137,18 +108654,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'. @@ -108278,18 +108795,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. @@ -108302,18 +108819,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({ ... })`. */ @@ -108385,11 +108902,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. @@ -108580,11 +109097,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'. @@ -108674,18 +109191,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({ ... })`. */ @@ -108695,25 +109212,25 @@ declare namespace Word { /** An interface for updating data on the `Paragraph` object, for use in `paragraph.set({ ... })`. */ interface ParagraphUpdateData { /** - * 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.FontUpdateData; /** - * 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.ListItemUpdateData; /** - * 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.ListItemUpdateData; /** * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. @@ -108908,11 +109425,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. @@ -108995,11 +109512,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({ ... })`. */ @@ -109027,46 +109544,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. @@ -109142,11 +109659,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'. @@ -109306,11 +109823,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'. @@ -109355,11 +109872,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. @@ -109429,6 +109946,69 @@ declare namespace Word { interface TrackedChangeCollectionUpdateData { items?: Word.Interfaces.TrackedChangeData[]; } + /** An interface for updating data on the `Shape` object, for use in `shape.set({ ... })`. */ + interface ShapeUpdateData { + /** + * Represents the body object of the shape. Only applies to TextBox shapes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + body?: Word.Interfaces.BodyUpdateData; + /** + * The height, in points, of the shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + height?: number; + /** + * The distance, in points, from the left side of the shape to the horizontal relative position. For a floating shape, it will return 0 and can't be set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + left?: number; + /** + * The relative horizontal position of the shape. For a floating shape, it can't be set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + /** + * The relative vertical position of the shape. For a floating shape, it can't be set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + /** + * The distance, in points, from the top edge of the shape to the vertical relative position. For a floating shape, it will return 0 and can't be set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + top?: number; + /** + * The width, in points, of the shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + width?: number; + } + /** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */ + interface ShapeCollectionUpdateData { + items?: Word.Interfaces.ShapeData[]; + } /** An interface describing the data returned by calling `critiqueAnnotation.toJSON()`. */ interface CritiqueAnnotationData { /** @@ -109463,55 +110043,63 @@ 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 table objects in the body. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the collection of shape objects in the body, including both inline and floating shapes. Currently, only TextBox shapes are supported. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shapes?: Word.Interfaces.ShapeData[]; + /** + * 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. @@ -109540,7 +110128,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] */ - type?: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" | "Footnote" | "Endnote" | "NoteItem"; + type?: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" | "Footnote" | "Endnote" | "NoteItem" | "Shape"; } /** An interface describing the data returned by calling `border.toJSON()`. */ interface BorderData { @@ -109768,76 +110356,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] - */ - contentControls?: Word.Interfaces.ContentControlData[]; + * 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'. @@ -110533,11 +111121,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'. @@ -110617,11 +111205,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. @@ -110634,18 +111222,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. @@ -110662,40 +111250,48 @@ 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}. - * - * @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.ListItemData; + /** + * Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes. Currently, only TextBox shapes are supported. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shapes?: Word.Interfaces.ShapeData[]; /** * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. * @@ -110924,26 +111520,34 @@ declare namespace Word { /** An interface describing the data returned by calling `range.toJSON()`. */ interface RangeData { /** - * Gets the collection of field objects in the range. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the collection of field objects in the range. + * + * @remarks + * [Api set: WordApi 1.4] + */ fields?: Word.Interfaces.FieldData[]; /** - * 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.FontData; /** - * Gets the collection of inline picture objects in the range. - * - * @remarks - * [Api set: WordApi 1.2] - */ + * Gets the collection of inline picture objects in the range. + * + * @remarks + * [Api set: WordApi 1.2] + */ inlinePictures?: Word.Interfaces.InlinePictureData[]; + /** + * Gets the collection of shape objects anchored in the range, including both inline and floating shapes. Currently, only TextBox shapes are supported. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shapes?: Word.Interfaces.ShapeData[]; /** * 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. * @@ -111039,11 +111643,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()`. */ @@ -111078,46 +111682,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. @@ -111236,32 +111840,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'. @@ -111526,11 +112130,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. @@ -111652,8 +112256,87 @@ declare namespace Word { interface TrackedChangeCollectionData { items?: Word.Interfaces.TrackedChangeData[]; } - /** - * Represents an annotation wrapper around critique displayed in the document. + /** An interface describing the data returned by calling `shape.toJSON()`. */ + interface ShapeData { + /** + * Represents the body object of the shape. Only applies to TextBox shapes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + body?: Word.Interfaces.BodyData; + /** + * The height, in points, of the shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + height?: number; + /** + * Gets an integer that represents the shape identifier. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + id?: number; + /** + * The distance, in points, from the left side of the shape to the horizontal relative position. For a floating shape, it will return 0 and can't be set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + left?: number; + /** + * The relative horizontal position of the shape. For a floating shape, it can't be set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + /** + * The relative vertical position of the shape. For a floating shape, it can't be set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + /** + * The distance, in points, from the top edge of the shape to the vertical relative position. For a floating shape, it will return 0 and can't be set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + top?: number; + /** + * Gets the shape type. Currently, only TextBox shapes are supported. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type?: Word.ShapeType | "Unsupported" | "TextBox"; + /** + * The width, in points, of the shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + width?: number; + } + /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */ + interface ShapeCollectionData { + items?: Word.Interfaces.ShapeData[]; + } + /** + * Represents an annotation wrapper around critique displayed in the document. * * @remarks * [Api set: WordApi 1.7] @@ -111664,11 +112347,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. @@ -111690,11 +112373,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. @@ -111723,11 +112406,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. @@ -111756,53 +112439,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. @@ -111958,11 +112641,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. @@ -112019,11 +112702,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. @@ -112139,18 +112822,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. @@ -112200,18 +112883,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. @@ -112250,7 +112933,7 @@ declare namespace Word { id?: boolean; } /** - * Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, and checkbox content controls are supported. + * Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, checkbox, dropdown list, and combo box content controls are supported. * * @remarks * [Api set: WordApi 1.1] @@ -112261,67 +112944,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] - */ - 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 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] + */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. @@ -112423,7 +113106,7 @@ declare namespace Word { type?: boolean; } /** - * Contains a collection of {@link Word.ContentControl} objects. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text and plain text content controls are supported. + * Contains a collection of {@link Word.ContentControl} objects. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, checkbox, dropdown list, and combo box content controls are supported. * * @remarks * [Api set: WordApi 1.1] @@ -112434,67 +113117,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'. @@ -112817,18 +113500,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. @@ -112857,18 +113540,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. @@ -113027,60 +113710,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. @@ -113145,60 +113828,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. @@ -113354,53 +114037,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. @@ -113464,53 +114147,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. @@ -113673,11 +114356,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'. @@ -113762,11 +114445,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'. @@ -113870,18 +114553,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. @@ -113903,18 +114586,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. @@ -113936,88 +114619,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'. @@ -114151,88 +114834,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'. @@ -114476,60 +115159,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. @@ -114579,60 +115262,60 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: 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] - */ + * For EACH ITEM in the collection: 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; /** - * For EACH ITEM in the collection: Gets the parent body of the range. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the parent body of the range. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentBody?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: 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] - */ + * For EACH ITEM in the collection: 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; /** - * For EACH ITEM in the collection: 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] - */ + * For EACH ITEM in the collection: 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; /** - * For EACH ITEM in the collection: Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: 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] - */ + * For EACH ITEM in the collection: 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; /** - * For EACH ITEM in the collection: 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] - */ + * For EACH ITEM in the collection: 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; /** * For EACH ITEM in the collection: 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. @@ -114744,11 +115427,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; } /** @@ -114763,11 +115446,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; } /** @@ -114834,46 +115517,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. @@ -114977,46 +115660,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. @@ -115153,60 +115836,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'. @@ -115401,60 +116084,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'. @@ -115588,18 +116271,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. @@ -115670,18 +116353,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. @@ -115752,25 +116435,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. @@ -115841,25 +116524,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. @@ -116031,6 +116714,176 @@ declare namespace Word { */ type?: boolean; } + /** + * Represents a shape in the header footer or document body. Currently, only TextBox shapes are supported. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface ShapeLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the body object of the shape. Only applies to TextBox shapes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + body?: Word.Interfaces.BodyLoadOptions; + /** + * The height, in points, of the shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + height?: boolean; + /** + * Gets an integer that represents the shape identifier. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + id?: boolean; + /** + * The distance, in points, from the left side of the shape to the horizontal relative position. For a floating shape, it will return 0 and can't be set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + left?: boolean; + /** + * The relative horizontal position of the shape. For a floating shape, it can't be set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + relativeHorizontalPosition?: boolean; + /** + * The relative vertical position of the shape. For a floating shape, it can't be set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + relativeVerticalPosition?: boolean; + /** + * The distance, in points, from the top edge of the shape to the vertical relative position. For a floating shape, it will return 0 and can't be set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + top?: boolean; + /** + * Gets the shape type. Currently, only TextBox shapes are supported. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type?: boolean; + /** + * The width, in points, of the shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + width?: boolean; + } + /** + * Contains a collection of {@link Word.Shape} objects. Currently, only TextBox shapes are supported. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface ShapeCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Represents the body object of the shape. Only applies to TextBox shapes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + body?: Word.Interfaces.BodyLoadOptions; + /** + * For EACH ITEM in the collection: The height, in points, of the shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + height?: boolean; + /** + * For EACH ITEM in the collection: Gets an integer that represents the shape identifier. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + id?: boolean; + /** + * For EACH ITEM in the collection: The distance, in points, from the left side of the shape to the horizontal relative position. For a floating shape, it will return 0 and can't be set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + left?: boolean; + /** + * For EACH ITEM in the collection: The relative horizontal position of the shape. For a floating shape, it can't be set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + relativeHorizontalPosition?: boolean; + /** + * For EACH ITEM in the collection: The relative vertical position of the shape. For a floating shape, it can't be set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + relativeVerticalPosition?: boolean; + /** + * For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the vertical relative position. For a floating shape, it will return 0 and can't be set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + top?: boolean; + /** + * For EACH ITEM in the collection: Gets the shape type. Currently, only TextBox shapes are supported. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type?: boolean; + /** + * For EACH ITEM in the collection: The width, in points, of the shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + width?: boolean; + } } } declare namespace Word {