Skip to content

Commit fd73cdb

Browse files
ElizabethSamuel-MSFTgithub-actions
andauthored
Automatically generated docs (#2319)
* Automatically generated docs * Update Word preview APIs overview page --------- Co-authored-by: github-actions <[email protected]>
1 parent 5febff0 commit fd73cdb

File tree

86 files changed

+16750
-484
lines changed

Some content is hidden

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

86 files changed

+16750
-484
lines changed

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

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,10 @@ items:
7171
uid: word!Word.Continue:enum
7272
- name: CritiqueColorScheme
7373
uid: word!Word.CritiqueColorScheme:enum
74+
- name: CustomXmlNodeType
75+
uid: word!Word.CustomXmlNodeType:enum
76+
- name: CustomXmlValidationErrorType
77+
uid: word!Word.CustomXmlValidationErrorType:enum
7478
- name: DefaultListBehavior
7579
uid: word!Word.DefaultListBehavior:enum
7680
- name: DocumentPropertyType
@@ -99,6 +103,8 @@ items:
99103
uid: word!Word.GradientStyle:enum
100104
- name: HeaderFooterType
101105
uid: word!Word.HeaderFooterType:enum
106+
- name: HyperlinkType
107+
uid: word!Word.HyperlinkType:enum
102108
- name: ImageFormat
103109
uid: word!Word.ImageFormat:enum
104110
- name: ImportedStylesConflictBehavior
@@ -237,6 +243,10 @@ items:
237243
uid: word!Word.Border:class
238244
- name: BorderCollection
239245
uid: word!Word.BorderCollection:class
246+
- name: Break
247+
uid: word!Word.Break:class
248+
- name: BreakCollection
249+
uid: word!Word.BreakCollection:class
240250
- name: Canvas
241251
uid: word!Word.Canvas:class
242252
- name: CheckboxContentControl
@@ -291,12 +301,42 @@ items:
291301
uid: word!Word.CustomProperty:class
292302
- name: CustomPropertyCollection
293303
uid: word!Word.CustomPropertyCollection:class
304+
- name: CustomXmlAddNodeOptions
305+
uid: word!Word.CustomXmlAddNodeOptions:interface
306+
- name: CustomXmlAddSchemaOptions
307+
uid: word!Word.CustomXmlAddSchemaOptions:interface
308+
- name: CustomXmlAddValidationErrorOptions
309+
uid: word!Word.CustomXmlAddValidationErrorOptions:interface
310+
- name: CustomXmlAppendChildNodeOptions
311+
uid: word!Word.CustomXmlAppendChildNodeOptions:interface
312+
- name: CustomXmlInsertNodeBeforeOptions
313+
uid: word!Word.CustomXmlInsertNodeBeforeOptions:interface
314+
- name: CustomXmlInsertSubtreeBeforeOptions
315+
uid: word!Word.CustomXmlInsertSubtreeBeforeOptions:interface
316+
- name: CustomXmlNode
317+
uid: word!Word.CustomXmlNode:class
318+
- name: CustomXmlNodeCollection
319+
uid: word!Word.CustomXmlNodeCollection:class
294320
- name: CustomXmlPart
295321
uid: word!Word.CustomXmlPart:class
296322
- name: CustomXmlPartCollection
297323
uid: word!Word.CustomXmlPartCollection:class
298324
- name: CustomXmlPartScopedCollection
299325
uid: word!Word.CustomXmlPartScopedCollection:class
326+
- name: CustomXmlPrefixMapping
327+
uid: word!Word.CustomXmlPrefixMapping:class
328+
- name: CustomXmlPrefixMappingCollection
329+
uid: word!Word.CustomXmlPrefixMappingCollection:class
330+
- name: CustomXmlReplaceChildNodeOptions
331+
uid: word!Word.CustomXmlReplaceChildNodeOptions:interface
332+
- name: CustomXmlSchema
333+
uid: word!Word.CustomXmlSchema:class
334+
- name: CustomXmlSchemaCollection
335+
uid: word!Word.CustomXmlSchemaCollection:class
336+
- name: CustomXmlValidationError
337+
uid: word!Word.CustomXmlValidationError:class
338+
- name: CustomXmlValidationErrorCollection
339+
uid: word!Word.CustomXmlValidationErrorCollection:class
300340
- name: Document
301341
uid: word!Word.Document:class
302342
- name: DocumentCompareOptions
@@ -319,6 +359,12 @@ items:
319359
uid: word!Word.GetTextOptions:interface
320360
- name: GlowFormat
321361
uid: word!Word.GlowFormat:class
362+
- name: Hyperlink
363+
uid: word!Word.Hyperlink:class
364+
- name: HyperlinkAddOptions
365+
uid: word!Word.HyperlinkAddOptions:interface
366+
- name: HyperlinkCollection
367+
uid: word!Word.HyperlinkCollection:class
322368
- name: InlinePicture
323369
uid: word!Word.InlinePicture:class
324370
- name: InlinePictureCollection
@@ -435,6 +481,10 @@ items:
435481
uid: word!Word.Window:class
436482
- name: WindowCollection
437483
uid: word!Word.WindowCollection:class
484+
- name: XmlMapping
485+
uid: word!Word.XmlMapping:class
486+
- name: XmlSetMappingOptions
487+
uid: word!Word.XmlSetMappingOptions:interface
438488
- name: Common APIs
439489
uid: office!
440490
items:

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

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ enums:
3030
- word!Word.ContentControlType:enum
3131
- word!Word.Continue:enum
3232
- word!Word.CritiqueColorScheme:enum
33+
- word!Word.CustomXmlNodeType:enum
34+
- word!Word.CustomXmlValidationErrorType:enum
3335
- word!Word.DefaultListBehavior:enum
3436
- word!Word.DocumentPropertyType:enum
3537
- word!Word.EmphasisMark:enum
@@ -44,6 +46,7 @@ enums:
4446
- word!Word.GradientColorType:enum
4547
- word!Word.GradientStyle:enum
4648
- word!Word.HeaderFooterType:enum
49+
- word!Word.HyperlinkType:enum
4750
- word!Word.ImageFormat:enum
4851
- word!Word.ImportedStylesConflictBehavior:enum
4952
- word!Word.InsertLocation:enum
@@ -108,6 +111,8 @@ classes:
108111
- word!Word.Body:class
109112
- word!Word.Border:class
110113
- word!Word.BorderCollection:class
114+
- word!Word.Break:class
115+
- word!Word.BreakCollection:class
111116
- word!Word.Canvas:class
112117
- word!Word.CheckboxContentControl:class
113118
- word!Word.ColorFormat:class
@@ -124,9 +129,17 @@ classes:
124129
- word!Word.CritiqueAnnotation:class
125130
- word!Word.CustomProperty:class
126131
- word!Word.CustomPropertyCollection:class
132+
- word!Word.CustomXmlNode:class
133+
- word!Word.CustomXmlNodeCollection:class
127134
- word!Word.CustomXmlPart:class
128135
- word!Word.CustomXmlPartCollection:class
129136
- word!Word.CustomXmlPartScopedCollection:class
137+
- word!Word.CustomXmlPrefixMapping:class
138+
- word!Word.CustomXmlPrefixMappingCollection:class
139+
- word!Word.CustomXmlSchema:class
140+
- word!Word.CustomXmlSchemaCollection:class
141+
- word!Word.CustomXmlValidationError:class
142+
- word!Word.CustomXmlValidationErrorCollection:class
130143
- word!Word.Document:class
131144
- word!Word.DocumentCreated:class
132145
- word!Word.DocumentProperties:class
@@ -136,6 +149,8 @@ classes:
136149
- word!Word.FillFormat:class
137150
- word!Word.Font:class
138151
- word!Word.GlowFormat:class
152+
- word!Word.Hyperlink:class
153+
- word!Word.HyperlinkCollection:class
139154
- word!Word.InlinePicture:class
140155
- word!Word.InlinePictureCollection:class
141156
- word!Word.LineFormat:class
@@ -187,6 +202,7 @@ classes:
187202
- word!Word.TrackedChangeCollection:class
188203
- word!Word.Window:class
189204
- word!Word.WindowCollection:class
205+
- word!Word.XmlMapping:class
190206
interfaces:
191207
- word!Word.AnnotationClickedEventArgs:interface
192208
- word!Word.AnnotationHoveredEventArgs:interface
@@ -205,8 +221,16 @@ interfaces:
205221
- word!Word.ContentControlSelectionChangedEventArgs:interface
206222
- word!Word.Critique:interface
207223
- word!Word.CritiquePopupOptions:interface
224+
- word!Word.CustomXmlAddNodeOptions:interface
225+
- word!Word.CustomXmlAddSchemaOptions:interface
226+
- word!Word.CustomXmlAddValidationErrorOptions:interface
227+
- word!Word.CustomXmlAppendChildNodeOptions:interface
228+
- word!Word.CustomXmlInsertNodeBeforeOptions:interface
229+
- word!Word.CustomXmlInsertSubtreeBeforeOptions:interface
230+
- word!Word.CustomXmlReplaceChildNodeOptions:interface
208231
- word!Word.DocumentCompareOptions:interface
209232
- word!Word.GetTextOptions:interface
233+
- word!Word.HyperlinkAddOptions:interface
210234
- word!Word.InsertFileOptions:interface
211235
- word!Word.InsertShapeOptions:interface
212236
- word!Word.Interfaces.AnnotationCollectionData:interface
@@ -223,6 +247,12 @@ interfaces:
223247
- word!Word.Interfaces.BorderData:interface
224248
- word!Word.Interfaces.BorderLoadOptions:interface
225249
- word!Word.Interfaces.BorderUpdateData:interface
250+
- word!Word.Interfaces.BreakCollectionData:interface
251+
- word!Word.Interfaces.BreakCollectionLoadOptions:interface
252+
- word!Word.Interfaces.BreakCollectionUpdateData:interface
253+
- word!Word.Interfaces.BreakData:interface
254+
- word!Word.Interfaces.BreakLoadOptions:interface
255+
- word!Word.Interfaces.BreakUpdateData:interface
226256
- word!Word.Interfaces.CanvasData:interface
227257
- word!Word.Interfaces.CanvasLoadOptions:interface
228258
- word!Word.Interfaces.CanvasUpdateData:interface
@@ -269,6 +299,12 @@ interfaces:
269299
- word!Word.Interfaces.CustomPropertyData:interface
270300
- word!Word.Interfaces.CustomPropertyLoadOptions:interface
271301
- word!Word.Interfaces.CustomPropertyUpdateData:interface
302+
- word!Word.Interfaces.CustomXmlNodeCollectionData:interface
303+
- word!Word.Interfaces.CustomXmlNodeCollectionLoadOptions:interface
304+
- word!Word.Interfaces.CustomXmlNodeCollectionUpdateData:interface
305+
- word!Word.Interfaces.CustomXmlNodeData:interface
306+
- word!Word.Interfaces.CustomXmlNodeLoadOptions:interface
307+
- word!Word.Interfaces.CustomXmlNodeUpdateData:interface
272308
- word!Word.Interfaces.CustomXmlPartCollectionData:interface
273309
- word!Word.Interfaces.CustomXmlPartCollectionLoadOptions:interface
274310
- word!Word.Interfaces.CustomXmlPartCollectionUpdateData:interface
@@ -277,6 +313,23 @@ interfaces:
277313
- word!Word.Interfaces.CustomXmlPartScopedCollectionData:interface
278314
- word!Word.Interfaces.CustomXmlPartScopedCollectionLoadOptions:interface
279315
- word!Word.Interfaces.CustomXmlPartScopedCollectionUpdateData:interface
316+
- word!Word.Interfaces.CustomXmlPartUpdateData:interface
317+
- word!Word.Interfaces.CustomXmlPrefixMappingCollectionData:interface
318+
- word!Word.Interfaces.CustomXmlPrefixMappingCollectionLoadOptions:interface
319+
- word!Word.Interfaces.CustomXmlPrefixMappingCollectionUpdateData:interface
320+
- word!Word.Interfaces.CustomXmlPrefixMappingData:interface
321+
- word!Word.Interfaces.CustomXmlPrefixMappingLoadOptions:interface
322+
- word!Word.Interfaces.CustomXmlSchemaCollectionData:interface
323+
- word!Word.Interfaces.CustomXmlSchemaCollectionLoadOptions:interface
324+
- word!Word.Interfaces.CustomXmlSchemaCollectionUpdateData:interface
325+
- word!Word.Interfaces.CustomXmlSchemaData:interface
326+
- word!Word.Interfaces.CustomXmlSchemaLoadOptions:interface
327+
- word!Word.Interfaces.CustomXmlValidationErrorCollectionData:interface
328+
- word!Word.Interfaces.CustomXmlValidationErrorCollectionLoadOptions:interface
329+
- word!Word.Interfaces.CustomXmlValidationErrorCollectionUpdateData:interface
330+
- word!Word.Interfaces.CustomXmlValidationErrorData:interface
331+
- word!Word.Interfaces.CustomXmlValidationErrorLoadOptions:interface
332+
- word!Word.Interfaces.CustomXmlValidationErrorUpdateData:interface
280333
- word!Word.Interfaces.DocumentCreatedData:interface
281334
- word!Word.Interfaces.DocumentCreatedLoadOptions:interface
282335
- word!Word.Interfaces.DocumentCreatedUpdateData:interface
@@ -302,6 +355,12 @@ interfaces:
302355
- word!Word.Interfaces.GlowFormatData:interface
303356
- word!Word.Interfaces.GlowFormatLoadOptions:interface
304357
- word!Word.Interfaces.GlowFormatUpdateData:interface
358+
- word!Word.Interfaces.HyperlinkCollectionData:interface
359+
- word!Word.Interfaces.HyperlinkCollectionLoadOptions:interface
360+
- word!Word.Interfaces.HyperlinkCollectionUpdateData:interface
361+
- word!Word.Interfaces.HyperlinkData:interface
362+
- word!Word.Interfaces.HyperlinkLoadOptions:interface
363+
- word!Word.Interfaces.HyperlinkUpdateData:interface
305364
- word!Word.Interfaces.InlinePictureCollectionData:interface
306365
- word!Word.Interfaces.InlinePictureCollectionLoadOptions:interface
307366
- word!Word.Interfaces.InlinePictureCollectionUpdateData:interface
@@ -443,11 +502,15 @@ interfaces:
443502
- word!Word.Interfaces.WindowCollectionData:interface
444503
- word!Word.Interfaces.WindowCollectionUpdateData:interface
445504
- word!Word.Interfaces.WindowData:interface
505+
- word!Word.Interfaces.XmlMappingData:interface
506+
- word!Word.Interfaces.XmlMappingLoadOptions:interface
507+
- word!Word.Interfaces.XmlMappingUpdateData:interface
446508
- word!Word.ListFormatCountNumberedItemsOptions:interface
447509
- word!Word.ListTemplateApplyOptions:interface
448510
- word!Word.ParagraphAddedEventArgs:interface
449511
- word!Word.ParagraphChangedEventArgs:interface
450512
- word!Word.ParagraphDeletedEventArgs:interface
513+
- word!Word.XmlSetMappingOptions:interface
451514
functions:
452515
- name: Word.run(objects, batch)
453516
uid: word!Word.run:function(1)

0 commit comments

Comments
 (0)