Merge pull request #2175 from OfficeDev/main

[admin] Publish
OfficeDev · Jan 10, 2025 · 199ed80 · 199ed80
2 parents 35d251c + 1755f95
commit 199ed80
Show file tree

Hide file tree

Showing 43 changed files with 6,329 additions and 2,898 deletions.
diff --git 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
@@ -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
@@ -460,6 +460,20 @@ properties:
       content: 'readonly parentSectionOrNullObject: Word.Section;'
       return:
         type: '<xref uid="word!Word.Section:class" />'
+  - 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: '<xref uid="word!Word.ShapeCollection:class" />'
   - 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: >-
           <xref uid="word!Word.BodyType:enum" /> | "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
@@ -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
@@ -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: >-
           <xref uid="word!Word.EventType:enum" /> | "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
@@ -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
@@ -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: >-
           <xref uid="word!Word.EventType:enum" /> | "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
@@ -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
@@ -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: >-
           <xref uid="word!Word.EventType:enum" /> | "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
@@ -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: >-
           <xref uid="word!Word.EventType:enum" /> | "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