Skip to content

Commit 1755f95

Browse files
AlexJerabekAlexJerabek
authored
Update Word reference with the latest (#2174)
1 parent d5ab219 commit 1755f95

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+6329
-2898
lines changed

‎docs/docs-ref-autogen/word/toc.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,12 +93,18 @@ items:
9393
uid: 'word!Word.OutlineLevel:enum'
9494
- name: RangeLocation
9595
uid: 'word!Word.RangeLocation:enum'
96+
- name: RelativeHorizontalPosition
97+
uid: 'word!Word.RelativeHorizontalPosition:enum'
98+
- name: RelativeVerticalPosition
99+
uid: 'word!Word.RelativeVerticalPosition:enum'
96100
- name: SaveBehavior
97101
uid: 'word!Word.SaveBehavior:enum'
98102
- name: SelectionMode
99103
uid: 'word!Word.SelectionMode:enum'
100104
- name: ShadingTextureType
101105
uid: 'word!Word.ShadingTextureType:enum'
106+
- name: ShapeType
107+
uid: 'word!Word.ShapeType:enum'
102108
- name: StyleType
103109
uid: 'word!Word.StyleType:enum'
104110
- name: TrackedChangeType
@@ -213,6 +219,8 @@ items:
213219
uid: 'word!Word.InlinePictureCollection:class'
214220
- name: InsertFileOptions
215221
uid: 'word!Word.InsertFileOptions:interface'
222+
- name: InsertShapeOptions
223+
uid: 'word!Word.InsertShapeOptions:interface'
216224
- name: List
217225
uid: 'word!Word.List:class'
218226
- name: ListCollection
@@ -259,6 +267,10 @@ items:
259267
uid: 'word!Word.SettingCollection:class'
260268
- name: Shading
261269
uid: 'word!Word.Shading:class'
270+
- name: Shape
271+
uid: 'word!Word.Shape:class'
272+
- name: ShapeCollection
273+
uid: 'word!Word.ShapeCollection:class'
262274
- name: Style
263275
uid: 'word!Word.Style:class'
264276
- name: StyleCollection

‎docs/docs-ref-autogen/word/word.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,12 @@ enums:
4141
- 'word!Word.NoteItemType:enum'
4242
- 'word!Word.OutlineLevel:enum'
4343
- 'word!Word.RangeLocation:enum'
44+
- 'word!Word.RelativeHorizontalPosition:enum'
45+
- 'word!Word.RelativeVerticalPosition:enum'
4446
- 'word!Word.SaveBehavior:enum'
4547
- 'word!Word.SelectionMode:enum'
4648
- 'word!Word.ShadingTextureType:enum'
49+
- 'word!Word.ShapeType:enum'
4750
- 'word!Word.StyleType:enum'
4851
- 'word!Word.TrackedChangeType:enum'
4952
- 'word!Word.TrailingCharacter:enum'
@@ -102,6 +105,8 @@ classes:
102105
- 'word!Word.Setting:class'
103106
- 'word!Word.SettingCollection:class'
104107
- 'word!Word.Shading:class'
108+
- 'word!Word.Shape:class'
109+
- 'word!Word.ShapeCollection:class'
105110
- 'word!Word.Style:class'
106111
- 'word!Word.StyleCollection:class'
107112
- 'word!Word.Table:class'
@@ -135,6 +140,7 @@ interfaces:
135140
- 'word!Word.DocumentCompareOptions:interface'
136141
- 'word!Word.GetTextOptions:interface'
137142
- 'word!Word.InsertFileOptions:interface'
143+
- 'word!Word.InsertShapeOptions:interface'
138144
- 'word!Word.Interfaces.AnnotationCollectionData:interface'
139145
- 'word!Word.Interfaces.AnnotationCollectionLoadOptions:interface'
140146
- 'word!Word.Interfaces.AnnotationCollectionUpdateData:interface'
@@ -278,6 +284,12 @@ interfaces:
278284
- 'word!Word.Interfaces.ShadingData:interface'
279285
- 'word!Word.Interfaces.ShadingLoadOptions:interface'
280286
- 'word!Word.Interfaces.ShadingUpdateData:interface'
287+
- 'word!Word.Interfaces.ShapeCollectionData:interface'
288+
- 'word!Word.Interfaces.ShapeCollectionLoadOptions:interface'
289+
- 'word!Word.Interfaces.ShapeCollectionUpdateData:interface'
290+
- 'word!Word.Interfaces.ShapeData:interface'
291+
- 'word!Word.Interfaces.ShapeLoadOptions:interface'
292+
- 'word!Word.Interfaces.ShapeUpdateData:interface'
281293
- 'word!Word.Interfaces.StyleCollectionData:interface'
282294
- 'word!Word.Interfaces.StyleCollectionLoadOptions:interface'
283295
- 'word!Word.Interfaces.StyleCollectionUpdateData:interface'

‎docs/docs-ref-autogen/word/word/word.body.yml

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -460,6 +460,20 @@ properties:
460460
content: 'readonly parentSectionOrNullObject: Word.Section;'
461461
return:
462462
type: '<xref uid="word!Word.Section:class" />'
463+
- name: shapes
464+
uid: 'word!Word.Body#shapes:member'
465+
package: word!
466+
fullName: shapes
467+
summary: >-
468+
Gets the collection of shape objects in the body, including both inline and floating shapes. Currently, only
469+
TextBox shapes are supported.
470+
remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
471+
isPreview: true
472+
isDeprecated: false
473+
syntax:
474+
content: 'readonly shapes: Word.ShapeCollection;'
475+
return:
476+
type: '<xref uid="word!Word.ShapeCollection:class" />'
463477
- name: style
464478
uid: 'word!Word.Body#style:member'
465479
package: word!
@@ -672,11 +686,11 @@ properties:
672686
syntax:
673687
content: >-
674688
readonly type: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" |
675-
"Footnote" | "Endnote" | "NoteItem";
689+
"Footnote" | "Endnote" | "NoteItem" | "Shape";
676690
return:
677691
type: >-
678692
<xref uid="word!Word.BodyType:enum" /> | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell"
679-
| "Footnote" | "Endnote" | "NoteItem"
693+
| "Footnote" | "Endnote" | "NoteItem" | "Shape"
680694
methods:
681695
- name: clear()
682696
uid: 'word!Word.Body#clear:member(1)'
@@ -1098,8 +1112,8 @@ methods:
10981112
\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
10991113
11001114
1101-
Note: Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form
1102-
field). Consider replacing such a form field with a content control or other option appropriate for your scenario.
1115+
Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field).
1116+
Consider replacing such a form field with a content control or other option appropriate for your scenario.
11031117
11041118
11051119
#### Examples

‎docs/docs-ref-autogen/word/word/word.bodytype.yml

Lines changed: 45 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Word.BodyType
33
uid: 'word!Word.BodyType:enum'
44
package: word!
55
fullName: Word.BodyType
6-
summary: ''
6+
summary: Represents the types of body objects.
77
remarks: >-
88
\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
99
@@ -42,45 +42,80 @@ fields:
4242
- name: endnote
4343
uid: 'word!Word.BodyType.endnote:member'
4444
package: word!
45-
summary: '* \[ [API set: WordApi 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
45+
summary: |-
46+
Endnote body.
47+
48+
* \[ [API set: WordApi 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
4649
value: '"Endnote"'
4750
- name: footer
4851
uid: 'word!Word.BodyType.footer:member'
4952
package: word!
50-
summary: '* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
53+
summary: |-
54+
Footer body.
55+
56+
* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
5157
value: '"Footer"'
5258
- name: footnote
5359
uid: 'word!Word.BodyType.footnote:member'
5460
package: word!
55-
summary: '* \[ [API set: WordApi 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
61+
summary: |-
62+
Footnote body.
63+
64+
* \[ [API set: WordApi 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
5665
value: '"Footnote"'
5766
- name: header
5867
uid: 'word!Word.BodyType.header:member'
5968
package: word!
60-
summary: '* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
69+
summary: |-
70+
Header body.
71+
72+
* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
6173
value: '"Header"'
6274
- name: mainDoc
6375
uid: 'word!Word.BodyType.mainDoc:member'
6476
package: word!
65-
summary: '* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
77+
summary: |-
78+
Main document body.
79+
80+
* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
6681
value: '"MainDoc"'
6782
- name: noteItem
6883
uid: 'word!Word.BodyType.noteItem:member'
6984
package: word!
70-
summary: '* \[ [API set: WordApi 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
85+
summary: |-
86+
Note body e.g., endnote, footnote.
87+
88+
* \[ [API set: WordApi 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
7189
value: '"NoteItem"'
7290
- name: section
7391
uid: 'word!Word.BodyType.section:member'
7492
package: word!
75-
summary: '* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
93+
summary: |-
94+
Section body.
95+
96+
* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
7697
value: '"Section"'
98+
- name: shape
99+
uid: 'word!Word.BodyType.shape:member'
100+
package: word!
101+
summary: |-
102+
Shape body.
103+
104+
* \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
105+
value: '"Shape"'
77106
- name: tableCell
78107
uid: 'word!Word.BodyType.tableCell:member'
79108
package: word!
80-
summary: '* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
109+
summary: |-
110+
Table cell body.
111+
112+
* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
81113
value: '"TableCell"'
82114
- name: unknown
83115
uid: 'word!Word.BodyType.unknown:member'
84116
package: word!
85-
summary: '* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
117+
summary: |-
118+
Unknown body type.
119+
120+
* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
86121
value: '"Unknown"'

‎docs/docs-ref-autogen/word/word/word.commenteventargs.yml

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -102,14 +102,16 @@ properties:
102102
syntax:
103103
content: >-
104104
type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged"
105-
| "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" |
106-
"CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" |
107-
"ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" |
105+
| "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" |
106+
"CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" |
107+
"ContentControlExited" | "DocumentWordCountChanged" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted"
108+
| "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" |
108109
"AnnotationPopupAction";
109110
return:
110111
type: >-
111112
<xref uid="word!Word.EventType:enum" /> | "ContentControlDeleted" | "ContentControlSelectionChanged" |
112-
"ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" |
113-
"CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" |
113+
"ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" |
114+
"AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" |
115+
"CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" |
114116
"ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" |
115117
"AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"

‎docs/docs-ref-autogen/word/word/word.contentcontrol.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ fullName: Word.ContentControl
66
summary: >-
77
Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as
88
containers for specific types of content. Individual content controls may contain contents such as images, tables, or
9-
paragraphs of formatted text. Currently, only rich text, plain text, and checkbox content controls are supported.
9+
paragraphs of formatted text. Currently, only rich text, plain text, checkbox, dropdown list, and combo box content
10+
controls are supported.
1011
remarks: |-
1112
\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
1213
@@ -1196,8 +1197,8 @@ methods:
11961197
\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
11971198
11981199
1199-
Note: Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form
1200-
field). Consider replacing such a form field with a content control or other option appropriate for your scenario.
1200+
Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field).
1201+
Consider replacing such a form field with a content control or other option appropriate for your scenario.
12011202
isPreview: false
12021203
isDeprecated: false
12031204
syntax:

‎docs/docs-ref-autogen/word/word/word.contentcontroladdedeventargs.yml

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,15 +52,17 @@ properties:
5252
syntax:
5353
content: >-
5454
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" |
55-
"ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected"
56-
| "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" |
57-
"ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" |
58-
"AnnotationRemoved" | "AnnotationPopupAction";
55+
"ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" |
56+
"AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" |
57+
"CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" |
58+
"ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" |
59+
"AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction";
5960
return:
6061
type: >-
6162
<xref uid="word!Word.EventType:enum" /> | "ContentControlDeleted" | "ContentControlSelectionChanged" |
62-
"ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" |
63-
"CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" |
63+
"ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" |
64+
"AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" |
65+
"CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" |
6466
"ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" |
6567
"AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"
6668
- name: ids

‎docs/docs-ref-autogen/word/word/word.contentcontrolcollection.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ summary: >-
77
Contains a collection of [Word.ContentControl](xref:word!Word.ContentControl:class) objects. Content controls are
88
bounded and potentially labeled regions in a document that serve as containers for specific types of content.
99
Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently,
10-
only rich text and plain text content controls are supported.
10+
only rich text, plain text, checkbox, dropdown list, and combo box content controls are supported.
1111
remarks: >-
1212
\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
1313

‎docs/docs-ref-autogen/word/word/word.contentcontroldatachangedeventargs.yml

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -63,15 +63,17 @@ properties:
6363
syntax:
6464
content: >-
6565
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" |
66-
"ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected"
67-
| "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" |
68-
"ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" |
69-
"AnnotationRemoved" | "AnnotationPopupAction";
66+
"ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" |
67+
"AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" |
68+
"CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" |
69+
"ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" |
70+
"AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction";
7071
return:
7172
type: >-
7273
<xref uid="word!Word.EventType:enum" /> | "ContentControlDeleted" | "ContentControlSelectionChanged" |
73-
"ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" |
74-
"CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" |
74+
"ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" |
75+
"AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" |
76+
"CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" |
7577
"ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" |
7678
"AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"
7779
- name: ids

‎docs/docs-ref-autogen/word/word/word.contentcontroldeletedeventargs.yml

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -63,15 +63,17 @@ properties:
6363
syntax:
6464
content: >-
6565
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" |
66-
"ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected"
67-
| "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" |
68-
"ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" |
69-
"AnnotationRemoved" | "AnnotationPopupAction";
66+
"ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" |
67+
"AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" |
68+
"CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" |
69+
"ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" |
70+
"AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction";
7071
return:
7172
type: >-
7273
<xref uid="word!Word.EventType:enum" /> | "ContentControlDeleted" | "ContentControlSelectionChanged" |
73-
"ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" |
74-
"CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" |
74+
"ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" |
75+
"AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" |
76+
"CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "DocumentWordCountChanged" |
7577
"ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" |
7678
"AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"
7779
- name: ids

0 commit comments

Comments
 (0)