Automatically generated docs (#2202)

* Automatically generated docs * Update affect Word requirement set pages --------- Co-authored-by: github-actions <[email protected]>
OfficeDev · Feb 11, 2025 · 27e7af4 · 27e7af4
1 parent 43365f6
commit 27e7af4
Show file tree

Hide file tree

Showing 176 changed files with 11,774 additions and 3,695 deletions.
diff --git a/docs/docs-ref-autogen/word/toc.yml b/docs/docs-ref-autogen/word/toc.yml
@@ -105,6 +105,14 @@ items:
                 uid: 'word!Word.SelectionMode:enum'
               - name: ShadingTextureType
                 uid: 'word!Word.ShadingTextureType:enum'
+              - name: ShapeAutoSize
+                uid: 'word!Word.ShapeAutoSize:enum'
+              - name: ShapeFillType
+                uid: 'word!Word.ShapeFillType:enum'
+              - name: ShapeTextOrientation
+                uid: 'word!Word.ShapeTextOrientation:enum'
+              - name: ShapeTextVerticalAlignment
+                uid: 'word!Word.ShapeTextVerticalAlignment:enum'
               - name: ShapeType
                 uid: 'word!Word.ShapeType:enum'
               - name: StyleType
@@ -141,6 +149,8 @@ items:
             uid: 'word!Word.Border:class'
           - name: BorderCollection
             uid: 'word!Word.BorderCollection:class'
+          - name: Canvas
+            uid: 'word!Word.Canvas:class'
           - name: CheckboxContentControl
             uid: 'word!Word.CheckboxContentControl:class'
           - name: ComboBoxContentControl
@@ -239,6 +249,14 @@ items:
             uid: 'word!Word.NoteItem:class'
           - name: NoteItemCollection
             uid: 'word!Word.NoteItemCollection:class'
+          - name: Page
+            uid: 'word!Word.Page:class'
+          - name: PageCollection
+            uid: 'word!Word.PageCollection:class'
+          - name: Pane
+            uid: 'word!Word.Pane:class'
+          - name: PaneCollection
+            uid: 'word!Word.PaneCollection:class'
           - name: Paragraph
             uid: 'word!Word.Paragraph:class'
           - name: ParagraphAddedEventArgs
@@ -273,6 +291,8 @@ items:
             uid: 'word!Word.Shape:class'
           - name: ShapeCollection
             uid: 'word!Word.ShapeCollection:class'
+          - name: ShapeFill
+            uid: 'word!Word.ShapeFill:class'
           - name: ShapeGroup
             uid: 'word!Word.ShapeGroup:class'
           - name: Style
@@ -295,10 +315,16 @@ items:
             uid: 'word!Word.TableRowCollection:class'
           - name: TableStyle
             uid: 'word!Word.TableStyle:class'
+          - name: TextFrame
+            uid: 'word!Word.TextFrame:class'
           - name: TrackedChange
             uid: 'word!Word.TrackedChange:class'
           - name: TrackedChangeCollection
             uid: 'word!Word.TrackedChangeCollection:class'
+          - name: Window
+            uid: 'word!Word.Window:class'
+          - name: WindowCollection
+            uid: 'word!Word.WindowCollection:class'
       - name: Common APIs
         uid: office!
         items:

diff --git a/docs/docs-ref-autogen/word/word.yml b/docs/docs-ref-autogen/word/word.yml
@@ -47,6 +47,10 @@ enums:
   - 'word!Word.SaveBehavior:enum'
   - 'word!Word.SelectionMode:enum'
   - 'word!Word.ShadingTextureType:enum'
+  - 'word!Word.ShapeAutoSize:enum'
+  - 'word!Word.ShapeFillType:enum'
+  - 'word!Word.ShapeTextOrientation:enum'
+  - 'word!Word.ShapeTextVerticalAlignment:enum'
   - 'word!Word.ShapeType:enum'
   - 'word!Word.StyleType:enum'
   - 'word!Word.TrackedChangeType:enum'
@@ -60,6 +64,7 @@ classes:
   - 'word!Word.Body:class'
   - 'word!Word.Border:class'
   - 'word!Word.BorderCollection:class'
+  - 'word!Word.Canvas:class'
   - 'word!Word.CheckboxContentControl:class'
   - 'word!Word.ComboBoxContentControl:class'
   - 'word!Word.Comment:class'
@@ -94,6 +99,10 @@ classes:
   - 'word!Word.ListTemplate:class'
   - 'word!Word.NoteItem:class'
   - 'word!Word.NoteItemCollection:class'
+  - 'word!Word.Page:class'
+  - 'word!Word.PageCollection:class'
+  - 'word!Word.Pane:class'
+  - 'word!Word.PaneCollection:class'
   - 'word!Word.Paragraph:class'
   - 'word!Word.ParagraphCollection:class'
   - 'word!Word.ParagraphFormat:class'
@@ -108,6 +117,7 @@ classes:
   - 'word!Word.Shading:class'
   - 'word!Word.Shape:class'
   - 'word!Word.ShapeCollection:class'
+  - 'word!Word.ShapeFill:class'
   - 'word!Word.ShapeGroup:class'
   - 'word!Word.Style:class'
   - 'word!Word.StyleCollection:class'
@@ -119,8 +129,11 @@ classes:
   - 'word!Word.TableRow:class'
   - 'word!Word.TableRowCollection:class'
   - 'word!Word.TableStyle:class'
+  - 'word!Word.TextFrame:class'
   - 'word!Word.TrackedChange:class'
   - 'word!Word.TrackedChangeCollection:class'
+  - 'word!Word.Window:class'
+  - 'word!Word.WindowCollection:class'
 interfaces:
   - 'word!Word.AnnotationClickedEventArgs:interface'
   - 'word!Word.AnnotationHoveredEventArgs:interface'
@@ -157,6 +170,9 @@ interfaces:
   - 'word!Word.Interfaces.BorderData:interface'
   - 'word!Word.Interfaces.BorderLoadOptions:interface'
   - 'word!Word.Interfaces.BorderUpdateData:interface'
+  - 'word!Word.Interfaces.CanvasData:interface'
+  - 'word!Word.Interfaces.CanvasLoadOptions:interface'
+  - 'word!Word.Interfaces.CanvasUpdateData:interface'
   - 'word!Word.Interfaces.CheckboxContentControlData:interface'
   - 'word!Word.Interfaces.CheckboxContentControlLoadOptions:interface'
   - 'word!Word.Interfaces.CheckboxContentControlUpdateData:interface'
@@ -253,6 +269,14 @@ interfaces:
   - 'word!Word.Interfaces.NoteItemData:interface'
   - 'word!Word.Interfaces.NoteItemLoadOptions:interface'
   - 'word!Word.Interfaces.NoteItemUpdateData:interface'
+  - 'word!Word.Interfaces.PageCollectionData:interface'
+  - 'word!Word.Interfaces.PageCollectionLoadOptions:interface'
+  - 'word!Word.Interfaces.PageCollectionUpdateData:interface'
+  - 'word!Word.Interfaces.PageData:interface'
+  - 'word!Word.Interfaces.PageLoadOptions:interface'
+  - 'word!Word.Interfaces.PaneCollectionData:interface'
+  - 'word!Word.Interfaces.PaneCollectionUpdateData:interface'
+  - 'word!Word.Interfaces.PaneData:interface'
   - 'word!Word.Interfaces.ParagraphCollectionData:interface'
   - 'word!Word.Interfaces.ParagraphCollectionLoadOptions:interface'
   - 'word!Word.Interfaces.ParagraphCollectionUpdateData:interface'
@@ -290,6 +314,9 @@ interfaces:
   - 'word!Word.Interfaces.ShapeCollectionLoadOptions:interface'
   - 'word!Word.Interfaces.ShapeCollectionUpdateData:interface'
   - 'word!Word.Interfaces.ShapeData:interface'
+  - 'word!Word.Interfaces.ShapeFillData:interface'
+  - 'word!Word.Interfaces.ShapeFillLoadOptions:interface'
+  - 'word!Word.Interfaces.ShapeFillUpdateData:interface'
   - 'word!Word.Interfaces.ShapeGroupData:interface'
   - 'word!Word.Interfaces.ShapeGroupLoadOptions:interface'
   - 'word!Word.Interfaces.ShapeGroupUpdateData:interface'
@@ -325,11 +352,17 @@ interfaces:
   - 'word!Word.Interfaces.TableStyleLoadOptions:interface'
   - 'word!Word.Interfaces.TableStyleUpdateData:interface'
   - 'word!Word.Interfaces.TableUpdateData:interface'
+  - 'word!Word.Interfaces.TextFrameData:interface'
+  - 'word!Word.Interfaces.TextFrameLoadOptions:interface'
+  - 'word!Word.Interfaces.TextFrameUpdateData:interface'
   - 'word!Word.Interfaces.TrackedChangeCollectionData:interface'
   - 'word!Word.Interfaces.TrackedChangeCollectionLoadOptions:interface'
   - 'word!Word.Interfaces.TrackedChangeCollectionUpdateData:interface'
   - 'word!Word.Interfaces.TrackedChangeData:interface'
   - 'word!Word.Interfaces.TrackedChangeLoadOptions:interface'
+  - 'word!Word.Interfaces.WindowCollectionData:interface'
+  - 'word!Word.Interfaces.WindowCollectionUpdateData:interface'
+  - 'word!Word.Interfaces.WindowData:interface'
   - 'word!Word.ParagraphAddedEventArgs:interface'
   - 'word!Word.ParagraphChangedEventArgs:interface'
   - 'word!Word.ParagraphDeletedEventArgs:interface'

diff --git a/docs/docs-ref-autogen/word/word/word.body.yml b/docs/docs-ref-autogen/word/word/word.body.yml
@@ -466,7 +466,7 @@ properties:
     fullName: shapes
     summary: >-
       Gets the collection of shape objects in the body, including both inline and floating shapes. Currently, only the
-      following shapes are supported: text boxes, geometric, grouped, and picture.
+      following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.
     remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
     isPreview: true
     isDeprecated: false